# Groups groups ## list OrderRoutingGroup > Represents a group or category used for organizing and managing order routing configurations. ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"groups","description":"groups"}],"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":{"orderRoutingGroup":{"title":"Order Routing Group","type":"object","properties":{"_entity":{"type":"string","default":"orderRoutingGroup"},"routingGroupId":{"type":"string"},"productStoreId":{"type":"string"},"groupName":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"jobName":{"type":"string"},"description":{"type":"string"},"createdByUserId":{"type":"string"},"createdByUser":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastModifiedDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/groups":{"get":{"tags":["groups"],"summary":"list OrderRoutingGroup","description":"Represents a group or category used for organizing and managing order routing configurations.","parameters":[{"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":"routingGroupId","in":"query","required":false,"description":"Unique identifier for the routing group"},{"schema":{"type":"string","format":""},"name":"productStoreId","in":"query","required":false,"description":"Unique identifier for the product store"},{"schema":{"type":"string","format":""},"name":"groupName","in":"query","required":false,"description":"Name of the routing group."},{"schema":{"type":"number","format":"int64"},"name":"sequenceNum","in":"query","required":false,"description":"Sequence number for ordering."},{"schema":{"type":"string","format":""},"name":"jobName","in":"query","required":false,"description":"moqui.service.job.Service reference"},{"schema":{"type":"string","format":""},"name":"description","in":"query","required":false,"description":"Description or additional information about the routing group."},{"schema":{"type":"string","format":""},"name":"createdByUserId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"createdByUser","in":"query","required":false,"description":"User login ID of the creator"},{"schema":{"type":"string","format":"date-time"},"name":"createdDate","in":"query","required":false,"description":"Date and time when the routing group was created"},{"schema":{"type":"string","format":"date-time"},"name":"lastModifiedDate","in":"query","required":false,"description":"Date and time when the routing group was updated"},{"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/orderRoutingGroup"}}}}},"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 OrderRoutingGroup > Represents a group or category used for organizing and managing order routing configurations. ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"groups","description":"groups"}],"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":{"orderRoutingGroup.PK":{"title":"Order Routing Group","type":"object","properties":{"_entity":{"type":"string","default":"orderRoutingGroup.PK"},"routingGroupId":{"type":"string"}}},"orderRoutingGroup":{"title":"Order Routing Group","type":"object","properties":{"_entity":{"type":"string","default":"orderRoutingGroup"},"routingGroupId":{"type":"string"},"productStoreId":{"type":"string"},"groupName":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"jobName":{"type":"string"},"description":{"type":"string"},"createdByUserId":{"type":"string"},"createdByUser":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastModifiedDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/groups":{"post":{"tags":["groups"],"summary":"store OrderRoutingGroup","description":"Represents a group or category used for organizing and managing order routing configurations.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderRoutingGroup.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/orderRoutingGroup"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/orderRoutingGroup"}}},"required":false}}}}} ``` ## one OrderRoutingGroup (master: default) > Represents a group or category used for organizing and managing order routing configurations. ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"groups","description":"groups"}],"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":{"orderRoutingGroup.default":{"title":"Order Routing Group (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"orderRoutingGroup"},"routingGroupId":{"type":"string"},"productStoreId":{"type":"string"},"groupName":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"jobName":{"type":"string"},"description":{"type":"string"},"createdByUserId":{"type":"string"},"createdByUser":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastModifiedDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"routings":{"type":"array","items":{"$ref":"#/components/schemas/orderRouting"}}}},"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":{"/groups/{routingGroupId}":{"get":{"tags":["groups"],"summary":"one OrderRoutingGroup (master: default)","description":"Represents a group or category used for organizing and managing order routing configurations.","parameters":[{"schema":{"type":"string"},"name":"routingGroupId","in":"path","required":true,"description":"Unique identifier for the routing group"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderRoutingGroup.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 OrderRoutingGroup (master: default) > Represents a group or category used for organizing and managing order routing configurations. ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"groups","description":"groups"}],"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":{"orderRoutingGroup.default.PK":{"title":"Order Routing Group (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"orderRoutingGroup.PK"},"routingGroupId":{"type":"string"}}},"orderRoutingGroup.default":{"title":"Order Routing Group (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"orderRoutingGroup"},"routingGroupId":{"type":"string"},"productStoreId":{"type":"string"},"groupName":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"jobName":{"type":"string"},"description":{"type":"string"},"createdByUserId":{"type":"string"},"createdByUser":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastModifiedDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"routings":{"type":"array","items":{"$ref":"#/components/schemas/orderRouting"}}}},"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":{"/groups/{routingGroupId}":{"post":{"tags":["groups"],"summary":"store OrderRoutingGroup (master: default)","description":"Represents a group or category used for organizing and managing order routing configurations.","parameters":[{"schema":{"type":"string"},"name":"routingGroupId","in":"path","required":true,"description":"Unique identifier for the routing group"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderRoutingGroup.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/orderRoutingGroup.default"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/orderRoutingGroup.default"}}},"required":false}}}}} ``` ## DELETE /groups/{routingGroupId} > delete OrderRoutingGroup ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"groups","description":"groups"}],"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"}}},"paths":{"/groups/{routingGroupId}":{"delete":{"tags":["groups"],"summary":"delete OrderRoutingGroup","description":null,"parameters":[{"schema":{"type":"string"},"name":"routingGroupId","in":"path","required":true,"description":null}],"responses":{"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}} ``` ## scheduleNow OrderRoutingGroup > 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. ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"groups","description":"groups"}],"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.scheduleNowOrderRoutingGroup.Out":{"type":"object","properties":{"jobRunId":{"type":"string"}}}}},"paths":{"/groups/{routingGroupId}/runNow":{"post":{"tags":["groups"],"summary":"scheduleNow OrderRoutingGroup","description":"This service schedules the routing process for an Order Routing Group.\n If the routing group schedule is not configured, the service will first create a schedule with a \"pause\" status (i.e., pause = \"Y\"),\n then service will trigger the framework to schedule the order routing group for immediate processing.\n The service utilizes the ScheduleJob functionality to initiate the process.\n Parameters for this execution are retrieved from the ServiceJobParameter.\n It's important to note that this service is designed to handle Order Routing Groups and not intended for scheduling individual orders.","parameters":[{"schema":{"type":"string"},"name":"routingGroupId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.order.routing.OrderRoutingServices.scheduleNowOrderRoutingGroup.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}} ``` ## run OrderRoutingGroup > 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. ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"groups","description":"groups"}],"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.runOrderRoutingGroup.Out":{"type":"object","properties":{"attemptedItemCount":{"type":"integer","format":"int64"},"brokeredItemCount":{"type":"integer","format":"int64"}}},"co.hotwax.order.routing.OrderRoutingServices.runOrderRoutingGroup.In":{"type":"object","properties":{"routingGroupId":{"type":"string"},"orderRoutingId":{"type":"string"},"routingRuleId":{"type":"string"},"productStoreId":{"type":"string"},"orderId":{"type":"string"},"shipGroupSeqId":{"type":"string"},"changeReasonEnumId":{"type":"string"},"testDriveSessionId":{"type":"string","description":"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."}},"required":["routingGroupId","productStoreId"]}}},"paths":{"/groups/{routingGroupId}/run":{"post":{"tags":["groups"],"summary":"run OrderRoutingGroup","description":"The action initiates the processing or execution sequence for an Order Routing within the system.\n 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.\n This service is designed to retrieve active order routings for a specified OrderRoutingGroup based on their sequence number.\n 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.","parameters":[{"schema":{"type":"string"},"name":"routingGroupId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.order.routing.OrderRoutingServices.runOrderRoutingGroup.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.OrderRoutingServices.runOrderRoutingGroup.In"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/co.hotwax.order.routing.OrderRoutingServices.runOrderRoutingGroup.In"}}},"required":true}}}}} ``` ## GET /groups/{routingGroupId}/schedule > get OrderRoutingGroupSchedule ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"groups","description":"groups"}],"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.getOrderRoutingGroupSchedule.Out":{"type":"object","properties":{"schedule":{"type":"object","properties":{"jobName":{"type":"string"},"description":{"type":"string"},"serviceName":{"type":"string"},"transactionTimeout":{"type":"integer","format":"int64"},"topic":{"type":"string"},"localOnly":{"type":"string"},"cronExpression":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"},"repeatCount":{"type":"integer","format":"int64"},"paused":{"type":"string"},"expireLockTime":{"type":"integer","format":"int64"},"minRetryTime":{"type":"integer","format":"int64"},"priority":{"type":"integer","format":"int64"},"parentJobName":{"type":"string"},"jobTypeEnumId":{"type":"string"},"permissionGroupId":{"type":"string"},"instanceOfProductId":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}}}},"paths":{"/groups/{routingGroupId}/schedule":{"get":{"tags":["groups"],"summary":"get OrderRoutingGroupSchedule","description":null,"parameters":[{"schema":{"type":"string"},"name":"routingGroupId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.order.routing.OrderRoutingServices.getOrderRoutingGroupSchedule.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}} ``` ## POST /groups/{routingGroupId}/schedule > store OrderRoutingGroupSchedule ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"groups","description":"groups"}],"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.storeOrderRoutingGroupSchedule.Out":{"type":"object","properties":{"jobName":{"type":"string"}}},"co.hotwax.order.routing.OrderRoutingServices.storeOrderRoutingGroupSchedule.In":{"type":"object","properties":{"routingGroupId":{"type":"string"},"transactionTimeout":{"type":"integer","format":"int64"},"topic":{"type":"string"},"localOnly":{"type":"string"},"cronExpression":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"},"repeatCount":{"type":"integer","format":"int64"},"paused":{"type":"string"},"expireLockTime":{"type":"integer","format":"int64"},"minRetryTime":{"type":"integer","format":"int64"},"priority":{"type":"integer","format":"int64"},"parentJobName":{"type":"string"},"jobTypeEnumId":{"type":"string"},"permissionGroupId":{"type":"string"},"instanceOfProductId":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"}},"required":["routingGroupId"]}}},"paths":{"/groups/{routingGroupId}/schedule":{"post":{"tags":["groups"],"summary":"store OrderRoutingGroupSchedule","description":null,"parameters":[{"schema":{"type":"string"},"name":"routingGroupId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.order.routing.OrderRoutingServices.storeOrderRoutingGroupSchedule.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.OrderRoutingServices.storeOrderRoutingGroupSchedule.In"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/co.hotwax.order.routing.OrderRoutingServices.storeOrderRoutingGroupSchedule.In"}}},"required":true}}}}} ``` ## POST /groups/{routingGroupId}/clone > clone OrderRoutingGroup ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"groups","description":"groups"}],"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.cloneOrderRoutingGroup.Out":{"type":"object","properties":{"newRoutingGroupId":{"type":"string"}},"required":["newRoutingGroupId"]},"co.hotwax.order.routing.CommonServices.cloneOrderRoutingGroup.In":{"type":"object","properties":{"routingGroupId":{"type":"string"},"newGroupName":{"type":"string"},"sequenceNum":{"type":"string","description":"Order routing group sequence. By default, it will be added as the last one."},"copyOrderRoutings":{"type":"boolean","description":"Parameter to check if the Order routing needs to be cloned.","default":"true"},"copyOrderRoutingRules":{"type":"boolean","description":"Parameter to check if the Order routing rule needs to be cloned, works only if copyOrderRoutings set to true.","default":"true"}},"required":["routingGroupId"]}}},"paths":{"/groups/{routingGroupId}/clone":{"post":{"tags":["groups"],"summary":"clone OrderRoutingGroup","description":null,"parameters":[{"schema":{"type":"string"},"name":"routingGroupId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.order.routing.CommonServices.cloneOrderRoutingGroup.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.cloneOrderRoutingGroup.In"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/co.hotwax.order.routing.CommonServices.cloneOrderRoutingGroup.In"}}},"required":true}}}}} ``` ## list 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":"groups","description":"groups"}],"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":{"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":{"/groups/{routingGroupId}/routings":{"get":{"tags":["groups"],"summary":"list OrderRouting","description":"Represents configurations for routing orders, including rules and conditions for order fulfillment.","parameters":[{"schema":{"type":"string"},"name":"routingGroupId","in":"path","required":true,"description":"Unique identifier for the routing group"},{"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":"orderRoutingId","in":"query","required":false,"description":"Unique identifier for the order routing."},{"schema":{"type":"string","format":""},"name":"statusId","in":"query","required":false,"description":"Status identifier for the order routing."},{"schema":{"type":"string","format":""},"name":"routingName","in":"query","required":false,"description":"Name or identifier for the order routing."},{"schema":{"type":"number","format":"int64"},"name":"sequenceNum","in":"query","required":false,"description":"Sequence number for ordering."},{"schema":{"type":"string","format":""},"name":"description","in":"query","required":false,"description":"Description or additional information about the order routing."},{"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":"createdDate","in":"query","required":false,"description":"Date and time when the order routing 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/orderRouting"}}}}},"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 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":"groups","description":"groups"}],"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":{"/groups/{routingGroupId}/routingRuns":{"get":{"tags":["groups"],"summary":"list OrderRoutingRun","description":"Represents the execution and results of order routing runs, including information about errors and outcomes.","parameters":[{"schema":{"type":"string"},"name":"routingGroupId","in":"path","required":true,"description":"Unique identifier for the order routing group."},{"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":"orderRoutingId","in":"query","required":false,"description":"Unique identifier for the order routing."},{"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"}}}}}} ``` ## one OrderRoutingGroup (master: raw) > Represents a group or category used for organizing and managing order routing configurations. ```json {"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"tags":[{"name":"groups","description":"groups"}],"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":{"orderRoutingGroup.raw":{"title":"Order Routing Group (Master: raw)","type":"object","properties":{"_entity":{"type":"string","default":"orderRoutingGroup"},"routingGroupId":{"type":"string"},"productStoreId":{"type":"string"},"groupName":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"jobName":{"type":"string"},"description":{"type":"string"},"createdByUserId":{"type":"string"},"createdByUser":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastModifiedDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"routings":{"type":"array","items":{"$ref":"#/components/schemas/orderRouting"}},"schedule":{"$ref":"#/components/schemas/moqui.service.job.ServiceJob"}}},"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"}}},"moqui.service.job.ServiceJob":{"title":"Service Job","type":"object","properties":{"_entity":{"type":"string","default":"moqui.service.job.ServiceJob"},"jobName":{"type":"string"},"description":{"type":"string"},"serviceName":{"type":"string"},"transactionTimeout":{"type":"number","format":"int64"},"topic":{"type":"string"},"localOnly":{"type":"string"},"cronExpression":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"},"repeatCount":{"type":"number","format":"int64"},"paused":{"type":"string"},"expireLockTime":{"type":"number","format":"int64"},"minRetryTime":{"type":"number","format":"int64"},"priority":{"type":"number","format":"int64"},"parentJobName":{"type":"string"},"jobTypeEnumId":{"type":"string"},"permissionGroupId":{"type":"string"},"instanceOfProductId":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/groups/{routingGroupId}/raw":{"get":{"tags":["groups"],"summary":"one OrderRoutingGroup (master: raw)","description":"Represents a group or category used for organizing and managing order routing configurations.","parameters":[{"schema":{"type":"string"},"name":"routingGroupId","in":"path","required":true,"description":"Unique identifier for the routing group"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderRoutingGroup.raw"}}}},"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"}}}}}} ``` --- # 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/groups.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.