Get Automation Rule

This endpoint returns the automation rule.

SecurityOAuth2
Request
path Parameters
ruleset-id
required
string
automation-rule-id
required
string
header Parameters
x-api-key
string
tenant-id
string
Content-Type
string
Default: application/json
Responses
200
get/automation-rulesets/{ruleset-id}/rules/{automation-rule-id}
Request samples 
Response samples 
application/json
{
  • "tenant": "string",
  • "rule_id": "string",
  • "rule_set_id": "string",
  • "rule_name": "string",
  • "carrier_accounts": [
    ],
  • "carrier_choice": "CHEAPEST_CARRIER",
  • "sequence": 0,
  • "description": "string",
  • "status": "ACTIVE",
  • "source_type": {
    },
  • "payment_type": {
    },
  • "delivery_type": {
    },
  • "order_type": {
    },
  • "merchant": {
    },
  • "pickup_partner_location_ids": {
    },
  • "dropoff_partner_location_ids": {
    },
  • "dropoff_v2": {
    },
  • "pickup_v2": {
    },
  • "volumetric_weight": {
    },
  • "gross_weight": {
    },
  • "chargeable_weight": {
    },
  • "parcel_count": {
    },
  • "custom_conditions": {
    },
  • "order_value_min": 0,
  • "order_value_max": 0,
  • "dangerous_goods": true,
  • "start_time": 0,
  • "end_time": 0,
  • "days": [
    ],
  • "customer_address_verified": true,
  • "creation_date": "2019-08-24T14:15:22Z",
  • "update_date": "2019-08-24T14:15:22Z"
}