Suggest Candidates

Suggests the routing candidates for an order.

POST /commerce/orders/orderrouting/api/v1/routing/candidates

Error

A valid request URL is required to generate request examples

200

{
  "candidateSuggestions": [
    {
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "addressLine3": "<string>",
      "city": "<string>",
      "countryCode": "<string>",
      "directShip": true,
      "distance": "<string>",
      "express": true,
      "inventory": [
        {
          "available": 123,
          "bopisFulfillmentDate": "2023-11-07T05:31:56Z",
          "bopisProcessingTimeHours": 123,
          "futureInventory": [
            {
              "available": 123,
              "bopisFulfillmentDate": "2023-11-07T05:31:56Z",
              "bopisProcessingTimeHours": 123,
              "futureDate": "2023-11-07T05:31:56Z",
              "partNumber": "<string>",
              "receiveProcessingTimeHours": 123,
              "sku": "<string>",
              "sthFulfillmentDate": "2023-11-07T05:31:56Z",
              "sthProcessingTimeHours": 123,
              "transferFulfillmentDate": "2023-11-07T05:31:56Z",
              "transferProcessingTimeHours": 123,
              "upc": "<string>"
            }
          ],
          "partNumber": "<string>",
          "receiveProcessingTimeHours": 123,
          "sku": "<string>",
          "sthFulfillmentDate": "2023-11-07T05:31:56Z",
          "sthProcessingTimeHours": 123,
          "transferFulfillmentDate": "2023-11-07T05:31:56Z",
          "transferProcessingTimeHours": 123,
          "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

items · object[] · required

Show child attributes

orderType · enum<string> · required

Available options: DIRECTSHIP, TRANSFER, STH_CONSOLIDATED, RETURN, DISPOSITION, DELIVERY, BOPIS

environmentID · integer<int32>

exclusionListLocationCode · object[]

Show child attributes

extendedCustomerInfo · object

Show child attributes

extendedOrderInfo · object

Show child attributes

futureDateLimit · string<date-time>

futureExclusionListLocationCode · object[]

Show child attributes

inventoryRequestType · enum<string>

Available options: ALL, ANY, PARTIAL, ALL_STORES

isExpress · boolean

locationCodeWhiteList · string[]

pickupLocationCode · string

shippingAddress · object

Show child attributes

sort · enum<string>

Available options: SUGGESTION_SORT

strategyID · string

tags · object

Show child attributes

Response

200

application/json

OK

candidateSuggestions · object[]

Show child attributes