Skip to main content
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,
            "condition": "<string>",
            "customItemData": {},
            "dimensionUnit": "kg",
            "extendedProductInfo": {
              "attributes": [
                {
                  "attributeFQN": "<string>",
                  "attributeValues": [
                    "<string>"
                  ]
                }
              ]
            },
            "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,
                "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>"
                      ]
                    }
                  ]
                },
                "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",
        "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",
        "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": {},
        "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": [
      {
        "type": "NEW_REQUEST",
        "causeID": 123,
        "errors": [
          "<string>"
        ],
        "name": "<string>"
      }
    ],
    "externalResponseID": "<string>",
    "fieldsForNewEddSuggestionRequest": {
      "type": "NEW_REQUEST",
      "causeID": 123,
      "errors": [
        "<string>"
      ],
      "name": "<string>",
      "request": {
        "items": [
          {
            "backorderable": true,
            "condition": "<string>",
            "customItemData": {},
            "extendedProductInfo": {
              "attributes": [
                {
                  "attributeFQN": "<string>",
                  "attributeValues": [
                    "<string>"
                  ]
                }
              ]
            },
            "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",
        "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",
        "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,
            "condition": "<string>",
            "customItemData": {},
            "extendedProductInfo": {
              "attributes": [
                {
                  "attributeFQN": "<string>",
                  "attributeValues": [
                    "<string>"
                  ]
                }
              ]
            },
            "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",
        "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",
        "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": {},
        "tenantClient": {}
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt

Use this file to discover all available pages before exploring further.

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
​
returnEddCalculationLog
boolean
default:false

Body

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

Response

OK

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