Skip to main content
POST
/
commerce
/
orders
/
orderrouting
/
api
/
v1
/
routing
/
suggestionTest
Error
A valid request URL is required to generate request examples
{
  "assignmentSuggestions": {},
  "availableLocations": [
    123
  ],
  "emptyResponse": true,
  "externalResponseID": "<string>",
  "futureAssignmentSuggestions": {},
  "responseID": 123,
  "route": "DIRECTSHIP",
  "stateChangeSuggestions": {},
  "suggestionLog": {
    "created": "2023-11-07T05:31:56Z",
    "creatorUsername": "<string>",
    "environmentID": 123,
    "events": [
      {
        "causeID": 123,
        "errors": [
          "<string>"
        ],
        "name": "<string>",
        "type": "NEW_REQUEST"
      }
    ],
    "externalResponseID": "<string>",
    "orderID": 123,
    "pathString": "<string>",
    "persisted": true,
    "siteID": 123,
    "suggestionID": 123,
    "tenantID": 123,
    "updated": "2023-11-07T05:31:56Z",
    "updaterUsername": "<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
testInventoryResponses
InventoryResponse · object[]

Response

OK

assignmentSuggestions
object
availableLocations
integer<int32>[]
emptyResponse
boolean
externalResponseID
string
futureAssignmentSuggestions
object
responseID
integer<int32>
route
enum<string>
Available options:
DIRECTSHIP,
TRANSFER,
STH_CONSOLIDATED,
RETURN,
DISPOSITION,
DELIVERY,
BOPIS
stateChangeSuggestions
object
suggestionLog
object