Get Sample Request

Retrieves a sample request.

GET /commerce/orders/orderrouting/api/v1/routing/samplerequest

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "backorderable": true,
      "callOffFulfillmentType": "<string>",
      "callOffOrderItemAttributes": [
        {
          "attributeFQN": "<string>",
          "attributeValues": [
            "<string>"
          ]
        }
      ],
      "callOffRequestedQuantity": 123,
      "callOffShippingAddress": {
        "addressID": 123,
        "addressLine1": "<string>",
        "city": "<string>",
        "countryCode": "<string>",
        "customerID": 123,
        "latitude": 123,
        "longitude": 123,
        "phone": "<string>",
        "postalCode": "<string>",
        "state": "<string>"
      },
      "condition": "<string>",
      "customItemData": {},
      "extendedProductInfo": {
        "attributes": [
          {
            "attributeFQN": "<string>",
            "attributeValues": [
              "<string>"
            ]
          }
        ]
      },
      "futureDateLimit": "2023-11-07T05:31:56Z",
      "futureDateStart": "2023-11-07T05:31:56Z",
      "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",
  "callOffChannel": "<string>",
  "callOffOrderAttributes": [
    {
      "attributeFQN": "<string>",
      "attributeValues": [
        "<string>"
      ]
    }
  ],
  "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",
  "futureDateStart": "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": {}
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Response

200

application/json

OK

items · object[] · required

Show child attributes

orderType · enum<string> · required

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

total · number · required

bundlingStrategy · enum<string>

Available options: ITEM_DEPENDENCY

callOffChannel · string

callOffOrderAttributes · object[]

Show child attributes

cartID · string

customData · object

Show child attributes

environmentID · integer<int32>

exclusionListLocationCode · object[]

Show child attributes

extendedCustomerInfo · object

Show child attributes

extendedOrderInfo · object

Show child attributes

externalResponseID · string

forceSTHConsolidationOnSplitShipments · boolean

fraud · integer<int32>

futureDateLimit · string<date-time>

futureDateStart · string<date-time>

futureExclusionListLocationCode · object[]

Show child attributes

inventoryRequestType · enum<string>

Available options: ALL, ANY, PARTIAL, ALL_STORES

isExpress · boolean

locationCodeWhiteList · string[]

numShipmentsNotInRequest · integer<int32>

orderID · integer<int32>

pickupLocationCode · string

shippingAddress · object

Show child attributes

shippingMethod · string

sort · enum<string>

Available options: SUGGESTION_SORT

sthConsolidationLocationOverride · string

strategyID · string

tags · object

Show child attributes