# Models

## The co.hotwax.auth.AuthServices.loginUser.In object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.auth.AuthServices.loginUser.In":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"},"token":{"type":"string"}}}}}}
```

## The co.hotwax.auth.AuthServices.loginUser.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.auth.AuthServices.loginUser.Out":{"type":"object","properties":{"token":{"type":"string"},"expirationTime":{"type":"string"},"api_key":{"type":"string"}}}}}}
```

## The co.hotwax.util.UserServices.getUserProfile.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.util.UserServices.getUserProfile.Out":{"type":"object","properties":{"userId":{"type":"string"},"username":{"type":"string"},"userFullName":{"type":"string"},"timeZone":{"type":"string"},"locale":{"type":"string"},"emailAddress":{"type":"string"},"preferences":{"type":"object","properties":{"userId":{"type":"string"},"preferenceKey":{"type":"string"},"preferenceValue":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}},"partyId":{"type":"string"}}}}}}
```

## The co.hotwax.util.UtilityServices.getAvailableTimeZones.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.util.UtilityServices.getAvailableTimeZones.Out":{"type":"object","properties":{"timeZones":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"offset":{"type":"string"}}}}}}}}}
```

## The org.apache.ofbiz.product.store.ProductStore object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"org.apache.ofbiz.product.store.ProductStore":{"title":"Product Store","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.product.store.ProductStore"},"productStoreId":{"type":"string"},"primaryStoreGroupId":{"type":"string"},"storeName":{"type":"string"},"companyName":{"type":"string"},"title":{"type":"string"},"subtitle":{"type":"string"},"payToPartyId":{"type":"string"},"daysToCancelNonPay":{"type":"number","format":"int64"},"manualAuthIsCapture":{"type":"string"},"prorateShipping":{"type":"string"},"prorateTaxes":{"type":"string"},"viewCartOnAdd":{"type":"string"},"autoSaveCart":{"type":"string"},"autoApproveReviews":{"type":"string"},"isDemoStore":{"type":"string"},"isImmediatelyFulfilled":{"type":"string"},"inventoryFacilityId":{"type":"string"},"oneInventoryFacility":{"type":"string"},"checkInventory":{"type":"string"},"reserveInventory":{"type":"string"},"reserveOrderEnumId":{"type":"string"},"requireInventory":{"type":"string"},"balanceResOnOrderCreation":{"type":"string"},"requirementMethodEnumId":{"type":"string"},"orderNumberPrefix":{"type":"string"},"defaultLocaleString":{"type":"string"},"defaultCurrencyUomId":{"type":"string"},"defaultTimeZoneString":{"type":"string"},"defaultSalesChannelEnumId":{"type":"string"},"allowPassword":{"type":"string"},"defaultPassword":{"type":"string"},"explodeOrderItems":{"type":"string"},"checkGcBalance":{"type":"string"},"retryFailedAuths":{"type":"string"},"headerApprovedStatus":{"type":"string"},"itemApprovedStatus":{"type":"string"},"digitalItemApprovedStatus":{"type":"string"},"headerDeclinedStatus":{"type":"string"},"itemDeclinedStatus":{"type":"string"},"headerCancelStatus":{"type":"string"},"itemCancelStatus":{"type":"string"},"authDeclinedMessage":{"type":"string"},"authFraudMessage":{"type":"string"},"authErrorMessage":{"type":"string"},"visualThemeId":{"type":"string"},"storeCreditAccountEnumId":{"type":"string"},"usePrimaryEmailUsername":{"type":"string"},"requireCustomerRole":{"type":"string"},"autoInvoiceDigitalItems":{"type":"string"},"reqShipAddrForDigItems":{"type":"string"},"showCheckoutGiftOptions":{"type":"string"},"selectPaymentTypePerItem":{"type":"string"},"showPricesWithVatTax":{"type":"string"},"showTaxIsExempt":{"type":"string"},"vatTaxAuthGeoId":{"type":"string"},"vatTaxAuthPartyId":{"type":"string"},"enableAutoSuggestionList":{"type":"string"},"enableDigProdUpload":{"type":"string"},"prodSearchExcludeVariants":{"type":"string"},"digProdUploadCategoryId":{"type":"string"},"autoOrderCcTryExp":{"type":"string"},"autoOrderCcTryOtherCards":{"type":"string"},"autoOrderCcTryLaterNsf":{"type":"string"},"autoOrderCcTryLaterMax":{"type":"number","format":"int64"},"storeCreditValidDays":{"type":"number","format":"int64"},"autoApproveInvoice":{"type":"string"},"autoApproveOrder":{"type":"string"},"shipIfCaptureFails":{"type":"string"},"setOwnerUponIssuance":{"type":"string"},"reqReturnInventoryReceive":{"type":"string"},"addToCartRemoveIncompat":{"type":"string"},"addToCartReplaceUpsell":{"type":"string"},"splitPayPrefPerShpGrp":{"type":"string"},"managedByLot":{"type":"string"},"showOutOfStockProducts":{"type":"string"},"orderDecimalQuantity":{"type":"string"},"allowComment":{"type":"string"},"oldStyleSheet":{"type":"string"},"oldHeaderLogo":{"type":"string"},"oldHeaderMiddleBackground":{"type":"string"},"oldHeaderRightBackground":{"type":"string"},"catalogUrlMountPoint":{"type":"string"},"restockingFeePercentage":{"type":"number"},"capturePmntsOnOrdApproval":{"type":"string"},"termTypeId":{"type":"string"},"autoSetFacility":{"type":"string"},"enableExternalPromotion":{"type":"string"},"daysToReturn":{"type":"number","format":"int64"},"restockingFeeFixed":{"type":"number"},"autoAcceptReturn":{"type":"string"},"externalId":{"type":"string"},"allowSplit":{"type":"string"},"storeDomain":{"type":"string"},"productIdentifierEnumId":{"type":"string"},"enablePreOrderAutoReleasing":{"type":"string"},"enableBrokering":{"type":"string"},"storeLogoImageUrl":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}}}
```

## The userSessions object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"userSessions":{"title":"User Session","type":"object","properties":{"_entity":{"type":"string","default":"userSessions"},"userSessionId":{"type":"string"},"userId":{"type":"string"},"sessionTypeEnumId":{"type":"string"},"productStoreId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"},"comments":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}}}
```

