Create Service Level Rule

This endpoint adds a new service level rule to the ruleset.

SecurityOAuth2

Request

path Parameters

service-level-ruleset-id

required

string

header Parameters

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

Request Body schema: application/json

rule_name required	string
config_type	string Enum: "FULFILLMENT" "SHIPPING" "DELIVERY" "PROMISED"
	object shipment.source.source_type matches condition
sequence required	number Sequence number used for rules prioritisation (lower is more important)
description	string
status required	string (status-field) Enum: "ACTIVE" "INACTIVE" "DELETED"
	object shipment.source.source_type matches condition
	object shipment.delivery.delivery_type matches condition
	object shipment.order_type matches condition
	object shipment.merchant matches condition
	object shipment.pickup.partner_location_id matches condition
	object shipment.dropoff.partner_location_id matches condition
	object shipment.dropoff country state city area condition
	object shipment.pickup country state city area condition
	object shipment.parcels volumetric weight is inside range
	object shipment.parcels gross weight is inside range
	object shipment.custom_attributes matches condition
start_time	number Time range when rule applies
end_time	number Time range when rule applies
days	Array of strings Days when rule applies Items Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY" "SUNDAY"

Responses

200

post/service-level-rulesets/{service-level-ruleset-id}/rules

Request samples

application/json

{"rule_name": "string",
"config_type": "FULFILLMENT",
"carrier_ids": {"operator": "INCLUSION",
"value": ["string"
]
},
"sequence": 0,
"description": "string",
"status": "ACTIVE",
"source_type": {"operator": "INCLUSION",
"value": ["string"
]
},
"delivery_type": {"operator": "INCLUSION",
"value": ["string"
]
},
"order_type": {"operator": "INCLUSION",
"value": ["string"
]
},
"merchants": {"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": "string",
"city_areas": [{"city": null,
"areas": [ ]
}
]
}
]
}
]
},
"pickup_v2": {"operator": "INCLUSION",
"value": [{"country": "string",
"state_cities": [{"state": "string",
"city_areas": [{"city": null,
"areas": [ ]
}
]
}
]
}
]
},
"volumetric_weight": {"min_value": 0,
"max_value": 0
},
"gross_weight": {"min_value": 0,
"max_value": 0
},
"custom_conditions": {"operator": "INCLUSION",
"value": [{"attribute_name": "string",
"operation": "CONTAINS",
"values": ["string"
]
}
]
},
"start_time": 0,
"end_time": 0,
"days": ["MONDAY"
]
}

Response samples

application/json

{"tenant": "string",
"rule_id": "string",
"rule_set_id": "string",
"rule_name": "string",
"sequence": 0,
"description": "string",
"config_type": "FULFILLMENT",
"status": "ACTIVE",
"source_type": {"operator": "INCLUSION",
"value": ["string"
]
},
"delivery_type": {"operator": "INCLUSION",
"value": ["string"
]
},
"carrier_ids": {"operator": "INCLUSION",
"value": ["string"
]
},
"order_type": {"operator": "INCLUSION",
"value": ["string"
]
},
"merchants": {"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": "string",
"city_areas": [{"city": null,
"areas": [ ]
}
]
}
]
}
]
},
"pickup_v2": {"operator": "INCLUSION",
"value": [{"country": "string",
"state_cities": [{"state": "string",
"city_areas": [{"city": null,
"areas": [ ]
}
]
}
]
}
]
},
"volumetric_weight": {"min_value": 0,
"max_value": 0
},
"gross_weight": {"min_value": 0,
"max_value": 0
},
"custom_conditions": {"operator": "INCLUSION",
"value": [{"attribute_name": "string",
"operation": "CONTAINS",
"values": ["string"
]
}
]
},
"start_time": 0,
"end_time": 0,
"days": ["MONDAY"
],
"creation_date": "2019-08-24T14:15:22Z",
"update_date": "2019-08-24T14:15:22Z"
}