Update Scenario

Error

A valid request URL is required to generate request examples

{
  "active": true,
  "defaultGroup": true,
  "description": "<string>",
  "filterLogicalGroups": [
    {
      "filterLogicalGroupID": 123,
      "isRootGroup": true,
      "orderIndex": 123,
      "parentOrderIndex": 123,
      "scenarioID": 123
    }
  ],
  "filters": [
    {
      "customValue": {},
      "customValueUnit": "<string>",
      "dataListID": 123,
      "dataPointAttributePath": "<string>",
      "dataPointExtensibleAttributeFQN": "<string>",
      "dataPointExtensibleAttributeName": "<string>",
      "dataPointExtensibleAttributeType": "<string>",
      "extensibleAttributeFQN": "<string>",
      "extensibleAttributeName": "<string>",
      "filterAttributePath": "<string>",
      "filterID": 123,
      "filterLogicalGroupOrderIndex": 123,
      "isDataPointExtensible": true,
      "isExtensible": true,
      "itemCustomAttributeName": "<string>",
      "name": "<string>",
      "orderIndex": 123
    }
  ],
  "locations": [
    "<string>"
  ],
  "name": "<string>",
  "rank": 123,
  "restartGroupIdForNoMatch": 123,
  "restartGroupIdForPartialAssignment": 123,
  "scenarioID": 123,
  "strategyID": "<string>",
  "unselectedLocations": [
    "<string>"
  ]
}

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

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

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

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

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

PUT

commerce

orders

orderrouting

api

strategies

{strategyID}

scenarios

{scenarioID}

Error

A valid request URL is required to generate request examples

{
  "active": true,
  "defaultGroup": true,
  "description": "<string>",
  "filterLogicalGroups": [
    {
      "filterLogicalGroupID": 123,
      "isRootGroup": true,
      "orderIndex": 123,
      "parentOrderIndex": 123,
      "scenarioID": 123
    }
  ],
  "filters": [
    {
      "customValue": {},
      "customValueUnit": "<string>",
      "dataListID": 123,
      "dataPointAttributePath": "<string>",
      "dataPointExtensibleAttributeFQN": "<string>",
      "dataPointExtensibleAttributeName": "<string>",
      "dataPointExtensibleAttributeType": "<string>",
      "extensibleAttributeFQN": "<string>",
      "extensibleAttributeName": "<string>",
      "filterAttributePath": "<string>",
      "filterID": 123,
      "filterLogicalGroupOrderIndex": 123,
      "isDataPointExtensible": true,
      "isExtensible": true,
      "itemCustomAttributeName": "<string>",
      "name": "<string>",
      "orderIndex": 123
    }
  ],
  "locations": [
    "<string>"
  ],
  "name": "<string>",
  "rank": 123,
  "restartGroupIdForNoMatch": 123,
  "restartGroupIdForPartialAssignment": 123,
  "scenarioID": 123,
  "strategyID": "<string>",
  "unselectedLocations": [
    "<string>"
  ]
}