## The userSessions.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"userSessions.PK":{"title":"User Session","type":"object","properties":{"_entity":{"type":"string","default":"userSessions.PK"},"userSessionId":{"type":"string"}}}}}}
```

## The co.hotwax.product.store.ProductStoreShipmentMethView object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.product.store.ProductStoreShipmentMethView":{"title":"Product Store Shipment Meth View","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.product.store.ProductStoreShipmentMethView"},"productStoreShipMethId":{"type":"string"},"productStoreId":{"type":"string"},"shipmentMethodTypeId":{"type":"string"},"partyId":{"type":"string"},"roleTypeId":{"type":"string"},"companyPartyId":{"type":"string"},"minWeight":{"type":"number"},"maxWeight":{"type":"number"},"minSize":{"type":"number"},"maxSize":{"type":"number"},"minTotal":{"type":"number"},"maxTotal":{"type":"number"},"allowUspsAddr":{"type":"string"},"requireUspsAddr":{"type":"string"},"allowCompanyAddr":{"type":"string"},"requireCompanyAddr":{"type":"string"},"includeNoChargeItems":{"type":"string"},"includeFeatureGroup":{"type":"string"},"excludeFeatureGroup":{"type":"string"},"includeGeoId":{"type":"string"},"excludeGeoId":{"type":"string"},"serviceName":{"type":"string"},"configProps":{"type":"string"},"shipmentCustomMethodId":{"type":"string"},"shipmentGatewayConfigId":{"type":"string"},"sequenceNumber":{"type":"number","format":"int64"},"allowancePercent":{"type":"number"},"minimumPrice":{"type":"number"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"},"isShippingWeightRequired":{"type":"string"},"isTrackingRequired":{"type":"string"},"description":{"type":"string"},"parentTypeId":{"type":"string"}}}}}}
```

