Groups

groups

list OrderRoutingGroup

get

Represents a group or category used for organizing and managing order routing configurations.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

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

routingGroupIdstringOptional

Unique identifier for the routing group

productStoreIdstringOptional

Unique identifier for the product store

groupNamestringOptional

Name of the routing group.

sequenceNumnumber · int64Optional

Sequence number for ordering.

jobNamestringOptional

moqui.service.job.Service reference

descriptionstringOptional

Description or additional information about the routing group.

createdByUserIdstringOptional

createdByUserstringOptional

User login ID of the creator

createdDatestring · date-timeOptional

Date and time when the routing group was created

lastModifiedDatestring · date-timeOptional

Date and time when the routing group was updated

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

/groups

HTTPcURLJavaScriptPython

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": "2026-01-30T19:25:47.215Z",
    "lastModifiedDate": "2026-01-30T19:25:47.215Z",
    "lastUpdatedStamp": "2026-01-30T19:25:47.215Z"
  }
]

store OrderRoutingGroup

post

Represents a group or category used for organizing and managing order routing configurations.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: orderRoutingGroup

routingGroupIdstringOptional

productStoreIdstringOptional

groupNamestringOptional

sequenceNumnumber · int64Optional

jobNamestringOptional

descriptionstringOptional

createdByUserIdstringOptional

createdByUserstringOptional

createdDatestring · date-timeOptional

lastModifiedDatestring · 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

/groups

HTTPcURLJavaScriptPython

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": "2026-01-30T19:25:47.215Z",
  "lastModifiedDate": "2026-01-30T19:25:47.215Z",
  "lastUpdatedStamp": "2026-01-30T19:25:47.215Z"
}

application/jsonmultipart/form-data

{
  "_entity": "orderRoutingGroup.PK",
  "routingGroupId": "text"
}

one OrderRoutingGroup (master: default)

get

Represents a group or category used for organizing and managing order routing configurations.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingGroupIdstringRequired

Unique identifier for the routing group

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

/groups/{routingGroupId}

HTTPcURLJavaScriptPython

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": "2026-01-30T19:25:47.215Z",
  "lastModifiedDate": "2026-01-30T19:25:47.215Z",
  "lastUpdatedStamp": "2026-01-30T19:25:47.215Z",
  "routings": [
    {
      "_entity": "orderRouting",
      "orderRoutingId": "text",
      "routingGroupId": "text",
      "statusId": "text",
      "routingName": "text",
      "sequenceNum": 1,
      "description": "text",
      "createdByUser": "text",
      "createdByUserId": "text",
      "createdDate": "2026-01-30T19:25:47.215Z",
      "lastUpdatedStamp": "2026-01-30T19:25:47.215Z"
    }
  ]
}

store OrderRoutingGroup (master: default)

post

Represents a group or category used for organizing and managing order routing configurations.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingGroupIdstringRequired

Unique identifier for the routing group

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: orderRoutingGroup

routingGroupIdstringOptional

productStoreIdstringOptional

groupNamestringOptional

sequenceNumnumber · int64Optional

jobNamestringOptional

descriptionstringOptional

createdByUserIdstringOptional

createdByUserstringOptional

createdDatestring · date-timeOptional

lastModifiedDatestring · 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

/groups/{routingGroupId}

HTTPcURLJavaScriptPython

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": "2026-01-30T19:25:47.215Z",
  "lastModifiedDate": "2026-01-30T19:25:47.215Z",
  "lastUpdatedStamp": "2026-01-30T19:25:47.215Z",
  "routings": [
    {
      "_entity": "orderRouting",
      "orderRoutingId": "text",
      "routingGroupId": "text",
      "statusId": "text",
      "routingName": "text",
      "sequenceNum": 1,
      "description": "text",
      "createdByUser": "text",
      "createdByUserId": "text",
      "createdDate": "2026-01-30T19:25:47.215Z",
      "lastUpdatedStamp": "2026-01-30T19:25:47.215Z"
    }
  ]
}

