Skip to main content
GET
/
commerce
/
orders
/
orderrouting
/
api
/
v1
/
routing
/
samplerequest
Error
A valid request URL is required to generate request examples
{
  "bundlingStrategy": "ITEM_DEPENDENCY",
  "cartID": "<string>",
  "customData": {},
  "environmentID": 123,
  "exclusionListLocationCode": [
    {
      "locationCode": "<string>",
      "orderItemID": 123
    }
  ],
  "extendedCustomerInfo": {
    "attributes": [
      {
        "attributeFQN": "<string>",
        "attributeValues": [
          "<string>"
        ]
      }
    ],
    "customerId": "<string>",
    "segments": [
      "<string>"
    ]
  },
  "extendedOrderInfo": {
    "attributes": [
      {
        "attributeFQN": "<string>",
        "attributeValues": [
          "<string>"
        ]
      }
    ],
    "orderId": "<string>",
    "type": "<string>"
  },
  "externalResponseID": "<string>",
  "fraud": 123,
  "futureDateLimit": "2023-11-07T05:31:56Z",
  "futureExclusionListLocationCode": [
    {
      "locationCode": "<string>",
      "orderItemID": 123
    }
  ],
  "inventoryRequestType": "ALL",
  "isExpress": true,
  "items": [
    {
      "backorderable": true,
      "customItemData": {},
      "extendedProductInfo": {
        "attributes": [
          {
            "attributeFQN": "<string>",
            "attributeValues": [
              "<string>"
            ]
          }
        ]
      },
      "futureOrderable": true,
      "height": 123,
      "itemDependency": 123,
      "length": 123,
      "orderItemID": 123,
      "partNumber": "<string>",
      "productTitle": "<string>",
      "quantity": 123,
      "sku": "<string>",
      "taxable": true,
      "upc": "<string>",
      "weight": 123,
      "width": 123,
      "condition": "<string>",
      "serialNumber": "<string>"
    }
  ],
  "locationCodeWhiteList": [
    "<string>"
  ],
  "numShipmentsNotInRequest": 123,
  "orderID": 123,
  "orderType": "DIRECTSHIP",
  "pickupLocationCode": "<string>",
  "shippingAddress": {
    "addressID": 123,
    "addressLine1": "<string>",
    "city": "<string>",
    "countryCode": "<string>",
    "customerID": 123,
    "latitude": 123,
    "longitude": 123,
    "phone": "<string>",
    "postalCode": "<string>",
    "state": "<string>"
  },
  "tags": {},
  "total": 123
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Response

OK

bundlingStrategy
enum<string>
Available options:
ITEM_DEPENDENCY
cartID
string
customData
object
environmentID
integer<int32>
exclusionListLocationCode
object[]
extendedCustomerInfo
object
extendedOrderInfo
object
externalResponseID
string
fraud
integer<int32>
futureDateLimit
string<date-time>
futureExclusionListLocationCode
object[]
inventoryRequestType
enum<string>
Available options:
ALL,
ANY,
PARTIAL,
ALL_STORES
isExpress
boolean
items
OrderItem · object[]
locationCodeWhiteList
string[]
numShipmentsNotInRequest
integer<int32>
orderID
integer<int32>
orderType
enum<string>
Available options:
DIRECTSHIP,
TRANSFER,
STH_CONSOLIDATED,
RETURN,
DISPOSITION,
DELIVERY,
BOPIS
pickupLocationCode
string
shippingAddress
object
tags
object
total
number