## The co.hotwax.facility.ProductStoreAndFacilityGroup object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.facility.ProductStoreAndFacilityGroup":{"title":"Product Store And Facility Group","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.facility.ProductStoreAndFacilityGroup"},"productStoreId":{"type":"string"},"facilityGroupId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"},"sequenceNumber":{"type":"number","format":"int64"},"facilityGroupTypeId":{"type":"string"},"primaryParentGroupId":{"type":"string"},"facilityGroupName":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The co.hotwax.common.status.StatusItemAndType object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.common.status.StatusItemAndType":{"title":"Status Item And Type","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.common.status.StatusItemAndType"},"typeDescription":{"type":"string"},"statusId":{"type":"string"},"statusTypeId":{"type":"string"},"statusCode":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"description":{"type":"string"},"statusAge":{"type":"number","format":"int64"},"parentTypeId":{"type":"string"}}}}}}
```

## The moqui.basic.EnumerationAndType object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"moqui.basic.EnumerationAndType":{"title":"Enumeration And Type","type":"object","properties":{"_entity":{"type":"string","default":"moqui.basic.EnumerationAndType"},"typeDescription":{"type":"string"},"enumId":{"type":"string"},"enumTypeId":{"type":"string"},"parentEnumId":{"type":"string"},"enumCode":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"description":{"type":"string"},"optionValue":{"type":"string"},"optionIndicator":{"type":"string"},"relatedEnumId":{"type":"string"},"relatedEnumTypeId":{"type":"string"},"statusFlowId":{"type":"string"},"enumName":{"type":"string"},"primaryEnumerationGroupId":{"type":"string"}}}}}}
```

## The co.hotwax.common.enum.EnumerationAndType object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.common.enum.EnumerationAndType":{"title":"Enumeration And Type","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.common.enum.EnumerationAndType"},"typeDescription":{"type":"string"},"enumId":{"type":"string"},"enumTypeId":{"type":"string"},"parentEnumId":{"type":"string"},"enumCode":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"description":{"type":"string"},"optionValue":{"type":"string"},"optionIndicator":{"type":"string"},"relatedEnumId":{"type":"string"},"relatedEnumTypeId":{"type":"string"},"statusFlowId":{"type":"string"},"enumName":{"type":"string"},"primaryEnumerationGroupId":{"type":"string"},"parentTypeId":{"type":"string"}}}}}}
```

## The co.hotwax.facility.FacilityAndType object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.facility.FacilityAndType":{"title":"Facility And Type","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.facility.FacilityAndType"},"typeDescription":{"type":"string"},"facilityId":{"type":"string"},"facilityTypeId":{"type":"string"},"parentFacilityId":{"type":"string"},"ownerPartyId":{"type":"string"},"defaultInventoryItemTypeId":{"type":"string"},"facilityName":{"type":"string"},"primaryFacilityGroupId":{"type":"string"},"oldSquareFootage":{"type":"number","format":"int64"},"facilitySize":{"type":"number"},"facilitySizeUomId":{"type":"string"},"productStoreId":{"type":"string"},"defaultDaysToShip":{"type":"number","format":"int64"},"openedDate":{"type":"string","format":"date-time"},"closedDate":{"type":"string","format":"date-time"},"description":{"type":"string"},"defaultDimensionUomId":{"type":"string"},"defaultWeightUomId":{"type":"string"},"geoPointId":{"type":"string"},"externalId":{"type":"string"},"openTime":{"type":"string"},"closeTime":{"type":"string"},"facilityTimeZone":{"type":"string"},"maximumOrderLimit":{"type":"number","format":"int64"},"postalCode":{"type":"string"},"parentTypeId":{"type":"string"},"hasTable":{"type":"string"}}}}}}
```

