Suggest Routing Test

Error

A valid request URL is required to generate request examples

{
  "assignmentSuggestionShipmentGroups": [
    {
      "data": {},
      "id": "<string>",
      "locationCode": "<string>"
    }
  ],
  "assignmentSuggestions": {},
  "attributes": [
    {
      "fullyQualifiedName": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "availableLocations": [
    123
  ],
  "data": {},
  "emptyResponse": true,
  "externalResponseID": "<string>",
  "futureAssignmentSuggestions": {},
  "responseID": 123,
  "stateChangeSuggestions": {},
  "suggestionLog": {
    "environmentID": 123,
    "siteID": 123,
    "tenantID": 123,
    "created": "2023-11-07T05:31:56Z",
    "creatorUsername": "<string>",
    "events": [
      {
        "causeID": 123,
        "errors": [
          "<string>"
        ],
        "name": "<string>"
      }
    ],
    "externalResponseID": "<string>",
    "fieldsForNewEddSuggestionRequest": {
      "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
          }
        ],
        "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
          }
        ],
        "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": {
      "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
          }
        ],
        "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": {
      "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
          }
        ],
        "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
          }
        ],
        "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,
    "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": {}
      }
    }
  }
}

{
  "additionalInfo": "<string>",
  "errorMessage": "<string>"
}

{
  "additionalInfo": "<string>",
  "errorMessage": "<string>"
}

{
  "additionalInfo": "<string>",
  "errorMessage": "<string>"
}

{
  "additionalInfo": "<string>",
  "errorMessage": "<string>"
}

{
  "additionalInfo": "<string>",
  "errorMessage": "<string>"
}

POST

commerce

orders

orderrouting

api

routing

suggestionTest

Error

A valid request URL is required to generate request examples

{
  "assignmentSuggestionShipmentGroups": [
    {
      "data": {},
      "id": "<string>",
      "locationCode": "<string>"
    }
  ],
  "assignmentSuggestions": {},
  "attributes": [
    {
      "fullyQualifiedName": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "availableLocations": [
    123
  ],
  "data": {},
  "emptyResponse": true,
  "externalResponseID": "<string>",
  "futureAssignmentSuggestions": {},
  "responseID": 123,
  "stateChangeSuggestions": {},
  "suggestionLog": {
    "environmentID": 123,
    "siteID": 123,
    "tenantID": 123,
    "created": "2023-11-07T05:31:56Z",
    "creatorUsername": "<string>",
    "events": [
      {
        "causeID": 123,
        "errors": [
          "<string>"
        ],
        "name": "<string>"
      }
    ],
    "externalResponseID": "<string>",
    "fieldsForNewEddSuggestionRequest": {
      "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
          }
        ],
        "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
          }
        ],
        "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": {
      "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
          }
        ],
        "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": {
      "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
          }
        ],
        "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
          }
        ],
        "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,
    "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": {}
      }
    }
  }
}

{
  "additionalInfo": "<string>",
  "errorMessage": "<string>"
}

{
  "additionalInfo": "<string>",
  "errorMessage": "<string>"
}

{
  "additionalInfo": "<string>",
  "errorMessage": "<string>"
}

{
  "additionalInfo": "<string>",
  "errorMessage": "<string>"
}

{
  "additionalInfo": "<string>",
  "errorMessage": "<string>"
}

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:true

Body

application/json

suggestionRequest

object

Show child attributes

testInventoryResponses

object[]

Show child attributes

Response

assignmentSuggestionShipmentGroups

object[]

Show child attributes

assignmentSuggestions

object

Show child attributes

attributes

object[]

Show child attributes

availableLocations

integer<int32>[]

data

object

Show child attributes

emptyResponse

boolean

externalResponseID

string

futureAssignmentSuggestions

object

Show child attributes

responseID

integer<int32>

route

enum<string>

Available options:

DIRECTSHIP,

TRANSFER,

STH_CONSOLIDATED,

RETURN,

DISPOSITION,

DELIVERY,

BOPIS

stateChangeSuggestions

object

Show child attributes

suggestionLog

object

Show child attributes

Suggest Routing

Get Auto Add Target

Developers

API reference

AI Tools

Authorizations

Headers

Query Parameters

Body

Response