Rules
rules
Represents a rule used in order routing, defining conditions, actions, and assignment logic for order fulfillment.
orderRoutingRuleSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
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-08-08T08:56:54.772Z",
"createdByUser": "text",
"createdByUserId": "text",
"lastUpdatedStamp": "2025-08-08T08:56:54.772Z"
}{
"_entity": "orderRoutingRule.PK",
"routingRuleId": "text"
}Represents a rule used in order routing, defining conditions, actions, and assignment logic for order fulfillment.
Unique identifier for the routing rule.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
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-08-08T08:56:54.772Z",
"createdByUser": "text",
"createdByUserId": "text",
"lastUpdatedStamp": "2025-08-08T08:56:54.772Z",
"inventoryFilters": [
{
"_entity": "routingRuleInvCondition",
"routingRuleId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-08-08T08:56:54.772Z",
"lastUpdatedStamp": "2025-08-08T08:56:54.772Z"
}
],
"actions": [
{
"_entity": "routingRuleAction",
"routingRuleId": "text",
"actionSeqId": "text",
"actionTypeEnumId": "text",
"actionValue": "text",
"createdDate": "2025-08-08T08:56:54.772Z",
"lastUpdatedStamp": "2025-08-08T08:56:54.772Z"
}
],
"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-08-08T08:56:54.772Z"
}
}Represents a rule used in order routing, defining conditions, actions, and assignment logic for order fulfillment.
Unique identifier for the routing rule.
orderRoutingRuleSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
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-08-08T08:56:54.772Z",
"createdByUser": "text",
"createdByUserId": "text",
"lastUpdatedStamp": "2025-08-08T08:56:54.772Z",
"inventoryFilters": [
{
"_entity": "routingRuleInvCondition",
"routingRuleId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-08-08T08:56:54.772Z",
"lastUpdatedStamp": "2025-08-08T08:56:54.772Z"
}
],
"actions": [
{
"_entity": "routingRuleAction",
"routingRuleId": "text",
"actionSeqId": "text",
"actionTypeEnumId": "text",
"actionValue": "text",
"createdDate": "2025-08-08T08:56:54.772Z",
"lastUpdatedStamp": "2025-08-08T08:56:54.772Z"
}
],
"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-08-08T08:56:54.772Z"
}
}{
"_entity": "orderRoutingRule.PK",
"routingRuleId": "text"
}Defines inventory-related conditions used in routing rules to determine order fulfillment based on inventory status.
Unique identifier for the routing rule.
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Unique identifier for the routing rule inventory condition.
Type of condition (Filter/ Order by)
Input parameter for the condition.
Operator used in the condition.
Value of the condition.
Sequence number for ordering.
Date and time when the condition was created.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
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-08-08T08:56:54.772Z",
"lastUpdatedStamp": "2025-08-08T08:56:54.772Z"
}
]Defines inventory-related conditions used in routing rules to determine order fulfillment based on inventory status.
Unique identifier for the routing rule.
routingRuleInvConditionSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
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-08-08T08:56:54.772Z",
"lastUpdatedStamp": "2025-08-08T08:56:54.772Z"
}{
"_entity": "routingRuleInvCondition.PK",
"routingRuleId": "text",
"conditionSeqId": "text"
}Defines inventory-related conditions used in routing rules to determine order fulfillment based on inventory status.
Unique identifier for the routing rule.
routingRuleInvCondition.PKAuthentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
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"
}No content
Specifies actions to be performed when a routing rule is triggered during order processing.
Unique identifier for the routing rule.
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Unique identifier for the action.
Type of action to be performed.
Value or details of the action.
Date and time when the action was created.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
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-08-08T08:56:54.772Z",
"lastUpdatedStamp": "2025-08-08T08:56:54.772Z"
}
]Specifies actions to be performed when a routing rule is triggered during order processing.
Unique identifier for the routing rule.
routingRuleActionSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
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-08-08T08:56:54.772Z",
"lastUpdatedStamp": "2025-08-08T08:56:54.772Z"
}{
"_entity": "routingRuleAction.PK",
"routingRuleId": "text",
"actionSeqId": "text"
}Specifies actions to be performed when a routing rule is triggered during order processing.
Unique identifier for the routing rule.
routingRuleAction.PKAuthentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
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"
}No content
Order routing group sequence. By default, it will be added as the last one.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
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"
}{
"newRoutingRuleId": "text"
}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.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
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"
}Was this helpful?