Rules

rules

store OrderRoutingRule

post

Represents a rule used in order routing, defining conditions, actions, and assignment logic for order fulfillment.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: orderRoutingRule

routingRuleIdstringOptional

orderRoutingIdstringOptional

ruleNamestringOptional

statusIdstringOptional

sequenceNumnumber · int64Optional

assignmentEnumIdstringOptional

createdDatestring · date-timeOptional

createdByUserstringOptional

createdByUserIdstringOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

post

/rules

HTTPcURLJavaScriptPython

POST /rest/s1/order-routing/rules HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 290

{
  "_entity": "orderRoutingRule",
  "routingRuleId": "text",
  "orderRoutingId": "text",
  "ruleName": "text",
  "statusId": "text",
  "sequenceNum": 1,
  "assignmentEnumId": "text",
  "createdDate": "2025-12-16T13:59:08.852Z",
  "createdByUser": "text",
  "createdByUserId": "text",
  "lastUpdatedStamp": "2025-12-16T13:59:08.852Z"
}

application/jsonmultipart/form-data

{
  "_entity": "orderRoutingRule.PK",
  "routingRuleId": "text"
}

one OrderRoutingRule (master: default)

get

Represents a rule used in order routing, defining conditions, actions, and assignment logic for order fulfillment.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingRuleIdstringRequired

Unique identifier for the routing rule.

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/rules/{routingRuleId}

HTTPcURLJavaScriptPython

GET /rest/s1/order-routing/rules/{routingRuleId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "_entity": "orderRoutingRule",
  "routingRuleId": "text",
  "orderRoutingId": "text",
  "ruleName": "text",
  "statusId": "text",
  "sequenceNum": 1,
  "assignmentEnumId": "text",
  "createdDate": "2025-12-16T13:59:08.852Z",
  "createdByUser": "text",
  "createdByUserId": "text",
  "lastUpdatedStamp": "2025-12-16T13:59:08.852Z",
  "inventoryFilters": [
    {
      "_entity": "routingRuleInvCondition",
      "routingRuleId": "text",
      "conditionSeqId": "text",
      "conditionTypeEnumId": "text",
      "fieldName": "text",
      "operator": "text",
      "fieldValue": "text",
      "sequenceNum": 1,
      "createdDate": "2025-12-16T13:59:08.852Z",
      "lastUpdatedStamp": "2025-12-16T13:59:08.852Z"
    }
  ],
  "actions": [
    {
      "_entity": "routingRuleAction",
      "routingRuleId": "text",
      "actionSeqId": "text",
      "actionTypeEnumId": "text",
      "actionValue": "text",
      "createdDate": "2025-12-16T13:59:08.852Z",
      "lastUpdatedStamp": "2025-12-16T13:59:08.852Z"
    }
  ],
  "assignment": {
    "_entity": "enums",
    "enumId": "text",
    "enumTypeId": "text",
    "parentEnumId": "text",
    "enumCode": "text",
    "sequenceNum": 1,
    "description": "text",
    "optionValue": "text",
    "optionIndicator": "text",
    "relatedEnumId": "text",
    "relatedEnumTypeId": "text",
    "statusFlowId": "text",
    "enumName": "text",
    "primaryEnumerationGroupId": "text",
    "lastUpdatedStamp": "2025-12-16T13:59:08.852Z"
  }
}

store OrderRoutingRule (master: default)

post

Represents a rule used in order routing, defining conditions, actions, and assignment logic for order fulfillment.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingRuleIdstringRequired

Unique identifier for the routing rule.

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: orderRoutingRule

routingRuleIdstringOptional

orderRoutingIdstringOptional

ruleNamestringOptional

statusIdstringOptional

sequenceNumnumber · int64Optional

assignmentEnumIdstringOptional

createdDatestring · date-timeOptional

createdByUserstringOptional

createdByUserIdstringOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

post

/rules/{routingRuleId}

HTTPcURLJavaScriptPython