application/jsonmultipart/form-data

{
  "_entity": "orderRoutingGroup.PK",
  "routingGroupId": "text"
}

delete OrderRoutingGroup

delete

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingGroupIdstringRequired

Responses

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

delete

/groups/{routingGroupId}

HTTPcURLJavaScriptPython

DELETE /rest/s1/order-routing/groups/{routingGroupId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

No content

scheduleNow OrderRoutingGroup

post

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.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingGroupIdstringRequired

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/groups/{routingGroupId}/runNow

HTTPcURLJavaScriptPython

POST /rest/s1/order-routing/groups/{routingGroupId}/runNow HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "jobRunId": "text"
}

run OrderRoutingGroup

post

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.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingGroupIdstringRequired

Body

application/jsonmultipart/form-data

routingGroupIdstringRequired

orderRoutingIdstringOptional

routingRuleIdstringOptional

productStoreIdstringRequired

orderIdstringOptional

shipGroupSeqIdstringOptional

changeReasonEnumIdstringOptional

testDriveSessionIdstringOptional

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.

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/groups/{routingGroupId}/run

HTTPcURLJavaScriptPython

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

application/jsonmultipart/form-data

{
  "attemptedItemCount": 1,
  "brokeredItemCount": 1
}

get OrderRoutingGroupSchedule

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingGroupIdstringRequired

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

get

/groups/{routingGroupId}/schedule

HTTPcURLJavaScriptPython

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": "2026-01-30T19:25:47.215Z",
    "thruDate": "2026-01-30T19:25:47.215Z",
    "repeatCount": 1,
    "paused": "text",
    "expireLockTime": 1,
    "minRetryTime": 1,
    "priority": 1,
    "parentJobName": "text",
    "jobTypeEnumId": "text",
    "permissionGroupId": "text",
    "instanceOfProductId": "text",
    "lastUpdatedStamp": "2026-01-30T19:25:47.215Z"
  }
}

store OrderRoutingGroupSchedule

post

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingGroupIdstringRequired

Body

application/jsonmultipart/form-data

routingGroupIdstringRequired

transactionTimeoutinteger · int64Optional

topicstringOptional

localOnlystringOptional

cronExpressionstringOptional

fromDatestring · date-timeOptional

thruDatestring · date-timeOptional

repeatCountinteger · int64Optional

pausedstringOptional

expireLockTimeinteger · int64Optional

minRetryTimeinteger · int64Optional

priorityinteger · int64Optional

parentJobNamestringOptional

jobTypeEnumIdstringOptional

permissionGroupIdstringOptional

instanceOfProductIdstringOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/groups/{routingGroupId}/schedule

HTTPcURLJavaScriptPython

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": "2026-01-30T19:25:47.215Z",
  "thruDate": "2026-01-30T19:25:47.215Z",
  "repeatCount": 1,
  "paused": "text",
  "expireLockTime": 1,
  "minRetryTime": 1,
  "priority": 1,
  "parentJobName": "text",
  "jobTypeEnumId": "text",
  "permissionGroupId": "text",
  "instanceOfProductId": "text",
  "lastUpdatedStamp": "2026-01-30T19:25:47.215Z"
}

application/jsonmultipart/form-data

{
  "jobName": "text"
}

clone OrderRoutingGroup

post

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingGroupIdstringRequired

Body

application/jsonmultipart/form-data

routingGroupIdstringRequired

newGroupNamestringOptional

sequenceNumstringOptional

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

copyOrderRoutingsbooleanOptional

Parameter to check if the Order routing needs to be cloned.

Default: true

copyOrderRoutingRulesbooleanOptional

Parameter to check if the Order routing rule needs to be cloned, works only if copyOrderRoutings set to true.

Default: true

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/groups/{routingGroupId}/clone

HTTPcURLJavaScriptPython

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

application/jsonmultipart/form-data

