Create Automation Ruleset

This endpoint creates a new automation ruleset with an optional set of rules.

SecurityOAuth2

Request

header Parameters

x-api-key	string
tenant-id	string
Content-Type	string Default: application/json

Request Body schema: application/json

required	object (Ruleset Request)
	Array of objects (Automation Rule Request)

Responses

200

post/automation-rulesets

Request samples

application/json

{"automation_rule_set": {"name": "string",
"entity_type": "FORWARD",
"merchants": ["string"
],
"countries": ["string"
],
"status": "ACTIVE"
},
"automation_rules": [{"rule_name": "string",
"carrier_accounts": [{"carrier_account_id": "string"
}
],
"carrier_choice": "CHEAPEST_CARRIER",
"sequence": 0,
"description": "string",
"status": "ACTIVE",
"source_type": {"operator": "INCLUSION",
"value": ["string"
]
},
"payment_type": {"operator": "INCLUSION",
"value": ["string"
]
},
"delivery_type": {"operator": "INCLUSION",
"value": ["string"
]
},
"order_type": {"operator": "INCLUSION",
"value": ["string"
]
},
"merchant": {"operator": "INCLUSION",
"value": ["string"
]
},
"pickup_partner_location_ids": {"operator": "INCLUSION",
"value": ["string"
]
},
"dropoff_partner_location_ids": {"operator": "INCLUSION",
"value": ["string"
]
},
"dropoff_v2": {"operator": "INCLUSION",
"value": [{"country": "string",
"state_cities": [{"state": null,
"city_areas": [ ]
}
]
}
]
},
"pickup_v2": {"operator": "INCLUSION",
"value": [{"country": "string",
"state_cities": [{"state": null,
"city_areas": [ ]
}
]
}
]
},
"volumetric_weight": {"min_value": 0,
"max_value": 0
},
"gross_weight": {"min_value": 0,
"max_value": 0
},
"chargeable_weight": {"min_value": 0,
"max_value": 0
},
"parcel_count": {"min_value": 0,
"max_value": 0
},
"custom_conditions": {"operator": "INCLUSION",
"value": [{"attribute_name": "string",
"operation": "CONTAINS",
"values": ["string"
]
}
]
},
"order_value_min": 0,
"order_value_max": 0,
"dangerous_goods": true,
"start_time": 0,
"end_time": 0,
"days": ["MONDAY"
],
"customer_address_verified": true
}
]
}

Response samples

application/json

{"automation_rule_set": {"tenant": "string",
"rule_set_id": "string",
"name": "string",
"entity_type": "FORWARD",
"merchants": ["string"
],
"countries": ["string"
],
"status": "ACTIVE",
"creation_date": "2019-08-24T14:15:22Z",
"update_date": "2019-08-24T14:15:22Z"
},
"automation_rules": [{"tenant": "string",
"rule_id": "string",
"rule_set_id": "string",
"rule_name": "string",
"carrier_accounts": [{"carrier_account_id": "string"
}
],
"carrier_choice": "CHEAPEST_CARRIER",
"sequence": 0,
"description": "string",
"status": "ACTIVE",
"source_type": {"operator": "INCLUSION",
"value": ["string"
]
},
"payment_type": {"operator": "INCLUSION",
"value": ["string"
]
},
"delivery_type": {"operator": "INCLUSION",
"value": ["string"
]
},
"order_type": {"operator": "INCLUSION",
"value": ["string"
]
},
"merchant": {"operator": "INCLUSION",
"value": ["string"
]
},
"pickup_partner_location_ids": {"operator": "INCLUSION",
"value": ["string"
]
},
"dropoff_partner_location_ids": {"operator": "INCLUSION",
"value": ["string"
]
},
"dropoff_v2": {"operator": "INCLUSION",
"value": [{"country": "string",
"state_cities": [{"state": null,
"city_areas": [ ]
}
]
}
]
},
"pickup_v2": {"operator": "INCLUSION",
"value": [{"country": "string",
"state_cities": [{"state": null,
"city_areas": [ ]
}
]
}
]
},
"volumetric_weight": {"min_value": 0,
"max_value": 0
},
"gross_weight": {"min_value": 0,
"max_value": 0
},
"chargeable_weight": {"min_value": 0,
"max_value": 0
},
"parcel_count": {"min_value": 0,
"max_value": 0
},
"custom_conditions": {"operator": "INCLUSION",
"value": [{"attribute_name": "string",
"operation": "CONTAINS",
"values": ["string"
]
}
]
},
"order_value_min": 0,
"order_value_max": 0,
"dangerous_goods": true,
"start_time": 0,
"end_time": 0,
"days": ["MONDAY"
],
"customer_address_verified": true,
"creation_date": "2019-08-24T14:15:22Z",
"update_date": "2019-08-24T14:15:22Z"
}
]
}