Skip to main content
GET
/
commerce
/
orders
/
orderrouting
/
api
/
v1
/
strategies
/
{strategyId}
/
export
Error
A valid request URL is required to generate request examples
{
  "strategyId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "status": "LIVE",
  "orderType": "DIRECTSHIP",
  "active": true,
  "preferAtomicAssignments": true,
  "candidateSortStrategy": "MINIMIZE_SHIPMENTS",
  "scenarios": [
    {
      "scenarioID": 123,
      "strategyID": "<string>",
      "name": "<string>",
      "description": "<string>",
      "active": true,
      "primarySorting": "RANK",
      "secondarySorting": "RANK",
      "fulfillmentLimit": {
        "fulfillmentLimitCount": 123,
        "fulfillmentType": "ORDERS",
        "durationType": "HOURS"
      },
      "partialMatch": "LINE_ITEM_SPLIT_ASSIGN_IF_FULFILLED",
      "noMatch": "LINE_ITEM_SPLIT_ASSIGN_IF_FULFILLED",
      "restartAttemptForPartialAssignment": "START_AT_BEGINNING",
      "restartAttemptForNoMatch": "START_AT_BEGINNING",
      "restartGroupIdForPartialAssignment": 123,
      "restartGroupIdForNoMatch": 123,
      "locations": [
        "<string>"
      ],
      "unselectedLocations": [
        "<string>"
      ],
      "filters": [
        {
          "filterID": 123,
          "name": "<string>",
          "filterType": "filter.type.customValue",
          "booleanOperator": "filter.logic.equal",
          "filterAttributePath": "<string>",
          "isExtensible": true,
          "extensibleAttributeName": "<string>",
          "extensibleAttributeFQN": "<string>",
          "customValue": {},
          "customValueUnit": "<string>",
          "dataPointAttributePath": "<string>",
          "isDataPointExtensible": true,
          "dataPointExtensibleAttributeName": "<string>",
          "dataPointExtensibleAttributeFQN": "<string>",
          "dataPointExtensibleAttributeType": "<string>",
          "dataListID": 123,
          "itemCustomAttributeName": "<string>",
          "filterLogicalGroupOrderIndex": 123,
          "orderIndex": 123
        }
      ],
      "filterLogicalGroups": [
        {
          "filterLogicalGroupID": 123,
          "scenarioID": 123,
          "logicalOperator": "AND",
          "parentOrderIndex": 123,
          "orderIndex": 123,
          "isRootGroup": true
        }
      ],
      "defaultGroup": true,
      "rank": 123
    }
  ],
  "dependentDataLists": [
    {
      "customDataListId": 123,
      "name": "<string>",
      "description": "<string>",
      "dataType": "STRING",
      "fileName": "<string>",
      "state": "dataset.ready",
      "entryCount": 123,
      "entries": [
        {
          "customDataListEntryId": 123,
          "value": {},
          "stringValue": "<string>",
          "notes": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Headers

x-vol-tenant
integer<int32>
required
x-vol-site
integer<int32>
required

Path Parameters

strategyId
string
required

Response

OK

strategyId
string
name
string
description
string
status
enum<string>
Available options:
LIVE,
STAGED,
ARCHIVED,
IGNORED
orderType
enum<string>
Available options:
DIRECTSHIP,
TRANSFER,
STH_CONSOLIDATED,
RETURN,
DISPOSITION,
DELIVERY,
BOPIS
active
boolean
preferAtomicAssignments
boolean
candidateSortStrategy
enum<string>
Available options:
MINIMIZE_SHIPMENTS,
GROUP_RANK_AND_QUANTITY,
QUANTITY,
DISTANCE
scenarios
object[]
dependentDataLists
object[]