POST /rest/s1/order-routing/rules/{routingRuleId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 1170

{
  "_entity": "orderRoutingRule",
  "routingRuleId": "text",
  "orderRoutingId": "text",
  "ruleName": "text",
  "statusId": "text",
  "sequenceNum": 1,
  "assignmentEnumId": "text",
  "createdDate": "2025-12-16T13:59:08.852Z",
  "createdByUser": "text",
  "createdByUserId": "text",
  "lastUpdatedStamp": "2025-12-16T13:59:08.852Z",
  "inventoryFilters": [
    {
      "_entity": "routingRuleInvCondition",
      "routingRuleId": "text",
      "conditionSeqId": "text",
      "conditionTypeEnumId": "text",
      "fieldName": "text",
      "operator": "text",
      "fieldValue": "text",
      "sequenceNum": 1,
      "createdDate": "2025-12-16T13:59:08.852Z",
      "lastUpdatedStamp": "2025-12-16T13:59:08.852Z"
    }
  ],
  "actions": [
    {
      "_entity": "routingRuleAction",
      "routingRuleId": "text",
      "actionSeqId": "text",
      "actionTypeEnumId": "text",
      "actionValue": "text",
      "createdDate": "2025-12-16T13:59:08.852Z",
      "lastUpdatedStamp": "2025-12-16T13:59:08.852Z"
    }
  ],
  "assignment": {
    "_entity": "enums",
    "enumId": "text",
    "enumTypeId": "text",
    "parentEnumId": "text",
    "enumCode": "text",
    "sequenceNum": 1,
    "description": "text",
    "optionValue": "text",
    "optionIndicator": "text",
    "relatedEnumId": "text",
    "relatedEnumTypeId": "text",
    "statusFlowId": "text",
    "enumName": "text",
    "primaryEnumerationGroupId": "text",
    "lastUpdatedStamp": "2025-12-16T13:59:08.852Z"
  }
}

application/jsonmultipart/form-data

{
  "_entity": "orderRoutingRule.PK",
  "routingRuleId": "text"
}

list OrderRoutingRuleInvCond

get

Defines inventory-related conditions used in routing rules to determine order fulfillment based on inventory status.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingRuleIdstringRequired

Unique identifier for the routing rule.

Query parameters

pageIndexnumber · int32Optional

Page number to return, starting with zero

pageSizenumber · int32Optional

Number of records per page (default 100)

orderByFieldstringOptional

Field name to order by (or comma separated names)

pageNoLimitstringOptional

If true don't limit page size (no pagination)

dependentLevelsnumber · int32Optional

Levels of dependent child records to include

conditionSeqIdstringOptional

Unique identifier for the routing rule inventory condition.

conditionTypeEnumIdstringOptional

Type of condition (Filter/ Order by)

fieldNamestringOptional

Input parameter for the condition.

operatorstringOptional

Operator used in the condition.

fieldValuestringOptional

Value of the condition.

sequenceNumnumber · int64Optional

Sequence number for ordering.

createdDatestring · date-timeOptional

Date and time when the condition was created.

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/rules/{routingRuleId}/inventoryFilters

HTTPcURLJavaScriptPython

GET /rest/s1/order-routing/rules/{routingRuleId}/inventoryFilters HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

[
  {
    "_entity": "routingRuleInvCondition",
    "routingRuleId": "text",
    "conditionSeqId": "text",
    "conditionTypeEnumId": "text",
    "fieldName": "text",
    "operator": "text",
    "fieldValue": "text",
    "sequenceNum": 1,
    "createdDate": "2025-12-16T13:59:08.852Z",
    "lastUpdatedStamp": "2025-12-16T13:59:08.852Z"
  }
]

store OrderRoutingRuleInvCond

post

Defines inventory-related conditions used in routing rules to determine order fulfillment based on inventory status.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingRuleIdstringRequired

Unique identifier for the routing rule.

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: routingRuleInvCondition

routingRuleIdstringOptional

conditionSeqIdstringOptional

conditionTypeEnumIdstringOptional

fieldNamestringOptional

operatorstringOptional

fieldValuestringOptional

sequenceNumnumber · int64Optional

createdDatestring · date-timeOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

post

/rules/{routingRuleId}/inventoryFilters

HTTPcURLJavaScriptPython

POST /rest/s1/order-routing/rules/{routingRuleId}/inventoryFilters HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 273

{
  "_entity": "routingRuleInvCondition",
  "routingRuleId": "text",
  "conditionSeqId": "text",
  "conditionTypeEnumId": "text",
  "fieldName": "text",
  "operator": "text",
  "fieldValue": "text",
  "sequenceNum": 1,
  "createdDate": "2025-12-16T13:59:08.852Z",
  "lastUpdatedStamp": "2025-12-16T13:59:08.852Z"
}

application/jsonmultipart/form-data

{
  "_entity": "routingRuleInvCondition.PK",
  "routingRuleId": "text",
  "conditionSeqId": "text"
}

delete OrderRoutingRuleInvCond

delete

Defines inventory-related conditions used in routing rules to determine order fulfillment based on inventory status.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingRuleIdstringRequired

Unique identifier for the routing rule.

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: routingRuleInvCondition.PK

routingRuleIdstringOptional

conditionSeqIdstringOptional

Responses

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

delete

/rules/{routingRuleId}/inventoryFilters

HTTPcURLJavaScriptPython

DELETE /rest/s1/order-routing/rules/{routingRuleId}/inventoryFilters HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "_entity": "routingRuleInvCondition.PK",
  "routingRuleId": "text",
  "conditionSeqId": "text"
}

