Routings
routings
Represents configurations for routing orders, including rules and conditions for order fulfillment.
orderRoutingSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
POST /rest/s1/order-routing/routings HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 285
{
"_entity": "orderRouting",
"orderRoutingId": "text",
"routingGroupId": "text",
"statusId": "text",
"routingName": "text",
"sequenceNum": 1,
"description": "text",
"createdByUser": "text",
"createdByUserId": "text",
"createdDate": "2025-08-08T17:39:58.741Z",
"lastUpdatedStamp": "2025-08-08T17:39:58.741Z"
}{
"_entity": "orderRouting.PK",
"orderRoutingId": "text"
}Represents configurations for routing orders, including rules and conditions for order fulfillment.
Unique identifier for the order routing.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
GET /rest/s1/order-routing/routings/{orderRoutingId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "orderRouting",
"orderRoutingId": "text",
"routingGroupId": "text",
"statusId": "text",
"routingName": "text",
"sequenceNum": 1,
"description": "text",
"createdByUser": "text",
"createdByUserId": "text",
"createdDate": "2025-08-08T17:39:58.741Z",
"lastUpdatedStamp": "2025-08-08T17:39:58.741Z",
"orderFilters": [
{
"_entity": "routingOrderFilter",
"orderRoutingId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-08-08T17:39:58.741Z",
"lastUpdatedStamp": "2025-08-08T17:39:58.741Z"
}
],
"rules": [
{
"_entity": "orderRoutingRule",
"routingRuleId": "text",
"orderRoutingId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"assignmentEnumId": "text",
"createdDate": "2025-08-08T17:39:58.741Z",
"createdByUser": "text",
"createdByUserId": "text",
"lastUpdatedStamp": "2025-08-08T17:39:58.741Z"
}
]
}Represents configurations for routing orders, including rules and conditions for order fulfillment.
Unique identifier for the order routing.
orderRoutingSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
POST /rest/s1/order-routing/routings/{orderRoutingId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 873
{
"_entity": "orderRouting",
"orderRoutingId": "text",
"routingGroupId": "text",
"statusId": "text",
"routingName": "text",
"sequenceNum": 1,
"description": "text",
"createdByUser": "text",
"createdByUserId": "text",
"createdDate": "2025-08-08T17:39:58.741Z",
"lastUpdatedStamp": "2025-08-08T17:39:58.741Z",
"orderFilters": [
{
"_entity": "routingOrderFilter",
"orderRoutingId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-08-08T17:39:58.741Z",
"lastUpdatedStamp": "2025-08-08T17:39:58.741Z"
}
],
"rules": [
{
"_entity": "orderRoutingRule",
"routingRuleId": "text",
"orderRoutingId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"assignmentEnumId": "text",
"createdDate": "2025-08-08T17:39:58.741Z",
"createdByUser": "text",
"createdByUserId": "text",
"lastUpdatedStamp": "2025-08-08T17:39:58.741Z"
}
]
}{
"_entity": "orderRouting.PK",
"orderRoutingId": "text"
}Represents a rule used in order routing, defining conditions, actions, and assignment logic for order fulfillment.
Unique identifier for the order routing.
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.
Name of the routing rule.
Status of the routing rule.
Sequence number for ordering.
Type of assignment for the routing rule (single/multi).
Date and time when the routing rule was created.
User login ID of the creator.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
GET /rest/s1/order-routing/routings/{orderRoutingId}/rules 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-08T17:39:58.741Z",
"createdByUser": "text",
"createdByUserId": "text",
"lastUpdatedStamp": "2025-08-08T17:39:58.741Z"
}
]Defines conditions used in order routing rules to filter and route orders based on specified criteria.
Unique identifier for the order routing.
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 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/routings/{orderRoutingId}/orderFilters HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "routingOrderFilter",
"orderRoutingId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-08-08T17:39:58.741Z",
"lastUpdatedStamp": "2025-08-08T17:39:58.741Z"
}
]Defines conditions used in order routing rules to filter and route orders based on specified criteria.
Unique identifier for the order routing.
routingOrderFilterSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
POST /rest/s1/order-routing/routings/{orderRoutingId}/orderFilters HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 269
{
"_entity": "routingOrderFilter",
"orderRoutingId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-08-08T17:39:58.741Z",
"lastUpdatedStamp": "2025-08-08T17:39:58.741Z"
}{
"_entity": "routingOrderFilter.PK",
"orderRoutingId": "text",
"conditionSeqId": "text"
}Defines conditions used in order routing rules to filter and route orders based on specified criteria.
Unique identifier for the order routing.
routingOrderFilter.PKAuthentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
DELETE /rest/s1/order-routing/routings/{orderRoutingId}/orderFilters HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"_entity": "routingOrderFilter.PK",
"orderRoutingId": "text",
"conditionSeqId": "text"
}No content
Represents the execution and results of order routing runs, including information about errors and outcomes.
Unique identifier for the order routing.
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 run.
Unique identifier for the order routing group.
Distinguishes between different routing runs initiated as part of batch processing.
Unique identifier for the product store.
User login ID of the creator.
Indicator for the presence of errors.
Start date of the routing run.
End date of the routing run.
Result or outcome of the routing run.
Store the attempted order item count.
Store the brokered order item count.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
GET /rest/s1/order-routing/routings/{orderRoutingId}/routingRuns HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "routingRuns",
"routingRunId": "text",
"orderRoutingId": "text",
"routingGroupId": "text",
"routingBatchId": "text",
"productStoreId": "text",
"createdByUser": "text",
"createdByUserId": "text",
"hasError": "text",
"startDate": "2025-08-08T17:39:58.741Z",
"endDate": "2025-08-08T17:39:58.741Z",
"routingResult": "text",
"orderItemCount": 1,
"brokeredItemCount": 1,
"lastUpdatedStamp": "2025-08-08T17:39:58.741Z"
}
]Parameter to check if the Order routing rule needs to be cloned.
trueOrder 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/routings/{orderRoutingId}/clone HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 128
{
"orderRoutingId": "text",
"newRoutingGroupId": "text",
"copyOrderRoutingRules": "true",
"newRoutingName": "text",
"sequenceNum": "text"
}{
"newOrderRoutingId": "text"
}This service will return the eligible orders sql for order routing
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
GET /rest/s1/order-routing/routings/{orderRoutingId}/sql HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"statusId": "text",
"sql": "text"
}Return the eligible order item count for the Order Routing
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
GET /rest/s1/order-routing/routings/{orderRoutingId}/orderCount HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"orderItemCount": 1
}Was this helpful?