Skip to main content
POST
/
commerce
/
orders
/
orderrouting
/
api
/
v1
/
routing
/
reverseLogisticsSuggestion
Error
A valid request URL is required to generate request examples
{
  "externalResponseID": "<string>",
  "responseID": 123,
  "reverseLogisticsSuggestions": {},
  "route": "DIRECTSHIP",
  "stateChangeSuggestions": {},
  "suggestionLog": {
    "environmentID": 123,
    "siteID": 123,
    "tenantID": 123,
    "created": "2023-11-07T05:31:56Z",
    "creatorUsername": "<string>",
    "events": [
      {
        "type": "NEW_REQUEST",
        "causeID": 123,
        "errors": [
          "<string>"
        ],
        "name": "<string>"
      }
    ],
    "externalResponseID": "<string>",
    "fieldsForNewEddSuggestionRequest": {
      "type": "NEW_REQUEST",
      "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
          }
        ],
        "orderType": "DIRECTSHIP",
        "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
          }
        ],
        "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": {}
      }
    },
    "fieldsForNewReturnsSuggestionRequest": {
      "type": "NEW_REQUEST",
      "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
          }
        ],
        "orderType": "DIRECTSHIP",
        "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": {
      "type": "NEW_REQUEST",
      "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
          }
        ],
        "orderType": "DIRECTSHIP",
        "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
          }
        ],
        "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": {}
      }
    },
    "orderID": 123,
    "orderTypeCategory": "STANDARD",
    "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": {}
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Body

application/json
​
items
object[]
required
​
orderType
enum<string>
required
Available options:
DIRECTSHIP,
TRANSFER,
STH_CONSOLIDATED,
RETURN,
DISPOSITION,
DELIVERY,
BOPIS
​
total
number
required
​
bundlingStrategy
enum<string>
Available options:
ITEM_DEPENDENCY
​
customData
object
​
environmentID
integer<int32>
​
exclusionListLocationCode
object[]
​
extendedCustomerInfo
object
​
extendedOrderInfo
object
​
externalResponseID
string
​
fraud
integer<int32>
​
isExpress
boolean
​
locationCodeWhiteList
string[]
​
orderID
integer<int32>
​
returnID
integer<int32>
​
shippingAddress
object
​
strategyID
string
​
tags
object

Response

OK

​
externalResponseID
string
​
responseID
integer<int32>
​
reverseLogisticsSuggestions
object
​
route
enum<string>
Available options:
DIRECTSHIP,
TRANSFER,
STH_CONSOLIDATED,
RETURN,
DISPOSITION,
DELIVERY,
BOPIS
​
stateChangeSuggestions
object
​
suggestionLog
object