Routings

routings

store OrderRouting

post

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

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: orderRouting

orderRoutingIdstringOptional

routingGroupIdstringOptional

statusIdstringOptional

routingNamestringOptional

sequenceNumnumber · int64Optional

descriptionstringOptional

createdByUserstringOptional

createdByUserIdstringOptional

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

/routings

HTTPcURLJavaScriptPython

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": "2026-01-30T13:44:33.654Z",
  "lastUpdatedStamp": "2026-01-30T13:44:33.654Z"
}

application/jsonmultipart/form-data

{
  "_entity": "orderRouting.PK",
  "orderRoutingId": "text"
}

one OrderRouting (master: default)

get

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

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

orderRoutingIdstringRequired

Unique identifier for the order routing.

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

/routings/{orderRoutingId}

HTTPcURLJavaScriptPython

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": "2026-01-30T13:44:33.654Z",
  "lastUpdatedStamp": "2026-01-30T13:44:33.654Z",
  "orderFilters": [
    {
      "_entity": "routingOrderFilter",
      "orderRoutingId": "text",
      "conditionSeqId": "text",
      "conditionTypeEnumId": "text",
      "fieldName": "text",
      "operator": "text",
      "fieldValue": "text",
      "sequenceNum": 1,
      "createdDate": "2026-01-30T13:44:33.654Z",
      "lastUpdatedStamp": "2026-01-30T13:44:33.654Z"
    }
  ],
  "rules": [
    {
      "_entity": "orderRoutingRule",
      "routingRuleId": "text",
      "orderRoutingId": "text",
      "ruleName": "text",
      "statusId": "text",
      "sequenceNum": 1,
      "assignmentEnumId": "text",
      "createdDate": "2026-01-30T13:44:33.654Z",
      "createdByUser": "text",
      "createdByUserId": "text",
      "lastUpdatedStamp": "2026-01-30T13:44:33.654Z"
    }
  ]
}

store OrderRouting (master: default)

post

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

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

orderRoutingIdstringRequired

Unique identifier for the order routing.

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: orderRouting

orderRoutingIdstringOptional

routingGroupIdstringOptional

statusIdstringOptional

routingNamestringOptional

sequenceNumnumber · int64Optional

descriptionstringOptional

createdByUserstringOptional

createdByUserIdstringOptional

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

/routings/{orderRoutingId}

HTTPcURLJavaScriptPython

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": "2026-01-30T13:44:33.654Z",
  "lastUpdatedStamp": "2026-01-30T13:44:33.654Z",
  "orderFilters": [
    {
      "_entity": "routingOrderFilter",
      "orderRoutingId": "text",
      "conditionSeqId": "text",
      "conditionTypeEnumId": "text",
      "fieldName": "text",
      "operator": "text",
      "fieldValue": "text",
      "sequenceNum": 1,
      "createdDate": "2026-01-30T13:44:33.654Z",
      "lastUpdatedStamp": "2026-01-30T13:44:33.654Z"
    }
  ],
  "rules": [
    {
      "_entity": "orderRoutingRule",
      "routingRuleId": "text",
      "orderRoutingId": "text",
      "ruleName": "text",
      "statusId": "text",
      "sequenceNum": 1,
      "assignmentEnumId": "text",
      "createdDate": "2026-01-30T13:44:33.654Z",
      "createdByUser": "text",
      "createdByUserId": "text",
      "lastUpdatedStamp": "2026-01-30T13:44:33.654Z"
    }
  ]
}

application/jsonmultipart/form-data

{
  "_entity": "orderRouting.PK",
  "orderRoutingId": "text"
}

list OrderRoutingRule

get

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

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

orderRoutingIdstringRequired

Unique identifier for the order routing.

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

routingRuleIdstringOptional

Unique identifier for the routing rule.

ruleNamestringOptional

Name of the routing rule.

statusIdstringOptional

Status of the routing rule.

sequenceNumnumber · int64Optional

Sequence number for ordering.

assignmentEnumIdstringOptional

Type of assignment for the routing rule (single/multi).

createdDatestring · date-timeOptional

Date and time when the routing rule was created.

createdByUserstringOptional

User login ID of the creator.

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

get

/routings/{orderRoutingId}/rules

HTTPcURLJavaScriptPython

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": "2026-01-30T13:44:33.654Z",
    "createdByUser": "text",
    "createdByUserId": "text",
    "lastUpdatedStamp": "2026-01-30T13:44:33.654Z"
  }
]

list OrderFilterCondition

get

Defines conditions used in order routing rules to filter and route orders based on specified criteria.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

orderRoutingIdstringRequired

Unique identifier for the order routing.

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

/routings/{orderRoutingId}/orderFilters

HTTPcURLJavaScriptPython

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": "2026-01-30T13:44:33.654Z",
    "lastUpdatedStamp": "2026-01-30T13:44:33.654Z"
  }
]

store OrderFilterCondition

post

Defines conditions used in order routing rules to filter and route orders based on specified criteria.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

orderRoutingIdstringRequired

Unique identifier for the order routing.

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: routingOrderFilter

orderRoutingIdstringOptional

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

/routings/{orderRoutingId}/orderFilters

HTTPcURLJavaScriptPython

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": "2026-01-30T13:44:33.654Z",
  "lastUpdatedStamp": "2026-01-30T13:44:33.654Z"
}

application/jsonmultipart/form-data

{
  "_entity": "routingOrderFilter.PK",
  "orderRoutingId": "text",
  "conditionSeqId": "text"
}

delete OrderFilterCondition

delete

Defines conditions used in order routing rules to filter and route orders based on specified criteria.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

orderRoutingIdstringRequired

Unique identifier for the order routing.

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: routingOrderFilter.PK

orderRoutingIdstringOptional

conditionSeqIdstringOptional

Responses

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

delete

/routings/{orderRoutingId}/orderFilters

HTTPcURLJavaScriptPython

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

application/jsonmultipart/form-data

No content

list OrderRoutingRun

get

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

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

orderRoutingIdstringRequired

Unique identifier for the order routing.

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.

routingGroupIdstringOptional

Unique identifier for the order routing group.

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

/routings/{orderRoutingId}/routingRuns

HTTPcURLJavaScriptPython

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

clone OrderRouting

post

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

orderRoutingIdstringRequired

Body

application/jsonmultipart/form-data

orderRoutingIdstringRequired

newRoutingGroupIdstringRequired

copyOrderRoutingRulesbooleanOptional

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

Default: true

newRoutingNamestringOptional

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

/routings/{orderRoutingId}/clone

HTTPcURLJavaScriptPython

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

application/jsonmultipart/form-data

{
  "newOrderRoutingId": "text"
}

get OrderFilterSql

get

This service will return the eligible orders sql for order routing

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

orderRoutingIdstringRequired

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

get

/routings/{orderRoutingId}/sql

HTTPcURLJavaScriptPython

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

get RoutingOrderCount

get

Return the eligible order item count for the Order Routing

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

orderRoutingIdstringRequired

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

get

/routings/{orderRoutingId}/orderCount

HTTPcURLJavaScriptPython

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

{
  "orderItemCount": 1
}