## The moqui.service.job.ServiceJobRun object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"moqui.service.job.ServiceJobRun":{"title":"Service Job Run","type":"object","properties":{"_entity":{"type":"string","default":"moqui.service.job.ServiceJobRun"},"jobRunId":{"type":"string"},"jobName":{"type":"string"},"userId":{"type":"string"},"parameters":{"type":"string"},"results":{"type":"string"},"messages":{"type":"string"},"hasError":{"type":"string"},"errors":{"type":"string"},"hostAddress":{"type":"string"},"hostName":{"type":"string"},"runThread":{"type":"string"},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}}}
```

## The moqui.service.job.ServiceJobRunLock object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"moqui.service.job.ServiceJobRunLock":{"title":"Service Job Run Lock","type":"object","properties":{"_entity":{"type":"string","default":"moqui.service.job.ServiceJobRunLock"},"jobName":{"type":"string"},"jobRunId":{"type":"string"},"lastRunTime":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}}}
```

## The orderRoutingGroup object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"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"}}}}}}
```

## The orderRoutingGroup.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"orderRoutingGroup.PK":{"title":"Order Routing Group","type":"object","properties":{"_entity":{"type":"string","default":"orderRoutingGroup.PK"},"routingGroupId":{"type":"string"}}}}}}
```

## The orderRoutingGroup.default object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"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"}}}}}}
```

## The orderRouting object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"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"}}}}}}
```

## The orderRoutingGroup.default.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"orderRoutingGroup.default.PK":{"title":"Order Routing Group (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"orderRoutingGroup.PK"},"routingGroupId":{"type":"string"}}}}}}
```

## The co.hotwax.order.routing.OrderRoutingServices.scheduleNowOrderRoutingGroup.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.order.routing.OrderRoutingServices.scheduleNowOrderRoutingGroup.Out":{"type":"object","properties":{"jobRunId":{"type":"string"}}}}}}
```

## The co.hotwax.order.routing.OrderRoutingServices.runOrderRoutingGroup.In object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"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"]}}}}
```

## The co.hotwax.order.routing.OrderRoutingServices.runOrderRoutingGroup.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.order.routing.OrderRoutingServices.runOrderRoutingGroup.Out":{"type":"object","properties":{"attemptedItemCount":{"type":"integer","format":"int64"},"brokeredItemCount":{"type":"integer","format":"int64"}}}}}}
```

## The co.hotwax.order.routing.OrderRoutingServices.getOrderRoutingGroupSchedule.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"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"}}}}}}}}
```

## The co.hotwax.order.routing.OrderRoutingServices.storeOrderRoutingGroupSchedule.In object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"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"]}}}}
```

## The co.hotwax.order.routing.OrderRoutingServices.storeOrderRoutingGroupSchedule.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.order.routing.OrderRoutingServices.storeOrderRoutingGroupSchedule.Out":{"type":"object","properties":{"jobName":{"type":"string"}}}}}}
```

## The co.hotwax.order.routing.CommonServices.cloneOrderRoutingGroup.In object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"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"]}}}}
```

## The co.hotwax.order.routing.CommonServices.cloneOrderRoutingGroup.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.order.routing.CommonServices.cloneOrderRoutingGroup.Out":{"type":"object","properties":{"newRoutingGroupId":{"type":"string"}},"required":["newRoutingGroupId"]}}}}
```

## The routingRuns object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"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"}}}}}}
```

## The orderRoutingGroup.raw object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"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"}}}}}}
```

## The moqui.service.job.ServiceJob object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"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"}}}}}}
```

## The orderRouting.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"orderRouting.PK":{"title":"Order Routing","type":"object","properties":{"_entity":{"type":"string","default":"orderRouting.PK"},"orderRoutingId":{"type":"string"}}}}}}
```

## The orderRouting.default object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"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"}}}}}}
```

