Groups
groups
Represents a group or category used for organizing and managing order routing configurations.
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 group
Unique identifier for the product store
Name of the routing group.
Sequence number for ordering.
moqui.service.job.Service reference
Description or additional information about the routing group.
User login ID of the creator
Date and time when the routing group was created
Date and time when the routing group was updated
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
GET /rest/s1/order-routing/groups HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "orderRoutingGroup",
"routingGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUserId": "text",
"createdByUser": "text",
"createdDate": "2025-08-07T18:45:23.873Z",
"lastModifiedDate": "2025-08-07T18:45:23.873Z",
"lastUpdatedStamp": "2025-08-07T18:45:23.873Z"
}
]Represents a group or category used for organizing and managing order routing configurations.
orderRoutingGroupSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
POST /rest/s1/order-routing/groups HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 333
{
"_entity": "orderRoutingGroup",
"routingGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUserId": "text",
"createdByUser": "text",
"createdDate": "2025-08-07T18:45:23.873Z",
"lastModifiedDate": "2025-08-07T18:45:23.873Z",
"lastUpdatedStamp": "2025-08-07T18:45:23.873Z"
}{
"_entity": "orderRoutingGroup.PK",
"routingGroupId": "text"
}Represents a group or category used for organizing and managing order routing configurations.
Unique identifier for the routing group
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
GET /rest/s1/order-routing/groups/{routingGroupId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "orderRoutingGroup",
"routingGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUserId": "text",
"createdByUser": "text",
"createdDate": "2025-08-07T18:45:23.873Z",
"lastModifiedDate": "2025-08-07T18:45:23.873Z",
"lastUpdatedStamp": "2025-08-07T18:45:23.873Z",
"routings": [
{
"_entity": "orderRouting",
"orderRoutingId": "text",
"routingGroupId": "text",
"statusId": "text",
"routingName": "text",
"sequenceNum": 1,
"description": "text",
"createdByUser": "text",
"createdByUserId": "text",
"createdDate": "2025-08-07T18:45:23.873Z",
"lastUpdatedStamp": "2025-08-07T18:45:23.873Z"
}
]
}Represents a group or category used for organizing and managing order routing configurations.
Unique identifier for the routing group
orderRoutingGroupSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
POST /rest/s1/order-routing/groups/{routingGroupId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 632
{
"_entity": "orderRoutingGroup",
"routingGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUserId": "text",
"createdByUser": "text",
"createdDate": "2025-08-07T18:45:23.873Z",
"lastModifiedDate": "2025-08-07T18:45:23.873Z",
"lastUpdatedStamp": "2025-08-07T18:45:23.873Z",
"routings": [
{
"_entity": "orderRouting",
"orderRoutingId": "text",
"routingGroupId": "text",
"statusId": "text",
"routingName": "text",
"sequenceNum": 1,
"description": "text",
"createdByUser": "text",
"createdByUserId": "text",
"createdDate": "2025-08-07T18:45:23.873Z",
"lastUpdatedStamp": "2025-08-07T18:45:23.873Z"
}
]
}{
"_entity": "orderRoutingGroup.PK",
"routingGroupId": "text"
}Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
DELETE /rest/s1/order-routing/groups/{routingGroupId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
No content
This service schedules the routing process for an Order Routing Group. If the routing group schedule is not configured, the service will first create a schedule with a "pause" status (i.e., pause = "Y"), then service will trigger the framework to schedule the order routing group for immediate processing. The service utilizes the ScheduleJob functionality to initiate the process. Parameters for this execution are retrieved from the ServiceJobParameter. It's important to note that this service is designed to handle Order Routing Groups and not intended for scheduling individual orders.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/order-routing/groups/{routingGroupId}/runNow HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"jobRunId": "text"
}The action initiates the processing or execution sequence for an Order Routing within the system. This procedure is crucial for managing and directing orders through the appropriate fulfillment pathways based on predefined criteria and rules set within the Order Routing Group. This service is designed to retrieve active order routings for a specified OrderRoutingGroup based on their sequence number. It aims to prioritize and organize order processing efficiently, ensuring that orders are routed and fulfilled according to pre-established sequences that optimize logistics, delivery times, and resource allocation.
For test drive mode, if the productStore has brokering disabled (enableBrokering is set to "N") and a valid testDriveSessionId is provided, the brokering group will be executed.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/order-routing/groups/{routingGroupId}/run HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 193
{
"routingGroupId": "text",
"orderRoutingId": "text",
"routingRuleId": "text",
"productStoreId": "text",
"orderId": "text",
"shipGroupSeqId": "text",
"changeReasonEnumId": "text",
"testDriveSessionId": "text"
}{
"attemptedItemCount": 1,
"brokeredItemCount": 1
}Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
GET /rest/s1/order-routing/groups/{routingGroupId}/schedule HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"schedule": {
"jobName": "text",
"description": "text",
"serviceName": "text",
"transactionTimeout": 1,
"topic": "text",
"localOnly": "text",
"cronExpression": "text",
"fromDate": "2025-08-07T18:45:23.873Z",
"thruDate": "2025-08-07T18:45:23.873Z",
"repeatCount": 1,
"paused": "text",
"expireLockTime": 1,
"minRetryTime": 1,
"priority": 1,
"parentJobName": "text",
"jobTypeEnumId": "text",
"permissionGroupId": "text",
"instanceOfProductId": "text",
"lastUpdatedStamp": "2025-08-07T18:45:23.873Z"
}
}Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/order-routing/groups/{routingGroupId}/schedule HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 411
{
"routingGroupId": "text",
"transactionTimeout": 1,
"topic": "text",
"localOnly": "text",
"cronExpression": "text",
"fromDate": "2025-08-07T18:45:23.873Z",
"thruDate": "2025-08-07T18:45:23.873Z",
"repeatCount": 1,
"paused": "text",
"expireLockTime": 1,
"minRetryTime": 1,
"priority": 1,
"parentJobName": "text",
"jobTypeEnumId": "text",
"permissionGroupId": "text",
"instanceOfProductId": "text",
"lastUpdatedStamp": "2025-08-07T18:45:23.873Z"
}{
"jobName": "text"
}Order routing group sequence. By default, it will be added as the last one.
Parameter to check if the Order routing needs to be cloned.
trueParameter to check if the Order routing rule needs to be cloned, works only if copyOrderRoutings set to true.
trueSuccess
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/order-routing/groups/{routingGroupId}/clone HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 126
{
"routingGroupId": "text",
"newGroupName": "text",
"sequenceNum": "text",
"copyOrderRoutings": "true",
"copyOrderRoutingRules": "true"
}{
"newRoutingGroupId": "text"
}Represents configurations for routing orders, including rules and conditions for order fulfillment.
Unique identifier for the routing group
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 order routing.
Status identifier for the order routing.
Name or identifier for the order routing.
Sequence number for ordering.
Description or additional information about the order routing.
User login ID of the creator.
Date and time when the order routing was created.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
GET /rest/s1/order-routing/groups/{routingGroupId}/routings 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-07T18:45:23.873Z",
"lastUpdatedStamp": "2025-08-07T18:45:23.873Z"
}
]Represents the execution and results of order routing runs, including information about errors and outcomes.
Unique identifier for the order routing group.
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.
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/groups/{routingGroupId}/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-07T18:45:23.873Z",
"endDate": "2025-08-07T18:45:23.873Z",
"routingResult": "text",
"orderItemCount": 1,
"brokeredItemCount": 1,
"lastUpdatedStamp": "2025-08-07T18:45:23.873Z"
}
]Represents a group or category used for organizing and managing order routing configurations.
Unique identifier for the routing group
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
GET /rest/s1/order-routing/groups/{routingGroupId}/raw HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "orderRoutingGroup",
"routingGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUserId": "text",
"createdByUser": "text",
"createdDate": "2025-08-07T18:45:23.873Z",
"lastModifiedDate": "2025-08-07T18:45:23.873Z",
"lastUpdatedStamp": "2025-08-07T18:45:23.873Z",
"routings": [
{
"_entity": "orderRouting",
"orderRoutingId": "text",
"routingGroupId": "text",
"statusId": "text",
"routingName": "text",
"sequenceNum": 1,
"description": "text",
"createdByUser": "text",
"createdByUserId": "text",
"createdDate": "2025-08-07T18:45:23.873Z",
"lastUpdatedStamp": "2025-08-07T18:45:23.873Z"
}
],
"schedule": {
"_entity": "moqui.service.job.ServiceJob",
"jobName": "text",
"description": "text",
"serviceName": "text",
"transactionTimeout": 1,
"topic": "text",
"localOnly": "text",
"cronExpression": "text",
"fromDate": "2025-08-07T18:45:23.873Z",
"thruDate": "2025-08-07T18:45:23.873Z",
"repeatCount": 1,
"paused": "text",
"expireLockTime": 1,
"minRetryTime": 1,
"priority": 1,
"parentJobName": "text",
"jobTypeEnumId": "text",
"permissionGroupId": "text",
"instanceOfProductId": "text",
"lastUpdatedStamp": "2025-08-07T18:45:23.873Z"
}
}Was this helpful?