Skip to main content
POST
/
commerce
/
orders
/
orderrouting
/
api
/
v1
/
routing
/
edd
/
suggestion
Error
A valid request URL is required to generate request examples
{
  "eddAssignments": [
    {
      "orderItemID": 123,
      "upc": "<string>",
      "quantity": 123,
      "estimatedDeliveryDates": [
        {
          "estimatedDeliveryDate": "2023-11-07T05:31:56Z",
          "estimatedFulfillmentDate": "2023-11-07T05:31:56Z",
          "orderCutoffDate": "2023-11-07T05:31:56Z",
          "carrier": "<string>",
          "serviceType": "<string>",
          "eddWindows": [
            {
              "deliveryDropoffStartTime": "2023-11-07T05:31:56Z",
              "deliveryDropoffEndTime": "2023-11-07T05:31:56Z"
            }
          ],
          "data": {}
        }
      ],
      "assignments": [
        {
          "orderItemID": 123,
          "locationCode": "<string>",
          "upc": "<string>",
          "quantity": 123,
          "route": "DIRECTSHIP",
          "futureDate": "2023-11-07T05:31:56Z",
          "futureDateString": "<string>",
          "estimatedDeliveryDates": [
            {
              "estimatedDeliveryDate": "2023-11-07T05:31:56Z",
              "estimatedFulfillmentDate": "2023-11-07T05:31:56Z",
              "orderCutoffDate": "2023-11-07T05:31:56Z",
              "carrier": "<string>",
              "serviceType": "<string>",
              "eddWindows": [
                {
                  "deliveryDropoffStartTime": "2023-11-07T05:31:56Z",
                  "deliveryDropoffEndTime": "2023-11-07T05:31:56Z"
                }
              ],
              "data": {}
            }
          ],
          "transferToLocationCode": "<string>",
          "shipmentGroup": "<string>",
          "data": {}
        }
      ],
      "futureAssignments": [
        {
          "orderItemID": 123,
          "locationCode": "<string>",
          "upc": "<string>",
          "quantity": 123,
          "route": "DIRECTSHIP",
          "futureDate": "2023-11-07T05:31:56Z",
          "futureDateString": "<string>",
          "estimatedDeliveryDates": [
            {
              "estimatedDeliveryDate": "2023-11-07T05:31:56Z",
              "estimatedFulfillmentDate": "2023-11-07T05:31:56Z",
              "orderCutoffDate": "2023-11-07T05:31:56Z",
              "carrier": "<string>",
              "serviceType": "<string>",
              "eddWindows": [
                {
                  "deliveryDropoffStartTime": "2023-11-07T05:31:56Z",
                  "deliveryDropoffEndTime": "2023-11-07T05:31:56Z"
                }
              ],
              "data": {}
            }
          ],
          "transferToLocationCode": "<string>",
          "shipmentGroup": "<string>",
          "data": {}
        }
      ],
      "nestedItemAssignments": [
        {
          "orderItemID": 123,
          "locationCode": "<string>",
          "upc": "<string>",
          "quantity": 123,
          "route": "DIRECTSHIP",
          "futureDate": "2023-11-07T05:31:56Z",
          "futureDateString": "<string>",
          "estimatedDeliveryDates": [
            {
              "estimatedDeliveryDate": "2023-11-07T05:31:56Z",
              "estimatedFulfillmentDate": "2023-11-07T05:31:56Z",
              "orderCutoffDate": "2023-11-07T05:31:56Z",
              "carrier": "<string>",
              "serviceType": "<string>",
              "eddWindows": [
                {
                  "deliveryDropoffStartTime": "2023-11-07T05:31:56Z",
                  "deliveryDropoffEndTime": "2023-11-07T05:31:56Z"
                }
              ],
              "data": {}
            }
          ],
          "transferToLocationCode": "<string>",
          "shipmentGroup": "<string>",
          "data": {}
        }
      ],
      "customItemData": {},
      "shipmentGroup": "<string>",
      "data": {}
    }
  ],
  "stateChangeSuggestions": {},
  "availableLocations": [
    123
  ],
  "responseID": 123,
  "externalResponseID": "<string>",
  "suggestionLog": {
    "tenantID": 123,
    "siteID": 123,
    "environmentID": 123,
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "creatorUsername": "<string>",
    "updaterUsername": "<string>",
    "suggestionID": 123,
    "orderID": 123,
    "externalResponseID": "<string>",
    "returnID": 123,
    "orderTypeCategory": "STANDARD",
    "events": [
      {
        "type": "NEW_REQUEST",
        "name": "<string>",
        "causeID": 123,
        "errors": [
          "<string>"
        ]
      }
    ],
    "fieldsForNewReturnsSuggestionRequest": {
      "type": "NEW_REQUEST",
      "name": "<string>",
      "causeID": 123,
      "errors": [
        "<string>"
      ],
      "request": {
        "orderType": "DIRECTSHIP",
        "items": [
          {
            "orderItemID": 123,
            "partNumber": "<string>",
            "sku": "<string>",
            "quantity": 123,
            "customItemData": {},
            "itemDependency": 123,
            "productTitle": "<string>",
            "taxable": true,
            "weight": 123,
            "length": 123,
            "width": 123,
            "height": 123,
            "tags": {},
            "extendedProductInfo": {
              "attributes": [
                {
                  "attributeFQN": "<string>",
                  "attributeValues": [
                    "<string>"
                  ]
                }
              ]
            },
            "condition": "<string>",
            "serialNumber": "<string>",
            "returnReason": "<string>",
            "dispositionCondition": "<string>",
            "upc": "<string>"
          }
        ],
        "total": 123,
        "environmentID": 123,
        "strategyID": "<string>",
        "shippingAddress": {
          "addressID": 123,
          "customerID": 123,
          "addressLine1": "<string>",
          "phone": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postalCode": "<string>",
          "countryCode": "<string>",
          "latitude": 123,
          "longitude": 123
        },
        "isExpress": true,
        "locationCodeWhiteList": [
          "<string>"
        ],
        "exclusionListLocationCode": [
          {
            "orderItemID": 123,
            "locationCode": "<string>"
          }
        ],
        "tags": {},
        "extendedCustomerInfo": {
          "customerId": "<string>",
          "segments": [
            "<string>"
          ],
          "attributes": [
            {
              "attributeFQN": "<string>",
              "attributeValues": [
                "<string>"
              ]
            }
          ],
          "companyOrOrganization": "<string>",
          "taxId": "<string>",
          "externalId": "<string>",
          "accountType": "<string>",
          "taxExempt": true,
          "customerSinceDate": "2023-11-07T05:31:56Z"
        },
        "extendedOrderInfo": {
          "type": "<string>",
          "orderId": "<string>",
          "attributes": [
            {
              "attributeFQN": "<string>",
              "attributeValues": [
                "<string>"
              ]
            }
          ]
        },
        "externalResponseID": "<string>",
        "returnID": 123,
        "orderID": 123,
        "fraud": 123,
        "customData": {},
        "bundlingStrategy": "ITEM_DEPENDENCY"
      }
    },
    "fieldsForNewEddSuggestionRequest": {
      "type": "NEW_REQUEST",
      "name": "<string>",
      "causeID": 123,
      "errors": [
        "<string>"
      ],
      "request": {
        "orderType": "DIRECTSHIP",
        "items": [
          {
            "orderItemID": 123,
            "partNumber": "<string>",
            "sku": "<string>",
            "quantity": 123,
            "customItemData": {},
            "itemDependency": 123,
            "productTitle": "<string>",
            "taxable": true,
            "weight": 123,
            "length": 123,
            "width": 123,
            "height": 123,
            "tags": {},
            "extendedProductInfo": {
              "attributes": [
                {
                  "attributeFQN": "<string>",
                  "attributeValues": [
                    "<string>"
                  ]
                }
              ]
            },
            "condition": "<string>",
            "serialNumber": "<string>",
            "backorderable": true,
            "futureOrderable": true,
            "shippingMethod": "<string>",
            "granularInventoryItem": true,
            "upc": "<string>"
          }
        ],
        "total": 123,
        "environmentID": 123,
        "strategyID": "<string>",
        "shippingAddress": {
          "addressID": 123,
          "customerID": 123,
          "addressLine1": "<string>",
          "phone": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postalCode": "<string>",
          "countryCode": "<string>",
          "latitude": 123,
          "longitude": 123
        },
        "isExpress": true,
        "locationCodeWhiteList": [
          "<string>"
        ],
        "exclusionListLocationCode": [
          {
            "orderItemID": 123,
            "locationCode": "<string>"
          }
        ],
        "tags": {},
        "extendedCustomerInfo": {
          "customerId": "<string>",
          "segments": [
            "<string>"
          ],
          "attributes": [
            {
              "attributeFQN": "<string>",
              "attributeValues": [
                "<string>"
              ]
            }
          ],
          "companyOrOrganization": "<string>",
          "taxId": "<string>",
          "externalId": "<string>",
          "accountType": "<string>",
          "taxExempt": true,
          "customerSinceDate": "2023-11-07T05:31:56Z"
        },
        "extendedOrderInfo": {
          "type": "<string>",
          "orderId": "<string>",
          "attributes": [
            {
              "attributeFQN": "<string>",
              "attributeValues": [
                "<string>"
              ]
            }
          ]
        },
        "pickupLocationCode": "<string>",
        "inventoryRequestType": "ALL",
        "futureExclusionListLocationCode": [
          {
            "orderItemID": 123,
            "locationCode": "<string>"
          }
        ],
        "futureDateLimit": "2023-11-07T05:31:56Z",
        "sort": "SUGGESTION_SORT",
        "externalResponseID": "<string>",
        "orderID": 123,
        "cartID": "<string>",
        "fraud": 123,
        "customData": {},
        "bundlingStrategy": "ITEM_DEPENDENCY",
        "forceSTHConsolidationOnSplitShipments": true,
        "sthConsolidationLocationOverride": "<string>",
        "numShipmentsNotInRequest": 123,
        "shippingMethod": "<string>"
      }
    },
    "fieldsForNewSuggestionRequest": {
      "type": "NEW_REQUEST",
      "name": "<string>",
      "causeID": 123,
      "errors": [
        "<string>"
      ],
      "request": {
        "orderType": "DIRECTSHIP",
        "items": [
          {
            "orderItemID": 123,
            "partNumber": "<string>",
            "sku": "<string>",
            "quantity": 123,
            "customItemData": {},
            "itemDependency": 123,
            "productTitle": "<string>",
            "taxable": true,
            "weight": 123,
            "length": 123,
            "width": 123,
            "height": 123,
            "tags": {},
            "extendedProductInfo": {
              "attributes": [
                {
                  "attributeFQN": "<string>",
                  "attributeValues": [
                    "<string>"
                  ]
                }
              ]
            },
            "condition": "<string>",
            "serialNumber": "<string>",
            "backorderable": true,
            "futureOrderable": true,
            "shippingMethod": "<string>",
            "granularInventoryItem": true,
            "upc": "<string>"
          }
        ],
        "total": 123,
        "environmentID": 123,
        "strategyID": "<string>",
        "shippingAddress": {
          "addressID": 123,
          "customerID": 123,
          "addressLine1": "<string>",
          "phone": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postalCode": "<string>",
          "countryCode": "<string>",
          "latitude": 123,
          "longitude": 123
        },
        "isExpress": true,
        "locationCodeWhiteList": [
          "<string>"
        ],
        "exclusionListLocationCode": [
          {
            "orderItemID": 123,
            "locationCode": "<string>"
          }
        ],
        "tags": {},
        "extendedCustomerInfo": {
          "customerId": "<string>",
          "segments": [
            "<string>"
          ],
          "attributes": [
            {
              "attributeFQN": "<string>",
              "attributeValues": [
                "<string>"
              ]
            }
          ],
          "companyOrOrganization": "<string>",
          "taxId": "<string>",
          "externalId": "<string>",
          "accountType": "<string>",
          "taxExempt": true,
          "customerSinceDate": "2023-11-07T05:31:56Z"
        },
        "extendedOrderInfo": {
          "type": "<string>",
          "orderId": "<string>",
          "attributes": [
            {
              "attributeFQN": "<string>",
              "attributeValues": [
                "<string>"
              ]
            }
          ]
        },
        "pickupLocationCode": "<string>",
        "inventoryRequestType": "ALL",
        "futureExclusionListLocationCode": [
          {
            "orderItemID": 123,
            "locationCode": "<string>"
          }
        ],
        "futureDateLimit": "2023-11-07T05:31:56Z",
        "sort": "SUGGESTION_SORT",
        "externalResponseID": "<string>",
        "orderID": 123,
        "cartID": "<string>",
        "fraud": 123,
        "customData": {},
        "bundlingStrategy": "ITEM_DEPENDENCY",
        "forceSTHConsolidationOnSplitShipments": true,
        "sthConsolidationLocationOverride": "<string>",
        "numShipmentsNotInRequest": 123,
        "shippingMethod": "<string>"
      }
    },
    "pathString": "<string>",
    "persisted": true,
    "userContext": {
      "tenantID": 123,
      "siteID": 123,
      "environmentID": 123,
      "loaded": true,
      "tenantService": {
        "tenantClient": {},
        "tenantAttributesCache": {}
      },
      "pathString": "<string>",
      "siteService": {}
    }
  },
  "route": "DIRECTSHIP",
  "customData": {},
  "assignmentSuggestionShipmentGroups": [
    {
      "id": "<string>",
      "locationCode": "<string>",
      "data": {}
    }
  ],
  "data": {},
  "attributes": [
    {
      "fullyQualifiedName": "<string>",
      "values": [
        "<string>"
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Headers

x-vol-tenant
integer<int32>
required

Tenant

x-vol-site
integer<int32>
required

Site

Query Parameters

returnSuggestionLog
boolean
default:false

Body

application/json
orderType
enum<string>
required
Available options:
DIRECTSHIP,
TRANSFER,
STH_CONSOLIDATED,
RETURN,
DISPOSITION,
DELIVERY,
BOPIS
total
number
required
eddItems
object[]
required
environmentID
integer<int32>
strategyID
string
shippingAddress
object
isExpress
boolean
locationCodeWhiteList
string[]
exclusionListLocationCode
object[]
tags
object
extendedCustomerInfo
object
extendedOrderInfo
object
pickupLocationCode
string
inventoryRequestType
enum<string>
Available options:
ALL,
ANY,
PARTIAL,
ALL_STORES
futureExclusionListLocationCode
object[]
futureDateLimit
string<date-time>
sort
enum<string>
Available options:
SUGGESTION_SORT
externalResponseID
string
orderID
integer<int32>
cartID
string
fraud
integer<int32>
customData
object
bundlingStrategy
enum<string>
Available options:
ITEM_DEPENDENCY
forceSTHConsolidationOnSplitShipments
boolean
sthConsolidationLocationOverride
string
numShipmentsNotInRequest
integer<int32>
shippingMethod
string
remorsePeriodInMinutes
integer<int32>
eddItemsAndRegenerateOrderItems
object[]

Response

OK

eddAssignments
object[]
stateChangeSuggestions
object
availableLocations
integer<int32>[]
responseID
integer<int32>
externalResponseID
string
suggestionLog
object
route
enum<string>
Available options:
DIRECTSHIP,
TRANSFER,
STH_CONSOLIDATED,
RETURN,
DISPOSITION,
DELIVERY,
BOPIS
customData
object
assignmentSuggestionShipmentGroups
object[]
data
object
attributes
object[]