## The routingOrderFilter object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"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"}}}}}}
```

## The enums object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"enums":{"title":"Enumeration","type":"object","properties":{"_entity":{"type":"string","default":"enums"},"enumId":{"type":"string"},"enumTypeId":{"type":"string"},"parentEnumId":{"type":"string"},"enumCode":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"description":{"type":"string"},"optionValue":{"type":"string"},"optionIndicator":{"type":"string"},"relatedEnumId":{"type":"string"},"relatedEnumTypeId":{"type":"string"},"statusFlowId":{"type":"string"},"enumName":{"type":"string"},"primaryEnumerationGroupId":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}}}
```

## The orderRoutingRule object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"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"}}}}}}
```

## The orderRouting.default.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"orderRouting.default.PK":{"title":"Order Routing (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"orderRouting.PK"},"orderRoutingId":{"type":"string"}}}}}}
```

## The routingOrderFilter.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"routingOrderFilter.PK":{"title":"Order Filter Condition","type":"object","properties":{"_entity":{"type":"string","default":"routingOrderFilter.PK"},"orderRoutingId":{"type":"string"},"conditionSeqId":{"type":"string"}}}}}}
```

## The co.hotwax.order.routing.CommonServices.cloneOrderRouting.In object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"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"]}}}}
```

## The co.hotwax.order.routing.CommonServices.cloneOrderRouting.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.order.routing.CommonServices.cloneOrderRouting.Out":{"type":"object","properties":{"newOrderRoutingId":{"type":"string"}},"required":["newOrderRoutingId"]}}}}
```

## The co.hotwax.order.routing.OrderRoutingServices.getOrderFilterSql.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.order.routing.OrderRoutingServices.getOrderFilterSql.Out":{"type":"object","properties":{"statusId":{"type":"string"},"sql":{"type":"string"}}}}}}
```

## The co.hotwax.order.routing.OrderRoutingServices.getRoutingOrderCount.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.order.routing.OrderRoutingServices.getRoutingOrderCount.Out":{"type":"object","properties":{"orderItemCount":{"type":"integer","format":"int64"}}}}}}
```

## The orderRoutingRule.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"orderRoutingRule.PK":{"title":"Order Routing Rule","type":"object","properties":{"_entity":{"type":"string","default":"orderRoutingRule.PK"},"routingRuleId":{"type":"string"}}}}}}
```

## The orderRoutingRule.default object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"orderRoutingRule.default":{"title":"Order Routing Rule (Master: default)","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"},"inventoryFilters":{"type":"array","items":{"$ref":"#/components/schemas/routingRuleInvCondition"}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/routingRuleAction"}},"assignment":{"$ref":"#/components/schemas/enums"}}},"routingRuleInvCondition":{"title":"Order Routing Rule Inv Cond","type":"object","properties":{"_entity":{"type":"string","default":"routingRuleInvCondition"},"routingRuleId":{"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"}}},"routingRuleAction":{"title":"Order Routing Rule Action","type":"object","properties":{"_entity":{"type":"string","default":"routingRuleAction"},"routingRuleId":{"type":"string"},"actionSeqId":{"type":"string"},"actionTypeEnumId":{"type":"string"},"actionValue":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}},"enums":{"title":"Enumeration","type":"object","properties":{"_entity":{"type":"string","default":"enums"},"enumId":{"type":"string"},"enumTypeId":{"type":"string"},"parentEnumId":{"type":"string"},"enumCode":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"description":{"type":"string"},"optionValue":{"type":"string"},"optionIndicator":{"type":"string"},"relatedEnumId":{"type":"string"},"relatedEnumTypeId":{"type":"string"},"statusFlowId":{"type":"string"},"enumName":{"type":"string"},"primaryEnumerationGroupId":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}}}
```

## The routingRuleInvCondition object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"routingRuleInvCondition":{"title":"Order Routing Rule Inv Cond","type":"object","properties":{"_entity":{"type":"string","default":"routingRuleInvCondition"},"routingRuleId":{"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"}}}}}}
```

