# Routings routings ## store OrderRouting > Represents configurations for routing orders, including rules and conditions for order fulfillment. ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"routings","description":"routings"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/order-routing"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"orderRouting.PK":{"title":"Order Routing","type":"object","properties":{"_entity":{"type":"string","default":"orderRouting.PK"},"orderRoutingId":{"type":"string"}}},"orderRouting":{"title":"Order Routing","type":"object","properties":{"_entity":{"type":"string","default":"orderRouting"},"orderRoutingId":{"type":"string"},"routingGroupId":{"type":"string"},"statusId":{"type":"string"},"routingName":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"description":{"type":"string"},"createdByUser":{"type":"string"},"createdByUserId":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/routings":{"post":{"tags":["routings"],"summary":"store OrderRouting","description":"Represents configurations for routing orders, including rules and conditions for order fulfillment.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderRouting.PK"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderRouting"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/orderRouting"}}},"required":false}}}}} ``` ## one OrderRouting (master: default) > Represents configurations for routing orders, including rules and conditions for order fulfillment. ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"routings","description":"routings"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/order-routing"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"orderRouting.default":{"title":"Order Routing (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"orderRouting"},"orderRoutingId":{"type":"string"},"routingGroupId":{"type":"string"},"statusId":{"type":"string"},"routingName":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"description":{"type":"string"},"createdByUser":{"type":"string"},"createdByUserId":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"orderFilters":{"type":"array","items":{"$ref":"#/components/schemas/routingOrderFilter"}},"rules":{"type":"array","items":{"$ref":"#/components/schemas/orderRoutingRule"}}}},"routingOrderFilter":{"title":"Order Filter Condition","type":"object","properties":{"_entity":{"type":"string","default":"routingOrderFilter"},"orderRoutingId":{"type":"string"},"conditionSeqId":{"type":"string"},"conditionTypeEnumId":{"type":"string"},"fieldName":{"type":"string"},"operator":{"type":"string"},"fieldValue":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}},"orderRoutingRule":{"title":"Order Routing Rule","type":"object","properties":{"_entity":{"type":"string","default":"orderRoutingRule"},"routingRuleId":{"type":"string"},"orderRoutingId":{"type":"string"},"ruleName":{"type":"string"},"statusId":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"assignmentEnumId":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"createdByUser":{"type":"string"},"createdByUserId":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/routings/{orderRoutingId}":{"get":{"tags":["routings"],"summary":"one OrderRouting (master: default)","description":"Represents configurations for routing orders, including rules and conditions for order fulfillment.","parameters":[{"schema":{"type":"string"},"name":"orderRoutingId","in":"path","required":true,"description":"Unique identifier for the order routing."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderRouting.default"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}} ``` ## store OrderRouting (master: default) > Represents configurations for routing orders, including rules and conditions for order fulfillment. ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"routings","description":"routings"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/order-routing"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"orderRouting.default.PK":{"title":"Order Routing (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"orderRouting.PK"},"orderRoutingId":{"type":"string"}}},"orderRouting.default":{"title":"Order Routing (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"orderRouting"},"orderRoutingId":{"type":"string"},"routingGroupId":{"type":"string"},"statusId":{"type":"string"},"routingName":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"description":{"type":"string"},"createdByUser":{"type":"string"},"createdByUserId":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"orderFilters":{"type":"array","items":{"$ref":"#/components/schemas/routingOrderFilter"}},"rules":{"type":"array","items":{"$ref":"#/components/schemas/orderRoutingRule"}}}},"routingOrderFilter":{"title":"Order Filter Condition","type":"object","properties":{"_entity":{"type":"string","default":"routingOrderFilter"},"orderRoutingId":{"type":"string"},"conditionSeqId":{"type":"string"},"conditionTypeEnumId":{"type":"string"},"fieldName":{"type":"string"},"operator":{"type":"string"},"fieldValue":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}},"orderRoutingRule":{"title":"Order Routing Rule","type":"object","properties":{"_entity":{"type":"string","default":"orderRoutingRule"},"routingRuleId":{"type":"string"},"orderRoutingId":{"type":"string"},"ruleName":{"type":"string"},"statusId":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"assignmentEnumId":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"createdByUser":{"type":"string"},"createdByUserId":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/routings/{orderRoutingId}":{"post":{"tags":["routings"],"summary":"store OrderRouting (master: default)","description":"Represents configurations for routing orders, including rules and conditions for order fulfillment.","parameters":[{"schema":{"type":"string"},"name":"orderRoutingId","in":"path","required":true,"description":"Unique identifier for the order routing."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderRouting.default.PK"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderRouting.default"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/orderRouting.default"}}},"required":false}}}}} ``` ## list OrderRoutingRule > Represents a rule used in order routing, defining conditions, actions, and assignment logic for order fulfillment. ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"routings","description":"routings"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/order-routing"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"orderRoutingRule":{"title":"Order Routing Rule","type":"object","properties":{"_entity":{"type":"string","default":"orderRoutingRule"},"routingRuleId":{"type":"string"},"orderRoutingId":{"type":"string"},"ruleName":{"type":"string"},"statusId":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"assignmentEnumId":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"createdByUser":{"type":"string"},"createdByUserId":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/routings/{orderRoutingId}/rules":{"get":{"tags":["routings"],"summary":"list OrderRoutingRule","description":"Represents a rule used in order routing, defining conditions, actions, and assignment logic for order fulfillment.","parameters":[{"schema":{"type":"string"},"name":"orderRoutingId","in":"path","required":true,"description":"Unique identifier for the order routing."},{"schema":{"type":"number","format":"int32"},"name":"pageIndex","in":"query","required":false,"description":"Page number to return, starting with zero"},{"schema":{"type":"number","format":"int32"},"name":"pageSize","in":"query","required":false,"description":"Number of records per page (default 100)"},{"schema":{"type":"string"},"name":"orderByField","in":"query","required":false,"description":"Field name to order by (or comma separated names)"},{"schema":{"type":"string"},"name":"pageNoLimit","in":"query","required":false,"description":"If true don't limit page size (no pagination)"},{"schema":{"type":"number","format":"int32"},"name":"dependentLevels","in":"query","required":false,"description":"Levels of dependent child records to include"},{"schema":{"type":"string","format":""},"name":"routingRuleId","in":"query","required":false,"description":"Unique identifier for the routing rule."},{"schema":{"type":"string","format":""},"name":"ruleName","in":"query","required":false,"description":"Name of the routing rule."},{"schema":{"type":"string","format":""},"name":"statusId","in":"query","required":false,"description":"Status of the routing rule."},{"schema":{"type":"number","format":"int64"},"name":"sequenceNum","in":"query","required":false,"description":"Sequence number for ordering."},{"schema":{"type":"string","format":""},"name":"assignmentEnumId","in":"query","required":false,"description":"Type of assignment for the routing rule (single/multi)."},{"schema":{"type":"string","format":"date-time"},"name":"createdDate","in":"query","required":false,"description":"Date and time when the routing rule was created."},{"schema":{"type":"string","format":""},"name":"createdByUser","in":"query","required":false,"description":"User login ID of the creator."},{"schema":{"type":"string","format":""},"name":"createdByUserId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"lastUpdatedStamp","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/orderRoutingRule"}}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}} ``` ## list OrderFilterCondition > Defines conditions used in order routing rules to filter and route orders based on specified criteria. ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"routings","description":"routings"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/order-routing"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"routingOrderFilter":{"title":"Order Filter Condition","type":"object","properties":{"_entity":{"type":"string","default":"routingOrderFilter"},"orderRoutingId":{"type":"string"},"conditionSeqId":{"type":"string"},"conditionTypeEnumId":{"type":"string"},"fieldName":{"type":"string"},"operator":{"type":"string"},"fieldValue":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/routings/{orderRoutingId}/orderFilters":{"get":{"tags":["routings"],"summary":"list OrderFilterCondition","description":"Defines conditions used in order routing rules to filter and route orders based on specified criteria.","parameters":[{"schema":{"type":"string"},"name":"orderRoutingId","in":"path","required":true,"description":"Unique identifier for the order routing."},{"schema":{"type":"number","format":"int32"},"name":"pageIndex","in":"query","required":false,"description":"Page number to return, starting with zero"},{"schema":{"type":"number","format":"int32"},"name":"pageSize","in":"query","required":false,"description":"Number of records per page (default 100)"},{"schema":{"type":"string"},"name":"orderByField","in":"query","required":false,"description":"Field name to order by (or comma separated names)"},{"schema":{"type":"string"},"name":"pageNoLimit","in":"query","required":false,"description":"If true don't limit page size (no pagination)"},{"schema":{"type":"number","format":"int32"},"name":"dependentLevels","in":"query","required":false,"description":"Levels of dependent child records to include"},{"schema":{"type":"string","format":""},"name":"conditionSeqId","in":"query","required":false,"description":"Unique identifier for the condition."},{"schema":{"type":"string","format":""},"name":"conditionTypeEnumId","in":"query","required":false,"description":"Type of condition (Filter/ Order by)"},{"schema":{"type":"string","format":""},"name":"fieldName","in":"query","required":false,"description":"Input parameter for the condition."},{"schema":{"type":"string","format":""},"name":"operator","in":"query","required":false,"description":"Operator used in the condition."},{"schema":{"type":"string","format":""},"name":"fieldValue","in":"query","required":false,"description":"Value of the condition."},{"schema":{"type":"number","format":"int64"},"name":"sequenceNum","in":"query","required":false,"description":"Sequence number for ordering."},{"schema":{"type":"string","format":"date-time"},"name":"createdDate","in":"query","required":false,"description":"Date and time when the condition was created."},{"schema":{"type":"string","format":"date-time"},"name":"lastUpdatedStamp","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/routingOrderFilter"}}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}} ``` ## store OrderFilterCondition > Defines conditions used in order routing rules to filter and route orders based on specified criteria. ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"routings","description":"routings"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/order-routing"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"routingOrderFilter.PK":{"title":"Order Filter Condition","type":"object","properties":{"_entity":{"type":"string","default":"routingOrderFilter.PK"},"orderRoutingId":{"type":"string"},"conditionSeqId":{"type":"string"}}},"routingOrderFilter":{"title":"Order Filter Condition","type":"object","properties":{"_entity":{"type":"string","default":"routingOrderFilter"},"orderRoutingId":{"type":"string"},"conditionSeqId":{"type":"string"},"conditionTypeEnumId":{"type":"string"},"fieldName":{"type":"string"},"operator":{"type":"string"},"fieldValue":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/routings/{orderRoutingId}/orderFilters":{"post":{"tags":["routings"],"summary":"store OrderFilterCondition","description":"Defines conditions used in order routing rules to filter and route orders based on specified criteria.","parameters":[{"schema":{"type":"string"},"name":"orderRoutingId","in":"path","required":true,"description":"Unique identifier for the order routing."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routingOrderFilter.PK"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/routingOrderFilter"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/routingOrderFilter"}}},"required":false}}}}} ``` ## delete OrderFilterCondition > Defines conditions used in order routing rules to filter and route orders based on specified criteria. ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"routings","description":"routings"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/order-routing"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"routingOrderFilter.PK":{"title":"Order Filter Condition","type":"object","properties":{"_entity":{"type":"string","default":"routingOrderFilter.PK"},"orderRoutingId":{"type":"string"},"conditionSeqId":{"type":"string"}}}}},"paths":{"/routings/{orderRoutingId}/orderFilters":{"delete":{"tags":["routings"],"summary":"delete OrderFilterCondition","description":"Defines conditions used in order routing rules to filter and route orders based on specified criteria.","parameters":[{"schema":{"type":"string"},"name":"orderRoutingId","in":"path","required":true,"description":"Unique identifier for the order routing."}],"responses":{"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/routingOrderFilter.PK"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/routingOrderFilter.PK"}}},"required":false}}}}} ``` ## list OrderRoutingRun > Represents the execution and results of order routing runs, including information about errors and outcomes. ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"routings","description":"routings"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/order-routing"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"routingRuns":{"title":"Order Routing Run","type":"object","properties":{"_entity":{"type":"string","default":"routingRuns"},"routingRunId":{"type":"string"},"orderRoutingId":{"type":"string"},"routingGroupId":{"type":"string"},"routingBatchId":{"type":"string"},"productStoreId":{"type":"string"},"createdByUser":{"type":"string"},"createdByUserId":{"type":"string"},"hasError":{"type":"string"},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"},"routingResult":{"type":"string"},"orderItemCount":{"type":"number","format":"int64"},"brokeredItemCount":{"type":"number","format":"int64"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/routings/{orderRoutingId}/routingRuns":{"get":{"tags":["routings"],"summary":"list OrderRoutingRun","description":"Represents the execution and results of order routing runs, including information about errors and outcomes.","parameters":[{"schema":{"type":"string"},"name":"orderRoutingId","in":"path","required":true,"description":"Unique identifier for the order routing."},{"schema":{"type":"number","format":"int32"},"name":"pageIndex","in":"query","required":false,"description":"Page number to return, starting with zero"},{"schema":{"type":"number","format":"int32"},"name":"pageSize","in":"query","required":false,"description":"Number of records per page (default 100)"},{"schema":{"type":"string"},"name":"orderByField","in":"query","required":false,"description":"Field name to order by (or comma separated names)"},{"schema":{"type":"string"},"name":"pageNoLimit","in":"query","required":false,"description":"If true don't limit page size (no pagination)"},{"schema":{"type":"number","format":"int32"},"name":"dependentLevels","in":"query","required":false,"description":"Levels of dependent child records to include"},{"schema":{"type":"string","format":""},"name":"routingRunId","in":"query","required":false,"description":"Unique identifier for the routing run."},{"schema":{"type":"string","format":""},"name":"routingGroupId","in":"query","required":false,"description":"Unique identifier for the order routing group."},{"schema":{"type":"string","format":""},"name":"routingBatchId","in":"query","required":false,"description":"Distinguishes between different routing runs initiated as part of batch processing."},{"schema":{"type":"string","format":""},"name":"productStoreId","in":"query","required":false,"description":"Unique identifier for the product store."},{"schema":{"type":"string","format":""},"name":"createdByUser","in":"query","required":false,"description":"User login ID of the creator."},{"schema":{"type":"string","format":""},"name":"createdByUserId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"hasError","in":"query","required":false,"description":"Indicator for the presence of errors."},{"schema":{"type":"string","format":"date-time"},"name":"startDate","in":"query","required":false,"description":"Start date of the routing run."},{"schema":{"type":"string","format":"date-time"},"name":"endDate","in":"query","required":false,"description":"End date of the routing run."},{"schema":{"type":"string","format":""},"name":"routingResult","in":"query","required":false,"description":"Result or outcome of the routing run."},{"schema":{"type":"number","format":"int64"},"name":"orderItemCount","in":"query","required":false,"description":"Store the attempted order item count."},{"schema":{"type":"number","format":"int64"},"name":"brokeredItemCount","in":"query","required":false,"description":"Store the brokered order item count."},{"schema":{"type":"string","format":"date-time"},"name":"lastUpdatedStamp","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/routingRuns"}}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}} ``` ## POST /routings/{orderRoutingId}/clone > clone OrderRouting ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"routings","description":"routings"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/order-routing"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.order.routing.CommonServices.cloneOrderRouting.Out":{"type":"object","properties":{"newOrderRoutingId":{"type":"string"}},"required":["newOrderRoutingId"]},"co.hotwax.order.routing.CommonServices.cloneOrderRouting.In":{"type":"object","properties":{"orderRoutingId":{"type":"string"},"newRoutingGroupId":{"type":"string"},"copyOrderRoutingRules":{"type":"boolean","description":"Parameter to check if the Order routing rule needs to be cloned.","default":"true"},"newRoutingName":{"type":"string"},"sequenceNum":{"type":"string","description":"Order routing group sequence. By default, it will be added as the last one."}},"required":["orderRoutingId","newRoutingGroupId"]}}},"paths":{"/routings/{orderRoutingId}/clone":{"post":{"tags":["routings"],"summary":"clone OrderRouting","description":null,"parameters":[{"schema":{"type":"string"},"name":"orderRoutingId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.order.routing.CommonServices.cloneOrderRouting.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.order.routing.CommonServices.cloneOrderRouting.In"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/co.hotwax.order.routing.CommonServices.cloneOrderRouting.In"}}},"required":true}}}}} ``` ## get OrderFilterSql > This service will return the eligible orders sql for order routing ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"routings","description":"routings"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/order-routing"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.order.routing.OrderRoutingServices.getOrderFilterSql.Out":{"type":"object","properties":{"statusId":{"type":"string"},"sql":{"type":"string"}}}}},"paths":{"/routings/{orderRoutingId}/sql":{"get":{"tags":["routings"],"summary":"get OrderFilterSql","description":"This service will return the eligible orders sql for order routing","parameters":[{"schema":{"type":"string"},"name":"orderRoutingId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.order.routing.OrderRoutingServices.getOrderFilterSql.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}} ``` ## get RoutingOrderCount > Return the eligible order item count for the Order Routing ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"routings","description":"routings"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/order-routing"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.order.routing.OrderRoutingServices.getRoutingOrderCount.Out":{"type":"object","properties":{"orderItemCount":{"type":"integer","format":"int64"}}}}},"paths":{"/routings/{orderRoutingId}/orderCount":{"get":{"tags":["routings"],"summary":"get RoutingOrderCount","description":"Return the eligible order item count for the Order Routing","parameters":[{"schema":{"type":"string"},"name":"orderRoutingId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.order.routing.OrderRoutingServices.getRoutingOrderCount.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.hotwax.co/documents/integrate-with-hotwax/components/order-routing/routings.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.