Suggest Routing With EDD
Suggest Routing With EDD
POST
/
commerce
/
orders
/
orderrouting
/
api
/
v1
/
routing
/
edd
/
suggestion
Error
A valid request URL is required to generate request examples{
"assignmentSuggestionShipmentGroups": [
{
"data": {},
"id": "<string>",
"locationCode": "<string>"
}
],
"attributes": [
{
"fullyQualifiedName": "<string>",
"values": [
"<string>"
]
}
],
"availableLocations": [
123
],
"customData": {},
"data": {},
"eddAssignments": [
{
"assignments": [
{
"data": {},
"estimatedDeliveryDates": [
{
"carrier": "<string>",
"data": {},
"eddWindows": [
{
"deliveryDropoffEndTime": "2023-11-07T05:31:56Z",
"deliveryDropoffStartTime": "2023-11-07T05:31:56Z"
}
],
"estimatedDeliveryDate": "2023-11-07T05:31:56Z",
"estimatedFulfillmentDate": "2023-11-07T05:31:56Z",
"orderCutoffDate": "2023-11-07T05:31:56Z",
"serviceType": "<string>"
}
],
"futureDate": "2023-11-07T05:31:56Z",
"futureDateString": "<string>",
"locationCode": "<string>",
"orderItemID": 123,
"quantity": 123,
"route": "DIRECTSHIP",
"shipmentGroup": "<string>",
"transferToLocationCode": "<string>",
"upc": "<string>"
}
],
"customItemData": {},
"data": {},
"estimatedDeliveryDates": [
{
"carrier": "<string>",
"data": {},
"eddWindows": [
{
"deliveryDropoffEndTime": "2023-11-07T05:31:56Z",
"deliveryDropoffStartTime": "2023-11-07T05:31:56Z"
}
],
"estimatedDeliveryDate": "2023-11-07T05:31:56Z",
"estimatedFulfillmentDate": "2023-11-07T05:31:56Z",
"orderCutoffDate": "2023-11-07T05:31:56Z",
"serviceType": "<string>"
}
],
"futureAssignments": [
{
"data": {},
"estimatedDeliveryDates": [
{
"carrier": "<string>",
"data": {},
"eddWindows": [
{
"deliveryDropoffEndTime": "2023-11-07T05:31:56Z",
"deliveryDropoffStartTime": "2023-11-07T05:31:56Z"
}
],
"estimatedDeliveryDate": "2023-11-07T05:31:56Z",
"estimatedFulfillmentDate": "2023-11-07T05:31:56Z",
"orderCutoffDate": "2023-11-07T05:31:56Z",
"serviceType": "<string>"
}
],
"futureDate": "2023-11-07T05:31:56Z",
"futureDateString": "<string>",
"locationCode": "<string>",
"orderItemID": 123,
"quantity": 123,
"route": "DIRECTSHIP",
"shipmentGroup": "<string>",
"transferToLocationCode": "<string>",
"upc": "<string>"
}
],
"nestedItemAssignments": [
{
"data": {},
"estimatedDeliveryDates": [
{
"carrier": "<string>",
"data": {},
"eddWindows": [
{
"deliveryDropoffEndTime": "2023-11-07T05:31:56Z",
"deliveryDropoffStartTime": "2023-11-07T05:31:56Z"
}
],
"estimatedDeliveryDate": "2023-11-07T05:31:56Z",
"estimatedFulfillmentDate": "2023-11-07T05:31:56Z",
"orderCutoffDate": "2023-11-07T05:31:56Z",
"serviceType": "<string>"
}
],
"futureDate": "2023-11-07T05:31:56Z",
"futureDateString": "<string>",
"locationCode": "<string>",
"orderItemID": 123,
"quantity": 123,
"route": "DIRECTSHIP",
"shipmentGroup": "<string>",
"transferToLocationCode": "<string>",
"upc": "<string>"
}
],
"orderItemID": 123,
"quantity": 123,
"shipmentGroup": "<string>",
"upc": "<string>"
}
],
"eddCalculationLog": {
"environmentID": 123,
"siteID": 123,
"tenantID": 123,
"cartID": "<string>",
"created": "2023-11-07T05:31:56Z",
"creatorUsername": "<string>",
"eddCalculationLogID": 123,
"events": [
{
"type": "NEW_EDD_CALCULATION_REQUEST",
"causeID": 123,
"errors": [
"<string>"
]
}
],
"fieldsFromNewEddCalculationRequest": {
"type": "NEW_EDD_CALCULATION_REQUEST",
"causeID": 123,
"errors": [
"<string>"
],
"request": {
"eddItems": [
{
"backorderable": true,
"basicItem": true,
"callOffFulfillmentType": "<string>",
"callOffOrderItemAttributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"callOffRequestedQuantity": 123,
"callOffShippingAddress": {
"addressID": 123,
"addressLine1": "<string>",
"city": "<string>",
"countryCode": "<string>",
"customerID": 123,
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"condition": "<string>",
"customItemData": {},
"dimensionUnit": "kg",
"extendedProductInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
]
},
"futureDateLimit": "2023-11-07T05:31:56Z",
"futureDateStart": "2023-11-07T05:31:56Z",
"futureOrderable": true,
"granularInventoryItem": true,
"height": 123,
"isPreassigned": true,
"itemDependency": 123,
"length": 123,
"orderItemID": 123,
"partNumber": "<string>",
"preAssignedLocations": [
{
"futureDate": "2023-11-07T05:31:56Z",
"isTransfer": true,
"locationCode": "<string>",
"quantity": 123,
"transferToLocationCode": "<string>"
}
],
"productChildItems": [
{
"backorderable": true,
"callOffFulfillmentType": "<string>",
"callOffOrderItemAttributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"callOffRequestedQuantity": 123,
"callOffShippingAddress": {
"addressID": 123,
"addressLine1": "<string>",
"city": "<string>",
"countryCode": "<string>",
"customerID": 123,
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"condition": "<string>",
"customItemData": {},
"eddHeight": {
"unit": "kg",
"value": 1
},
"eddLength": {
"unit": "kg",
"value": 1
},
"eddWeight": {
"unit": "kg",
"value": 1
},
"eddWidth": {
"unit": "kg",
"value": 1
},
"extendedProductInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
]
},
"futureDateLimit": "2023-11-07T05:31:56Z",
"futureDateStart": "2023-11-07T05:31:56Z",
"futureOrderable": true,
"granularInventoryItem": true,
"itemDependency": 123,
"orderItemID": 123,
"partNumber": "<string>",
"preAssignedLocations": [
{
"futureDate": "2023-11-07T05:31:56Z",
"isTransfer": true,
"locationCode": "<string>",
"quantity": 123,
"transferToLocationCode": "<string>"
}
],
"productTitle": "<string>",
"quantity": 123,
"serialNumber": "<string>",
"shippingMethod": "<string>",
"sku": "<string>",
"tags": {},
"taxable": true,
"upc": "<string>"
}
],
"productTitle": "<string>",
"productUsage": "standard",
"quantity": 123,
"serialNumber": "<string>",
"shippingMethod": "<string>",
"sku": "<string>",
"tags": {},
"taxable": true,
"upc": "<string>",
"weight": 123,
"weightUnit": "kg",
"width": 123
}
],
"orderType": "DIRECTSHIP",
"total": 123,
"bundlingStrategy": "ITEM_DEPENDENCY",
"callOffChannel": "<string>",
"callOffOrderAttributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"cartID": "<string>",
"customData": {},
"environmentID": 123,
"exclusionListLocationCode": [
{
"locationCode": "<string>",
"orderItemID": 123
}
],
"extendedCustomerInfo": {
"accountType": "<string>",
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"companyOrOrganization": "<string>",
"customerId": "<string>",
"customerSinceDate": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"segments": [
"<string>"
],
"taxExempt": true,
"taxId": "<string>"
},
"extendedOrderInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"orderId": "<string>",
"type": "<string>"
},
"externalResponseID": "<string>",
"forceSTHConsolidationOnSplitShipments": true,
"fraud": 123,
"futureDateLimit": "2023-11-07T05:31:56Z",
"futureDateStart": "2023-11-07T05:31:56Z",
"futureExclusionListLocationCode": [
{
"locationCode": "<string>",
"orderItemID": 123
}
],
"inventoryRequestType": "ALL",
"isExpress": true,
"locationCodeWhiteList": [
"<string>"
],
"numShipmentsNotInRequest": 123,
"orderID": 123,
"pickupLocationCode": "<string>",
"remorsePeriodInMinutes": 123,
"shippingAddress": {
"addressID": 123,
"addressLine1": "<string>",
"city": "<string>",
"countryCode": "<string>",
"customerID": 123,
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"shippingMethod": "<string>",
"sort": "SUGGESTION_SORT",
"sthConsolidationLocationOverride": "<string>",
"strategyID": "<string>",
"tags": {}
}
},
"orderID": 123,
"pathString": "<string>",
"persisted": true,
"suggestionID": 123,
"updated": "2023-11-07T05:31:56Z",
"updaterUsername": "<string>",
"userContext": {
"environmentID": 123,
"loaded": true,
"pathString": "<string>",
"siteID": 123,
"siteService": {},
"tenantID": 123,
"tenantService": {
"tenantAttributesCache": {
"underlyingCache": {}
},
"tenantClient": {}
}
}
},
"eddCalculationLogID": 123,
"externalResponseID": "<string>",
"responseID": 123,
"route": "DIRECTSHIP",
"stateChangeSuggestions": {},
"suggestionLog": {
"environmentID": 123,
"siteID": 123,
"tenantID": 123,
"created": "2023-11-07T05:31:56Z",
"creatorUsername": "<string>",
"events": [
{
"causeID": 123,
"errors": [
"<string>"
],
"inputLocations": [
"<string>"
],
"name": "<string>",
"outputLocations": [
"<string>"
],
"sortStrategy": "MINIMIZE_SHIPMENTS",
"type": "NEW_REQUEST"
}
],
"externalResponseID": "<string>",
"fieldsForNewEddSuggestionRequest": {
"type": "NEW_REQUEST",
"causeID": 123,
"errors": [
"<string>"
],
"name": "<string>",
"request": {
"items": [
{
"backorderable": true,
"callOffFulfillmentType": "<string>",
"callOffOrderItemAttributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"callOffRequestedQuantity": 123,
"callOffShippingAddress": {
"addressID": 123,
"addressLine1": "<string>",
"city": "<string>",
"countryCode": "<string>",
"customerID": 123,
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"condition": "<string>",
"customItemData": {},
"extendedProductInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
]
},
"futureDateLimit": "2023-11-07T05:31:56Z",
"futureDateStart": "2023-11-07T05:31:56Z",
"futureOrderable": true,
"granularInventoryItem": true,
"height": 123,
"itemDependency": 123,
"length": 123,
"orderItemID": 123,
"partNumber": "<string>",
"productTitle": "<string>",
"quantity": 123,
"serialNumber": "<string>",
"shippingMethod": "<string>",
"sku": "<string>",
"tags": {},
"taxable": true,
"upc": "<string>",
"weight": 123,
"width": 123
}
],
"orderType": "DIRECTSHIP",
"total": 123,
"bundlingStrategy": "ITEM_DEPENDENCY",
"callOffChannel": "<string>",
"callOffOrderAttributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"cartID": "<string>",
"customData": {},
"environmentID": 123,
"exclusionListLocationCode": [
{
"locationCode": "<string>",
"orderItemID": 123
}
],
"extendedCustomerInfo": {
"accountType": "<string>",
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"companyOrOrganization": "<string>",
"customerId": "<string>",
"customerSinceDate": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"segments": [
"<string>"
],
"taxExempt": true,
"taxId": "<string>"
},
"extendedOrderInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"orderId": "<string>",
"type": "<string>"
},
"externalResponseID": "<string>",
"forceSTHConsolidationOnSplitShipments": true,
"fraud": 123,
"futureDateLimit": "2023-11-07T05:31:56Z",
"futureDateStart": "2023-11-07T05:31:56Z",
"futureExclusionListLocationCode": [
{
"locationCode": "<string>",
"orderItemID": 123
}
],
"inventoryRequestType": "ALL",
"isExpress": true,
"locationCodeWhiteList": [
"<string>"
],
"numShipmentsNotInRequest": 123,
"orderID": 123,
"pickupLocationCode": "<string>",
"shippingAddress": {
"addressID": 123,
"addressLine1": "<string>",
"city": "<string>",
"countryCode": "<string>",
"customerID": 123,
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"shippingMethod": "<string>",
"sort": "SUGGESTION_SORT",
"sthConsolidationLocationOverride": "<string>",
"strategyID": "<string>",
"tags": {}
}
},
"fieldsForNewReturnsSuggestionRequest": {
"type": "NEW_REQUEST",
"causeID": 123,
"errors": [
"<string>"
],
"name": "<string>",
"request": {
"items": [
{
"condition": "<string>",
"customItemData": {},
"dispositionCondition": "<string>",
"extendedProductInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
]
},
"height": 123,
"itemDependency": 123,
"length": 123,
"orderItemID": 123,
"partNumber": "<string>",
"productTitle": "<string>",
"quantity": 123,
"returnReason": "<string>",
"serialNumber": "<string>",
"sku": "<string>",
"tags": {},
"taxable": true,
"upc": "<string>",
"weight": 123,
"width": 123
}
],
"orderType": "DIRECTSHIP",
"total": 123,
"bundlingStrategy": "ITEM_DEPENDENCY",
"customData": {},
"environmentID": 123,
"exclusionListLocationCode": [
{
"locationCode": "<string>",
"orderItemID": 123
}
],
"extendedCustomerInfo": {
"accountType": "<string>",
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"companyOrOrganization": "<string>",
"customerId": "<string>",
"customerSinceDate": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"segments": [
"<string>"
],
"taxExempt": true,
"taxId": "<string>"
},
"extendedOrderInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"orderId": "<string>",
"type": "<string>"
},
"externalResponseID": "<string>",
"fraud": 123,
"isExpress": true,
"locationCodeWhiteList": [
"<string>"
],
"orderID": 123,
"returnID": 123,
"shippingAddress": {
"addressID": 123,
"addressLine1": "<string>",
"city": "<string>",
"countryCode": "<string>",
"customerID": 123,
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"strategyID": "<string>",
"tags": {}
}
},
"fieldsForNewSuggestionRequest": {
"type": "NEW_REQUEST",
"causeID": 123,
"errors": [
"<string>"
],
"name": "<string>",
"request": {
"items": [
{
"backorderable": true,
"callOffFulfillmentType": "<string>",
"callOffOrderItemAttributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"callOffRequestedQuantity": 123,
"callOffShippingAddress": {
"addressID": 123,
"addressLine1": "<string>",
"city": "<string>",
"countryCode": "<string>",
"customerID": 123,
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"condition": "<string>",
"customItemData": {},
"extendedProductInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
]
},
"futureDateLimit": "2023-11-07T05:31:56Z",
"futureDateStart": "2023-11-07T05:31:56Z",
"futureOrderable": true,
"granularInventoryItem": true,
"height": 123,
"itemDependency": 123,
"length": 123,
"orderItemID": 123,
"partNumber": "<string>",
"productTitle": "<string>",
"quantity": 123,
"serialNumber": "<string>",
"shippingMethod": "<string>",
"sku": "<string>",
"tags": {},
"taxable": true,
"upc": "<string>",
"weight": 123,
"width": 123
}
],
"orderType": "DIRECTSHIP",
"total": 123,
"bundlingStrategy": "ITEM_DEPENDENCY",
"callOffChannel": "<string>",
"callOffOrderAttributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"cartID": "<string>",
"customData": {},
"environmentID": 123,
"exclusionListLocationCode": [
{
"locationCode": "<string>",
"orderItemID": 123
}
],
"extendedCustomerInfo": {
"accountType": "<string>",
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"companyOrOrganization": "<string>",
"customerId": "<string>",
"customerSinceDate": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"segments": [
"<string>"
],
"taxExempt": true,
"taxId": "<string>"
},
"extendedOrderInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"orderId": "<string>",
"type": "<string>"
},
"externalResponseID": "<string>",
"forceSTHConsolidationOnSplitShipments": true,
"fraud": 123,
"futureDateLimit": "2023-11-07T05:31:56Z",
"futureDateStart": "2023-11-07T05:31:56Z",
"futureExclusionListLocationCode": [
{
"locationCode": "<string>",
"orderItemID": 123
}
],
"inventoryRequestType": "ALL",
"isExpress": true,
"locationCodeWhiteList": [
"<string>"
],
"numShipmentsNotInRequest": 123,
"orderID": 123,
"pickupLocationCode": "<string>",
"shippingAddress": {
"addressID": 123,
"addressLine1": "<string>",
"city": "<string>",
"countryCode": "<string>",
"customerID": 123,
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"shippingMethod": "<string>",
"sort": "SUGGESTION_SORT",
"sthConsolidationLocationOverride": "<string>",
"strategyID": "<string>",
"tags": {}
}
},
"orderID": 123,
"orderTypeCategory": "STANDARD",
"pathString": "<string>",
"persisted": true,
"returnID": 123,
"suggestionID": 123,
"updated": "2023-11-07T05:31:56Z",
"updaterUsername": "<string>",
"userContext": {
"environmentID": 123,
"loaded": true,
"pathString": "<string>",
"siteID": 123,
"siteService": {},
"tenantID": 123,
"tenantService": {
"tenantAttributesCache": {
"underlyingCache": {}
},
"tenantClient": {}
}
}
}
}{
"additionalInfo": "<string>",
"errorMessage": "<string>"
}{
"additionalInfo": "<string>",
"errorMessage": "<string>"
}{
"additionalInfo": "<string>",
"errorMessage": "<string>"
}{
"additionalInfo": "<string>",
"errorMessage": "<string>"
}{
"additionalInfo": "<string>",
"errorMessage": "<string>"
}{
"additionalInfo": "<string>",
"errorMessage": "<string>"
}Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
Body
application/json
The order lines to route and estimate delivery dates for, including bundles and products with child items. Required, with at least one item. If no item has a valid orderItemID, IDs are numbered from 1; if only some items have valid, unique, positive IDs, the request is rejected.
Minimum array length:
1Show child attributes
Show child attributes
The order type for the Estimated Delivery Date (EDD) suggestion. Accepts DIRECTSHIP, TRANSFER, DELIVERY, or BOPIS.
Available options:
DIRECTSHIP, TRANSFER, DELIVERY, BOPIS Order total. Required. Routing filters can match on this value.
How order items are grouped into sets that must be fulfilled together. Defaults to ITEM_DEPENDENCY, which groups items linked through itemDependency.
Available options:
ITEM_DEPENDENCY Channel of a Call Off order. Routing filters can match on this value.
Custom attributes of a Call Off order header. Routing filters on Call Off order attributes match them by attribute FQN (case-insensitive).
Show child attributes
Show child attributes
Identifier of the cart being estimated. When set, the suggestion log and the EDD calculation log for this request are not saved.
Free-form key/value data about the order. It is returned unchanged in the EDD response.
Show child attributes
Show child attributes
The routing environment whose strategy is used. Ignored when strategyID is set; when both are omitted, the service picks the route for the order type itself.
Item and location pairs to exclude from current-inventory assignment: the item's inventory at that location is not used. Each location code must match an existing location, or the request fails.
Show child attributes
Show child attributes
Customer details and custom attributes that routing filters can match on.
Show child attributes
Show child attributes
Order details and custom attributes that routing filters can match on.
Show child attributes
Show child attributes
Caller-supplied identifier that is returned on the routing response. Maximum 100 characters.
Maximum string length:
100When true, routing tries to consolidate a split ship-to-home order at one location even if normal consolidation would not apply. The location is sthConsolidationLocationOverride if given, otherwise the best valid location.
Fraud indicator for the order. Not currently used in routing.
Latest date for future inventory when routing uses future availability (Future ATP). Items can set their own futureDateLimit; this value is the fallback.
Earliest date for future inventory when routing uses future availability. Applied only if it is later than the current time; items can set their own futureDateStart.
Item and location pairs to exclude from future-inventory (Future ATP) assignment. If left empty while exclusionListLocationCode is set, the current exclusions are also applied to future inventory unless the tenant has turned this off. Each location code must exist.
Show child attributes
Show child attributes
The inventory query type sent to the inventory service when looking up candidate locations. Defaults to ANY when omitted.
Available options:
ALL, ANY, PARTIAL, ALL_STORES When true, only locations marked as express are considered. Routing filters can also match on this value.
Location codes that routing is limited to. Each code must match an existing location, or the request fails.
Number of shipments on the order that are not part of this request. Defaults to 0. Not currently used in routing.
Identifier of the order being routed. It is recorded with the routing logs.
Code of the pickup location. Required for TRANSFER and BOPIS orders; for BOPIS the location must exist and allow in-store pickup, and for TRANSFER its address is used as the shipping address.
Remorse period, in minutes, used in the delivery date calculation. When omitted, the site's fulfillment setting is used.
Destination address. Used to find nearby inventory and to request transit times; for TRANSFER orders it is replaced by the pickup location's address.
Show child attributes
Show child attributes
Shipping method for the order. Routing filters can match on this value.
Sort strategy for candidate suggestions. Not used by this operation.
Available options:
SUGGESTION_SORT Location code to consolidate at when forceSTHConsolidationOnSplitShipments is true. If the location is not valid for consolidation, it is not used and an event is logged.
Routing strategy to use, in the form environmentID-routeID. Takes precedence over environmentID; a value in the wrong format is rejected.
Key/value tags sent to the inventory service with the inventory request.
Show child attributes
Show child attributes
Response
OK
Not populated by this operation. Omitted from the response.
Show child attributes
Show child attributes
Not populated by this operation. Omitted from the response.
Show child attributes
Show child attributes
Not populated by this operation; returned as an empty list, or omitted when every item was preassigned.
The customData supplied in the request, returned unchanged. Omitted when none was supplied.
Show child attributes
Show child attributes
Not populated by this operation. Omitted from the response.
Show child attributes
Show child attributes
Fulfillment assignments and estimated delivery dates, one entry per order item from the request (child items are grouped under their parent). Empty when no item could be assigned.
Show child attributes
Show child attributes
Detailed log of the delivery date calculation. Returned only when returnEddCalculationLog=true and the request has no cartID.
Show child attributes
Show child attributes
ID of the saved delivery date calculation log for this request, which can be used to retrieve the log later. Omitted when the request includes a cartID, because the log is not saved in that case.
The externalResponseID supplied in the request, returned unchanged.
ID of the routing suggestion log created for this request. May be omitted, for example when every item was preassigned and routing was skipped.
Order type used for routing, taken from the request's orderType. STH_CONSOLIDATED when every item was preassigned as a consolidation.
Available options:
DIRECTSHIP, TRANSFER, STH_CONSOLIDATED, RETURN, DISPOSITION, DELIVERY, BOPIS Suggested state changes for items that could not be assigned, keyed by order item ID. Child item suggestions are keyed under, and carry, their parent item's ID. Empty when there are none.
Show child attributes
Show child attributes
Detailed log of the routing decision. Returned only when returnSuggestionLog=true and the request has no cartID.
Show child attributes
Show child attributes
⌘I
Error
A valid request URL is required to generate request examples{
"assignmentSuggestionShipmentGroups": [
{
"data": {},
"id": "<string>",
"locationCode": "<string>"
}
],
"attributes": [
{
"fullyQualifiedName": "<string>",
"values": [
"<string>"
]
}
],
"availableLocations": [
123
],
"customData": {},
"data": {},
"eddAssignments": [
{
"assignments": [
{
"data": {},
"estimatedDeliveryDates": [
{
"carrier": "<string>",
"data": {},
"eddWindows": [
{
"deliveryDropoffEndTime": "2023-11-07T05:31:56Z",
"deliveryDropoffStartTime": "2023-11-07T05:31:56Z"
}
],
"estimatedDeliveryDate": "2023-11-07T05:31:56Z",
"estimatedFulfillmentDate": "2023-11-07T05:31:56Z",
"orderCutoffDate": "2023-11-07T05:31:56Z",
"serviceType": "<string>"
}
],
"futureDate": "2023-11-07T05:31:56Z",
"futureDateString": "<string>",
"locationCode": "<string>",
"orderItemID": 123,
"quantity": 123,
"route": "DIRECTSHIP",
"shipmentGroup": "<string>",
"transferToLocationCode": "<string>",
"upc": "<string>"
}
],
"customItemData": {},
"data": {},
"estimatedDeliveryDates": [
{
"carrier": "<string>",
"data": {},
"eddWindows": [
{
"deliveryDropoffEndTime": "2023-11-07T05:31:56Z",
"deliveryDropoffStartTime": "2023-11-07T05:31:56Z"
}
],
"estimatedDeliveryDate": "2023-11-07T05:31:56Z",
"estimatedFulfillmentDate": "2023-11-07T05:31:56Z",
"orderCutoffDate": "2023-11-07T05:31:56Z",
"serviceType": "<string>"
}
],
"futureAssignments": [
{
"data": {},
"estimatedDeliveryDates": [
{
"carrier": "<string>",
"data": {},
"eddWindows": [
{
"deliveryDropoffEndTime": "2023-11-07T05:31:56Z",
"deliveryDropoffStartTime": "2023-11-07T05:31:56Z"
}
],
"estimatedDeliveryDate": "2023-11-07T05:31:56Z",
"estimatedFulfillmentDate": "2023-11-07T05:31:56Z",
"orderCutoffDate": "2023-11-07T05:31:56Z",
"serviceType": "<string>"
}
],
"futureDate": "2023-11-07T05:31:56Z",
"futureDateString": "<string>",
"locationCode": "<string>",
"orderItemID": 123,
"quantity": 123,
"route": "DIRECTSHIP",
"shipmentGroup": "<string>",
"transferToLocationCode": "<string>",
"upc": "<string>"
}
],
"nestedItemAssignments": [
{
"data": {},
"estimatedDeliveryDates": [
{
"carrier": "<string>",
"data": {},
"eddWindows": [
{
"deliveryDropoffEndTime": "2023-11-07T05:31:56Z",
"deliveryDropoffStartTime": "2023-11-07T05:31:56Z"
}
],
"estimatedDeliveryDate": "2023-11-07T05:31:56Z",
"estimatedFulfillmentDate": "2023-11-07T05:31:56Z",
"orderCutoffDate": "2023-11-07T05:31:56Z",
"serviceType": "<string>"
}
],
"futureDate": "2023-11-07T05:31:56Z",
"futureDateString": "<string>",
"locationCode": "<string>",
"orderItemID": 123,
"quantity": 123,
"route": "DIRECTSHIP",
"shipmentGroup": "<string>",
"transferToLocationCode": "<string>",
"upc": "<string>"
}
],
"orderItemID": 123,
"quantity": 123,
"shipmentGroup": "<string>",
"upc": "<string>"
}
],
"eddCalculationLog": {
"environmentID": 123,
"siteID": 123,
"tenantID": 123,
"cartID": "<string>",
"created": "2023-11-07T05:31:56Z",
"creatorUsername": "<string>",
"eddCalculationLogID": 123,
"events": [
{
"type": "NEW_EDD_CALCULATION_REQUEST",
"causeID": 123,
"errors": [
"<string>"
]
}
],
"fieldsFromNewEddCalculationRequest": {
"type": "NEW_EDD_CALCULATION_REQUEST",
"causeID": 123,
"errors": [
"<string>"
],
"request": {
"eddItems": [
{
"backorderable": true,
"basicItem": true,
"callOffFulfillmentType": "<string>",
"callOffOrderItemAttributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"callOffRequestedQuantity": 123,
"callOffShippingAddress": {
"addressID": 123,
"addressLine1": "<string>",
"city": "<string>",
"countryCode": "<string>",
"customerID": 123,
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"condition": "<string>",
"customItemData": {},
"dimensionUnit": "kg",
"extendedProductInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
]
},
"futureDateLimit": "2023-11-07T05:31:56Z",
"futureDateStart": "2023-11-07T05:31:56Z",
"futureOrderable": true,
"granularInventoryItem": true,
"height": 123,
"isPreassigned": true,
"itemDependency": 123,
"length": 123,
"orderItemID": 123,
"partNumber": "<string>",
"preAssignedLocations": [
{
"futureDate": "2023-11-07T05:31:56Z",
"isTransfer": true,
"locationCode": "<string>",
"quantity": 123,
"transferToLocationCode": "<string>"
}
],
"productChildItems": [
{
"backorderable": true,
"callOffFulfillmentType": "<string>",
"callOffOrderItemAttributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"callOffRequestedQuantity": 123,
"callOffShippingAddress": {
"addressID": 123,
"addressLine1": "<string>",
"city": "<string>",
"countryCode": "<string>",
"customerID": 123,
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"condition": "<string>",
"customItemData": {},
"eddHeight": {
"unit": "kg",
"value": 1
},
"eddLength": {
"unit": "kg",
"value": 1
},
"eddWeight": {
"unit": "kg",
"value": 1
},
"eddWidth": {
"unit": "kg",
"value": 1
},
"extendedProductInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
]
},
"futureDateLimit": "2023-11-07T05:31:56Z",
"futureDateStart": "2023-11-07T05:31:56Z",
"futureOrderable": true,
"granularInventoryItem": true,
"itemDependency": 123,
"orderItemID": 123,
"partNumber": "<string>",
"preAssignedLocations": [
{
"futureDate": "2023-11-07T05:31:56Z",
"isTransfer": true,
"locationCode": "<string>",
"quantity": 123,
"transferToLocationCode": "<string>"
}
],
"productTitle": "<string>",
"quantity": 123,
"serialNumber": "<string>",
"shippingMethod": "<string>",
"sku": "<string>",
"tags": {},
"taxable": true,
"upc": "<string>"
}
],
"productTitle": "<string>",
"productUsage": "standard",
"quantity": 123,
"serialNumber": "<string>",
"shippingMethod": "<string>",
"sku": "<string>",
"tags": {},
"taxable": true,
"upc": "<string>",
"weight": 123,
"weightUnit": "kg",
"width": 123
}
],
"orderType": "DIRECTSHIP",
"total": 123,
"bundlingStrategy": "ITEM_DEPENDENCY",
"callOffChannel": "<string>",
"callOffOrderAttributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"cartID": "<string>",
"customData": {},
"environmentID": 123,
"exclusionListLocationCode": [
{
"locationCode": "<string>",
"orderItemID": 123
}
],
"extendedCustomerInfo": {
"accountType": "<string>",
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"companyOrOrganization": "<string>",
"customerId": "<string>",
"customerSinceDate": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"segments": [
"<string>"
],
"taxExempt": true,
"taxId": "<string>"
},
"extendedOrderInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"orderId": "<string>",
"type": "<string>"
},
"externalResponseID": "<string>",
"forceSTHConsolidationOnSplitShipments": true,
"fraud": 123,
"futureDateLimit": "2023-11-07T05:31:56Z",
"futureDateStart": "2023-11-07T05:31:56Z",
"futureExclusionListLocationCode": [
{
"locationCode": "<string>",
"orderItemID": 123
}
],
"inventoryRequestType": "ALL",
"isExpress": true,
"locationCodeWhiteList": [
"<string>"
],
"numShipmentsNotInRequest": 123,
"orderID": 123,
"pickupLocationCode": "<string>",
"remorsePeriodInMinutes": 123,
"shippingAddress": {
"addressID": 123,
"addressLine1": "<string>",
"city": "<string>",
"countryCode": "<string>",
"customerID": 123,
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"shippingMethod": "<string>",
"sort": "SUGGESTION_SORT",
"sthConsolidationLocationOverride": "<string>",
"strategyID": "<string>",
"tags": {}
}
},
"orderID": 123,
"pathString": "<string>",
"persisted": true,
"suggestionID": 123,
"updated": "2023-11-07T05:31:56Z",
"updaterUsername": "<string>",
"userContext": {
"environmentID": 123,
"loaded": true,
"pathString": "<string>",
"siteID": 123,
"siteService": {},
"tenantID": 123,
"tenantService": {
"tenantAttributesCache": {
"underlyingCache": {}
},
"tenantClient": {}
}
}
},
"eddCalculationLogID": 123,
"externalResponseID": "<string>",
"responseID": 123,
"route": "DIRECTSHIP",
"stateChangeSuggestions": {},
"suggestionLog": {
"environmentID": 123,
"siteID": 123,
"tenantID": 123,
"created": "2023-11-07T05:31:56Z",
"creatorUsername": "<string>",
"events": [
{
"causeID": 123,
"errors": [
"<string>"
],
"inputLocations": [
"<string>"
],
"name": "<string>",
"outputLocations": [
"<string>"
],
"sortStrategy": "MINIMIZE_SHIPMENTS",
"type": "NEW_REQUEST"
}
],
"externalResponseID": "<string>",
"fieldsForNewEddSuggestionRequest": {
"type": "NEW_REQUEST",
"causeID": 123,
"errors": [
"<string>"
],
"name": "<string>",
"request": {
"items": [
{
"backorderable": true,
"callOffFulfillmentType": "<string>",
"callOffOrderItemAttributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"callOffRequestedQuantity": 123,
"callOffShippingAddress": {
"addressID": 123,
"addressLine1": "<string>",
"city": "<string>",
"countryCode": "<string>",
"customerID": 123,
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"condition": "<string>",
"customItemData": {},
"extendedProductInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
]
},
"futureDateLimit": "2023-11-07T05:31:56Z",
"futureDateStart": "2023-11-07T05:31:56Z",
"futureOrderable": true,
"granularInventoryItem": true,
"height": 123,
"itemDependency": 123,
"length": 123,
"orderItemID": 123,
"partNumber": "<string>",
"productTitle": "<string>",
"quantity": 123,
"serialNumber": "<string>",
"shippingMethod": "<string>",
"sku": "<string>",
"tags": {},
"taxable": true,
"upc": "<string>",
"weight": 123,
"width": 123
}
],
"orderType": "DIRECTSHIP",
"total": 123,
"bundlingStrategy": "ITEM_DEPENDENCY",
"callOffChannel": "<string>",
"callOffOrderAttributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"cartID": "<string>",
"customData": {},
"environmentID": 123,
"exclusionListLocationCode": [
{
"locationCode": "<string>",
"orderItemID": 123
}
],
"extendedCustomerInfo": {
"accountType": "<string>",
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"companyOrOrganization": "<string>",
"customerId": "<string>",
"customerSinceDate": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"segments": [
"<string>"
],
"taxExempt": true,
"taxId": "<string>"
},
"extendedOrderInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"orderId": "<string>",
"type": "<string>"
},
"externalResponseID": "<string>",
"forceSTHConsolidationOnSplitShipments": true,
"fraud": 123,
"futureDateLimit": "2023-11-07T05:31:56Z",
"futureDateStart": "2023-11-07T05:31:56Z",
"futureExclusionListLocationCode": [
{
"locationCode": "<string>",
"orderItemID": 123
}
],
"inventoryRequestType": "ALL",
"isExpress": true,
"locationCodeWhiteList": [
"<string>"
],
"numShipmentsNotInRequest": 123,
"orderID": 123,
"pickupLocationCode": "<string>",
"shippingAddress": {
"addressID": 123,
"addressLine1": "<string>",
"city": "<string>",
"countryCode": "<string>",
"customerID": 123,
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"shippingMethod": "<string>",
"sort": "SUGGESTION_SORT",
"sthConsolidationLocationOverride": "<string>",
"strategyID": "<string>",
"tags": {}
}
},
"fieldsForNewReturnsSuggestionRequest": {
"type": "NEW_REQUEST",
"causeID": 123,
"errors": [
"<string>"
],
"name": "<string>",
"request": {
"items": [
{
"condition": "<string>",
"customItemData": {},
"dispositionCondition": "<string>",
"extendedProductInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
]
},
"height": 123,
"itemDependency": 123,
"length": 123,
"orderItemID": 123,
"partNumber": "<string>",
"productTitle": "<string>",
"quantity": 123,
"returnReason": "<string>",
"serialNumber": "<string>",
"sku": "<string>",
"tags": {},
"taxable": true,
"upc": "<string>",
"weight": 123,
"width": 123
}
],
"orderType": "DIRECTSHIP",
"total": 123,
"bundlingStrategy": "ITEM_DEPENDENCY",
"customData": {},
"environmentID": 123,
"exclusionListLocationCode": [
{
"locationCode": "<string>",
"orderItemID": 123
}
],
"extendedCustomerInfo": {
"accountType": "<string>",
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"companyOrOrganization": "<string>",
"customerId": "<string>",
"customerSinceDate": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"segments": [
"<string>"
],
"taxExempt": true,
"taxId": "<string>"
},
"extendedOrderInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"orderId": "<string>",
"type": "<string>"
},
"externalResponseID": "<string>",
"fraud": 123,
"isExpress": true,
"locationCodeWhiteList": [
"<string>"
],
"orderID": 123,
"returnID": 123,
"shippingAddress": {
"addressID": 123,
"addressLine1": "<string>",
"city": "<string>",
"countryCode": "<string>",
"customerID": 123,
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"strategyID": "<string>",
"tags": {}
}
},
"fieldsForNewSuggestionRequest": {
"type": "NEW_REQUEST",
"causeID": 123,
"errors": [
"<string>"
],
"name": "<string>",
"request": {
"items": [
{
"backorderable": true,
"callOffFulfillmentType": "<string>",
"callOffOrderItemAttributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"callOffRequestedQuantity": 123,
"callOffShippingAddress": {
"addressID": 123,
"addressLine1": "<string>",
"city": "<string>",
"countryCode": "<string>",
"customerID": 123,
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"condition": "<string>",
"customItemData": {},
"extendedProductInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
]
},
"futureDateLimit": "2023-11-07T05:31:56Z",
"futureDateStart": "2023-11-07T05:31:56Z",
"futureOrderable": true,
"granularInventoryItem": true,
"height": 123,
"itemDependency": 123,
"length": 123,
"orderItemID": 123,
"partNumber": "<string>",
"productTitle": "<string>",
"quantity": 123,
"serialNumber": "<string>",
"shippingMethod": "<string>",
"sku": "<string>",
"tags": {},
"taxable": true,
"upc": "<string>",
"weight": 123,
"width": 123
}
],
"orderType": "DIRECTSHIP",
"total": 123,
"bundlingStrategy": "ITEM_DEPENDENCY",
"callOffChannel": "<string>",
"callOffOrderAttributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"cartID": "<string>",
"customData": {},
"environmentID": 123,
"exclusionListLocationCode": [
{
"locationCode": "<string>",
"orderItemID": 123
}
],
"extendedCustomerInfo": {
"accountType": "<string>",
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"companyOrOrganization": "<string>",
"customerId": "<string>",
"customerSinceDate": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"segments": [
"<string>"
],
"taxExempt": true,
"taxId": "<string>"
},
"extendedOrderInfo": {
"attributes": [
{
"attributeFQN": "<string>",
"attributeValues": [
"<string>"
]
}
],
"orderId": "<string>",
"type": "<string>"
},
"externalResponseID": "<string>",
"forceSTHConsolidationOnSplitShipments": true,
"fraud": 123,
"futureDateLimit": "2023-11-07T05:31:56Z",
"futureDateStart": "2023-11-07T05:31:56Z",
"futureExclusionListLocationCode": [
{
"locationCode": "<string>",
"orderItemID": 123
}
],
"inventoryRequestType": "ALL",
"isExpress": true,
"locationCodeWhiteList": [
"<string>"
],
"numShipmentsNotInRequest": 123,
"orderID": 123,
"pickupLocationCode": "<string>",
"shippingAddress": {
"addressID": 123,
"addressLine1": "<string>",
"city": "<string>",
"countryCode": "<string>",
"customerID": 123,
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"shippingMethod": "<string>",
"sort": "SUGGESTION_SORT",
"sthConsolidationLocationOverride": "<string>",
"strategyID": "<string>",
"tags": {}
}
},
"orderID": 123,
"orderTypeCategory": "STANDARD",
"pathString": "<string>",
"persisted": true,
"returnID": 123,
"suggestionID": 123,
"updated": "2023-11-07T05:31:56Z",
"updaterUsername": "<string>",
"userContext": {
"environmentID": 123,
"loaded": true,
"pathString": "<string>",
"siteID": 123,
"siteService": {},
"tenantID": 123,
"tenantService": {
"tenantAttributesCache": {
"underlyingCache": {}
},
"tenantClient": {}
}
}
}
}{
"additionalInfo": "<string>",
"errorMessage": "<string>"
}{
"additionalInfo": "<string>",
"errorMessage": "<string>"
}{
"additionalInfo": "<string>",
"errorMessage": "<string>"
}{
"additionalInfo": "<string>",
"errorMessage": "<string>"
}{
"additionalInfo": "<string>",
"errorMessage": "<string>"
}{
"additionalInfo": "<string>",
"errorMessage": "<string>"
}