## The routingRuleAction object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"routingRuleAction":{"title":"Order Routing Rule Action","type":"object","properties":{"_entity":{"type":"string","default":"routingRuleAction"},"routingRuleId":{"type":"string"},"actionSeqId":{"type":"string"},"actionTypeEnumId":{"type":"string"},"actionValue":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}}}
```

## The orderRoutingRule.default.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"orderRoutingRule.default.PK":{"title":"Order Routing Rule (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"orderRoutingRule.PK"},"routingRuleId":{"type":"string"}}}}}}
```

## The routingRuleInvCondition.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"routingRuleInvCondition.PK":{"title":"Order Routing Rule Inv Cond","type":"object","properties":{"_entity":{"type":"string","default":"routingRuleInvCondition.PK"},"routingRuleId":{"type":"string"},"conditionSeqId":{"type":"string"}}}}}}
```

## The routingRuleAction.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"routingRuleAction.PK":{"title":"Order Routing Rule Action","type":"object","properties":{"_entity":{"type":"string","default":"routingRuleAction.PK"},"routingRuleId":{"type":"string"},"actionSeqId":{"type":"string"}}}}}}
```

## The co.hotwax.order.routing.CommonServices.cloneOrderRoutingRule.In object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.order.routing.CommonServices.cloneOrderRoutingRule.In":{"type":"object","properties":{"routingRuleId":{"type":"string"},"newOrderRoutingId":{"type":"string"},"newRuleName":{"type":"string"},"sequenceNum":{"type":"string","description":"Order routing group sequence. By default, it will be added as the last one."}},"required":["routingRuleId","newOrderRoutingId"]}}}}
```

## The co.hotwax.order.routing.CommonServices.cloneOrderRoutingRule.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.order.routing.CommonServices.cloneOrderRoutingRule.Out":{"type":"object","properties":{"newRoutingRuleId":{"type":"string"}},"required":["newRoutingRuleId"]}}}}
```

## The co.hotwax.order.routing.OrderRoutingServices.getOrderRoutingRuleSql.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.order.routing.OrderRoutingServices.getOrderRoutingRuleSql.Out":{"type":"object","properties":{"statusId":{"type":"string"},"sql":{"type":"string"}}}}}}
```

## The co.hotwax.order.routing.OrderRoutingServices.rejectOrderItems.In object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.order.routing.OrderRoutingServices.rejectOrderItems.In":{"type":"object","properties":{"orderId":{"type":"string"},"notify":{"type":"boolean","description":"If set to true, an email notification will be sent on rejection, provided it is configured.","default":"false"},"items":{"type":"array","items":{"type":"object","description":"A map containing details of the items to be rejected or moved.","properties":{"facilityId":{"type":"string","description":"The facility ID of the order item's ship group."},"shipmentMethodTypeId":{"type":"string","description":"The shipment method of the order item's ship group."},"quantity":{"type":"string","description":"The quantity of the order item to be rejected. Defaults to 1.","default":"1"},"orderItemSeqId":{"type":"string","description":"The sequence ID of the order item."},"toFacilityId":{"type":"string","description":"The destination facility ID where the item will be moved after rejection."},"recordVariance":{"type":"string","description":"Set to true if a variance record needs to be created."},"rejectReason":{"type":"string","description":"The reason for rejecting the item."}}}}},"required":["orderId","items"]}}}}
```

## The co.hotwax.order.routing.OrderRoutingServices.rejectOrderItems.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.order.routing.OrderRoutingServices.rejectOrderItems.Out":{"type":"object","properties":{"rejectedItemsList":{"type":"array","items":{"type":"object","properties":{"orderId":{"type":"string"},"orderItemSeqId":{"type":"string"},"shipGroupSeqId":{"type":"string"},"shipmentMethodTypeId":{"type":"string"},"quantity":{"type":"string"}}}}}}}}}
```

## The co.hotwax.order.routing.OrderRoutingServices.getRecentRoutingHistory.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce order routing REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.order.routing.OrderRoutingServices.getRecentRoutingHistory.Out":{"type":"object","properties":{"routingHistoryList":{"type":"array","items":{"type":"string"}}}}}}}
```


---

# 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/models.md?ask=<question>
```

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.