Skip to main content
POST
/
commerce
/
orders
/
orderrouting
/
api
/
v1
/
routing
/
candidates
Error
A valid request URL is required to generate request examples
{
  "candidateSuggestions": [
    {
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "addressLine3": "<string>",
      "city": "<string>",
      "countryCode": "<string>",
      "directShip": true,
      "distance": "<string>",
      "express": true,
      "inventory": [
        {
          "available": 123,
          "futureInventory": [
            {
              "available": 123,
              "futureDate": "2023-11-07T05:31:56Z",
              "partNumber": "<string>",
              "sku": "<string>",
              "upc": "<string>"
            }
          ],
          "partNumber": "<string>",
          "sku": "<string>",
          "upc": "<string>"
        }
      ],
      "latitude": 123,
      "locationCode": "<string>",
      "locationName": "<string>",
      "longitude": 123,
      "pickup": true,
      "postalCode": "<string>",
      "state": "<string>",
      "transferEnabled": true
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Body

application/json
environmentID
integer<int32>
exclusionListLocationCode
object[]
extendedCustomerInfo
object
extendedOrderInfo
object
futureDateLimit
string<date-time>
futureExclusionListLocationCode
object[]
inventoryRequestType
enum<string>
Available options:
ALL,
ANY,
PARTIAL,
ALL_STORES
isExpress
boolean
items
OrderItem · object[]
locationCodeWhiteList
string[]
orderType
enum<string>
Available options:
DIRECTSHIP,
TRANSFER,
STH_CONSOLIDATED,
RETURN,
DISPOSITION,
DELIVERY,
BOPIS
pickupLocationCode
string
shippingAddress
object
tags
object

Response

OK

candidateSuggestions
object[]