{
  "newRoutingGroupId": "text"
}

list OrderRouting

get

Represents configurations for routing orders, including rules and conditions for order fulfillment.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingGroupIdstringRequired

Unique identifier for the routing group

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

orderRoutingIdstringOptional

Unique identifier for the order routing.

statusIdstringOptional

Status identifier for the order routing.

routingNamestringOptional

Name or identifier for the order routing.

sequenceNumnumber · int64Optional

Sequence number for ordering.

descriptionstringOptional

Description or additional information about the order routing.

createdByUserstringOptional

User login ID of the creator.

createdByUserIdstringOptional

createdDatestring · date-timeOptional

Date and time when the order routing 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

/groups/{routingGroupId}/routings

HTTPcURLJavaScriptPython

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": "2026-01-30T19:25:47.215Z",
    "lastUpdatedStamp": "2026-01-30T19:25:47.215Z"
  }
]

list OrderRoutingRun

get

Represents the execution and results of order routing runs, including information about errors and outcomes.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingGroupIdstringRequired

Unique identifier for the order routing group.

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

routingRunIdstringOptional

Unique identifier for the routing run.

orderRoutingIdstringOptional

Unique identifier for the order routing.

routingBatchIdstringOptional

Distinguishes between different routing runs initiated as part of batch processing.

productStoreIdstringOptional

Unique identifier for the product store.

createdByUserstringOptional

User login ID of the creator.

createdByUserIdstringOptional

hasErrorstringOptional

Indicator for the presence of errors.

startDatestring · date-timeOptional

Start date of the routing run.

endDatestring · date-timeOptional

End date of the routing run.

routingResultstringOptional

Result or outcome of the routing run.

orderItemCountnumber · int64Optional

Store the attempted order item count.

brokeredItemCountnumber · int64Optional

Store the brokered order item count.

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

/groups/{routingGroupId}/routingRuns

HTTPcURLJavaScriptPython

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": "2026-01-30T19:25:47.215Z",
    "endDate": "2026-01-30T19:25:47.215Z",
    "routingResult": "text",
    "orderItemCount": 1,
    "brokeredItemCount": 1,
    "lastUpdatedStamp": "2026-01-30T19:25:47.215Z"
  }
]

one OrderRoutingGroup (master: raw)

get

Represents a group or category used for organizing and managing order routing configurations.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

routingGroupIdstringRequired

Unique identifier for the routing group

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

/groups/{routingGroupId}/raw

HTTPcURLJavaScriptPython

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": "2026-01-30T19:25:47.215Z",
  "lastModifiedDate": "2026-01-30T19:25:47.215Z",
  "lastUpdatedStamp": "2026-01-30T19:25:47.215Z",
  "routings": [
    {
      "_entity": "orderRouting",
      "orderRoutingId": "text",
      "routingGroupId": "text",
      "statusId": "text",
      "routingName": "text",
      "sequenceNum": 1,
      "description": "text",
      "createdByUser": "text",
      "createdByUserId": "text",
      "createdDate": "2026-01-30T19:25:47.215Z",
      "lastUpdatedStamp": "2026-01-30T19:25:47.215Z"
    }
  ],
  "schedule": {
    "_entity": "moqui.service.job.ServiceJob",
    "jobName": "text",
    "description": "text",
    "serviceName": "text",
    "transactionTimeout": 1,
    "topic": "text",
    "localOnly": "text",
    "cronExpression": "text",
    "fromDate": "2026-01-30T19:25:47.215Z",
    "thruDate": "2026-01-30T19:25:47.215Z",
    "repeatCount": 1,
    "paused": "text",
    "expireLockTime": 1,
    "minRetryTime": 1,
    "priority": 1,
    "parentJobName": "text",
    "jobTypeEnumId": "text",
    "permissionGroupId": "text",
    "instanceOfProductId": "text",
    "lastUpdatedStamp": "2026-01-30T19:25:47.215Z"
  }
}