{
  "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

x-vol-site

integer<int32>

required

Path Parameters

strategyID

string

required

scenarioID

integer<int32>

required

Body

application/json

name

string

required

active

boolean

defaultGroup

boolean

description

string

filterLogicalGroups

object[]

Show child attributes

filters

object[]

Show child attributes

locations

string[]

noMatch

enum<string>

Available options:

LINE_ITEM_SPLIT_ASSIGN_IF_FULFILLED,

LINE_ITEM_SPLIT_CANCEL_WITHOUT_INVENTORY,

QUANTITY_SPLIT_ASSIGN_IF_FULFILLED,

QUANTITY_SPLIT_CANCEL_WITHOUT_INVENTORY,

CANCEL_ORDER,

ASSIGN_TO_CUSTOMER_CARE,

ASSIGN_TO_GROUP,

LINE_ITEM_SPLIT_ASSIGN_CUSTOMER_CARE_WITHOUT_INVENTORY,

QUANTITY_SPLIT_ASSIGN_CUSTOMER_CARE_WITHOUT_INVENTORY,

SEND_ORDER_TO_BIDDING,

LINE_ITEM_SPLIT_BACKORDER_WITHOUT_INVENTORY,

QUANTITY_SPLIT_BACKORDER_WITHOUT_INVENTORY,

ASSIGN_TO_BACKORDER

partialMatch

enum<string>

Available options:

LINE_ITEM_SPLIT_ASSIGN_IF_FULFILLED,

LINE_ITEM_SPLIT_CANCEL_WITHOUT_INVENTORY,

QUANTITY_SPLIT_ASSIGN_IF_FULFILLED,

QUANTITY_SPLIT_CANCEL_WITHOUT_INVENTORY,

CANCEL_ORDER,

ASSIGN_TO_CUSTOMER_CARE,

ASSIGN_TO_GROUP,

LINE_ITEM_SPLIT_ASSIGN_CUSTOMER_CARE_WITHOUT_INVENTORY,

QUANTITY_SPLIT_ASSIGN_CUSTOMER_CARE_WITHOUT_INVENTORY,

SEND_ORDER_TO_BIDDING,

LINE_ITEM_SPLIT_BACKORDER_WITHOUT_INVENTORY,

QUANTITY_SPLIT_BACKORDER_WITHOUT_INVENTORY,

ASSIGN_TO_BACKORDER

primarySorting

enum<string>

Available options:

RANK,

DISTANCE,

LTD,

COST,

RANDOM,

DATA_SET,

LOWEST_AVAILABLE,

HIGHEST_AVAILABLE,

EXCESS_COUNT,

EXCESS_PERCENTAGE

restartAttemptForNoMatch

enum<string>

Available options:

START_AT_BEGINNING,

CURRENT_GROUP,

GROUP_RANK

restartAttemptForPartialAssignment

enum<string>

Available options:

START_AT_BEGINNING,

CURRENT_GROUP,

GROUP_RANK

restartGroupIdForNoMatch

integer<int32>

restartGroupIdForPartialAssignment

integer<int32>

secondarySorting

enum<string>

Available options:

RANK,

DISTANCE,

LTD,

COST,

RANDOM,

DATA_SET,

LOWEST_AVAILABLE,

HIGHEST_AVAILABLE,

EXCESS_COUNT,

EXCESS_PERCENTAGE

unselectedLocations

string[]

Response

active

boolean

defaultGroup

boolean

description

string

filterLogicalGroups

object[]

Show child attributes

filters

object[]

Show child attributes

locations

string[]

name

string

noMatch

enum<string>

Available options:

LINE_ITEM_SPLIT_ASSIGN_IF_FULFILLED,

LINE_ITEM_SPLIT_CANCEL_WITHOUT_INVENTORY,

QUANTITY_SPLIT_ASSIGN_IF_FULFILLED,

QUANTITY_SPLIT_CANCEL_WITHOUT_INVENTORY,

CANCEL_ORDER,

ASSIGN_TO_CUSTOMER_CARE,

ASSIGN_TO_GROUP,

LINE_ITEM_SPLIT_ASSIGN_CUSTOMER_CARE_WITHOUT_INVENTORY,

QUANTITY_SPLIT_ASSIGN_CUSTOMER_CARE_WITHOUT_INVENTORY,

SEND_ORDER_TO_BIDDING,

LINE_ITEM_SPLIT_BACKORDER_WITHOUT_INVENTORY,

QUANTITY_SPLIT_BACKORDER_WITHOUT_INVENTORY,

ASSIGN_TO_BACKORDER

partialMatch

enum<string>

Available options:

LINE_ITEM_SPLIT_ASSIGN_IF_FULFILLED,

LINE_ITEM_SPLIT_CANCEL_WITHOUT_INVENTORY,

QUANTITY_SPLIT_ASSIGN_IF_FULFILLED,

QUANTITY_SPLIT_CANCEL_WITHOUT_INVENTORY,

CANCEL_ORDER,

ASSIGN_TO_CUSTOMER_CARE,

ASSIGN_TO_GROUP,

LINE_ITEM_SPLIT_ASSIGN_CUSTOMER_CARE_WITHOUT_INVENTORY,

QUANTITY_SPLIT_ASSIGN_CUSTOMER_CARE_WITHOUT_INVENTORY,

SEND_ORDER_TO_BIDDING,

LINE_ITEM_SPLIT_BACKORDER_WITHOUT_INVENTORY,

QUANTITY_SPLIT_BACKORDER_WITHOUT_INVENTORY,

ASSIGN_TO_BACKORDER

primarySorting

enum<string>

Available options:

RANK,

DISTANCE,

LTD,

COST,

RANDOM,

DATA_SET,

LOWEST_AVAILABLE,

HIGHEST_AVAILABLE,

EXCESS_COUNT,

EXCESS_PERCENTAGE

rank

integer<int32>

restartAttemptForNoMatch

enum<string>

Available options:

START_AT_BEGINNING,

CURRENT_GROUP,

GROUP_RANK

restartAttemptForPartialAssignment

enum<string>

Available options:

START_AT_BEGINNING,

CURRENT_GROUP,

GROUP_RANK

restartGroupIdForNoMatch

integer<int32>

restartGroupIdForPartialAssignment

integer<int32>

scenarioID

integer<int32>

secondarySorting

enum<string>

Available options:

RANK,

DISTANCE,

LTD,

COST,

RANDOM,

DATA_SET,

LOWEST_AVAILABLE,

HIGHEST_AVAILABLE,

EXCESS_COUNT,

EXCESS_PERCENTAGE

strategyID

string

unselectedLocations

string[]

Get Scenario By Id

Delete Scenario

Developers

API reference

AI Tools

Authorizations

Headers

Path Parameters

Body

Response