application/jsonmultipart/form-data

No content

list OrderRoutingRuleAction

get

Specifies actions to be performed when a routing rule is triggered during order processing.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingRuleIdstringRequired

Unique identifier for the routing rule.

Query parameters

pageIndexnumber · int32Optional

Page number to return, starting with zero

pageSizenumber · int32Optional

Number of records per page (default 100)

orderByFieldstringOptional

Field name to order by (or comma separated names)

pageNoLimitstringOptional

If true don't limit page size (no pagination)

dependentLevelsnumber · int32Optional

Levels of dependent child records to include

actionSeqIdstringOptional

Unique identifier for the action.

actionTypeEnumIdstringOptional

Type of action to be performed.

actionValuestringOptional

Value or details of the action.

createdDatestring · date-timeOptional

Date and time when the action was created.

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/rules/{routingRuleId}/actions

HTTPcURLJavaScriptPython

GET /rest/s1/order-routing/rules/{routingRuleId}/actions HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

[
  {
    "_entity": "routingRuleAction",
    "routingRuleId": "text",
    "actionSeqId": "text",
    "actionTypeEnumId": "text",
    "actionValue": "text",
    "createdDate": "2025-12-16T13:59:08.852Z",
    "lastUpdatedStamp": "2025-12-16T13:59:08.852Z"
  }
]

store OrderRoutingRuleAction

post

Specifies actions to be performed when a routing rule is triggered during order processing.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingRuleIdstringRequired

Unique identifier for the routing rule.

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: routingRuleAction

routingRuleIdstringOptional

actionSeqIdstringOptional

actionTypeEnumIdstringOptional

actionValuestringOptional

createdDatestring · date-timeOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

post

/rules/{routingRuleId}/actions

HTTPcURLJavaScriptPython

POST /rest/s1/order-routing/rules/{routingRuleId}/actions HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 209

{
  "_entity": "routingRuleAction",
  "routingRuleId": "text",
  "actionSeqId": "text",
  "actionTypeEnumId": "text",
  "actionValue": "text",
  "createdDate": "2025-12-16T13:59:08.852Z",
  "lastUpdatedStamp": "2025-12-16T13:59:08.852Z"
}

application/jsonmultipart/form-data

{
  "_entity": "routingRuleAction.PK",
  "routingRuleId": "text",
  "actionSeqId": "text"
}

delete OrderRoutingRuleAction

delete

Specifies actions to be performed when a routing rule is triggered during order processing.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingRuleIdstringRequired

Unique identifier for the routing rule.

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: routingRuleAction.PK

routingRuleIdstringOptional

actionSeqIdstringOptional

Responses

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

delete

/rules/{routingRuleId}/actions

HTTPcURLJavaScriptPython

DELETE /rest/s1/order-routing/rules/{routingRuleId}/actions HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "_entity": "routingRuleAction.PK",
  "routingRuleId": "text",
  "actionSeqId": "text"
}

application/jsonmultipart/form-data

No content

clone OrderRoutingRule

post

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingRuleIdstringRequired

Body

application/jsonmultipart/form-data

routingRuleIdstringRequired

newOrderRoutingIdstringRequired

newRuleNamestringOptional

sequenceNumstringOptional

Order routing group sequence. By default, it will be added as the last one.

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/rules/{routingRuleId}/clone

HTTPcURLJavaScriptPython

POST /rest/s1/order-routing/rules/{routingRuleId}/clone HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "routingRuleId": "text",
  "newOrderRoutingId": "text",
  "newRuleName": "text",
  "sequenceNum": "text"
}

application/jsonmultipart/form-data

{
  "newRoutingRuleId": "text"
}

get OrderRoutingRuleSql

get

The Routing Rule ID SQL Query Service is designed to generate SQL queries that fetch inventory allocation based on specific routing rule IDs. This service helps in retrieving accurate inventory data by applying predefined routing rules.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingRuleIdstringRequired

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

get

/rules/{routingRuleId}/sql

HTTPcURLJavaScriptPython

GET /rest/s1/order-routing/rules/{routingRuleId}/sql HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "statusId": "text",
  "sql": "text"
}