> For the complete documentation index, see [llms.txt](https://docs.hotwax.co/documents/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hotwax.co/documents/integrate-with-hotwax/components/available-to-promise/models.md).

# Models

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

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise 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 Available to Promise 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 Available to Promise 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"},"createdStamp":{"type":"string","format":"date-time"}}},"partyId":{"type":"string"},"partyImageUrl":{"type":"string"}}}}}}
```

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

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise 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 Available to Promise 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"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The co.hotwax.facility.ProductStoreAndFacilityGroup object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise 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.facility.ProductStoreFacilityGroup object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.facility.ProductStoreFacilityGroup":{"title":"Product Store Facility Group","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.facility.ProductStoreFacilityGroup"},"productStoreId":{"type":"string"},"facilityGroupId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"},"sequenceNumber":{"type":"number","format":"int64"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The co.hotwax.facility.ProductStoreFacilityGroup.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.facility.ProductStoreFacilityGroup.PK":{"title":"Product Store Facility Group","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.facility.ProductStoreFacilityGroup.PK"},"productStoreId":{"type":"string"},"facilityGroupId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"}}}}}}
```

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

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.product.store.ProductStoreFacilityDetail":{"title":"Product Store Facility Detail","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.product.store.ProductStoreFacilityDetail"},"storeExternalId":{"type":"string"},"parentFacilityTypeId":{"type":"string"},"productStoreId":{"type":"string"},"facilityId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"},"sequenceNum":{"type":"number","format":"int64"},"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"},"allowSplit":{"type":"string"},"storeDomain":{"type":"string"},"productIdentifierEnumId":{"type":"string"},"enablePreOrderAutoReleasing":{"type":"string"},"enableBrokering":{"type":"string"},"storeLogoImageUrl":{"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"},"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"}}}}}}
```

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

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"org.apache.ofbiz.product.store.ProductStoreFacility":{"title":"Product Store Facility","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.product.store.ProductStoreFacility"},"productStoreId":{"type":"string"},"facilityId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"},"sequenceNum":{"type":"number","format":"int64"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The org.apache.ofbiz.product.store.ProductStoreFacility.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"org.apache.ofbiz.product.store.ProductStoreFacility.PK":{"title":"Product Store Facility","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.product.store.ProductStoreFacility.PK"},"productStoreId":{"type":"string"},"facilityId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"}}}}}}
```

## The co.hotwax.shopify.ShopifyShopAndConfig object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.shopify.ShopifyShopAndConfig":{"title":"Shopify Shop And Config","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.shopify.ShopifyShopAndConfig"},"shopId":{"type":"string"},"shopifyShopId":{"type":"string"},"productStoreId":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"shopOwner":{"type":"string"},"timezone":{"type":"string"},"planName":{"type":"string"},"domain":{"type":"string"},"myshopifyDomain":{"type":"string"},"primaryLocationId":{"type":"string"},"weightUnit":{"type":"string"},"currency":{"type":"string"},"countryCode":{"type":"string"},"isEnabled":{"type":"string"},"shopifyConfigId":{"type":"string"},"shopifyConfigName":{"type":"string"},"accessScopeEnumId":{"type":"string"},"apiVersion":{"type":"string"},"webSiteId":{"type":"string"},"facilityIdenTypeId":{"type":"string"},"apiUrl":{"type":"string"},"username":{"type":"string"},"currentPassword":{"type":"string"},"accessToken":{"type":"string"},"clientId":{"type":"string"},"sharedSecret":{"type":"string"},"oldSharedSecret":{"type":"string"},"processRefund":{"type":"string"}}}}}}
```

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

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise 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 Available to Promise 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 org.apache.ofbiz.product.facility.Facility object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"org.apache.ofbiz.product.facility.Facility":{"title":"Facility","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.product.facility.Facility"},"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"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The org.apache.ofbiz.product.facility.Facility.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"org.apache.ofbiz.product.facility.Facility.PK":{"title":"Facility","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.product.facility.Facility.PK"},"facilityId":{"type":"string"}}}}}}
```

## The co.hotwax.facility.FacilityAndType object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise 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 co.hotwax.facility.FacilityOrderCount object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.facility.FacilityOrderCount":{"title":"Facility Order Count","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.facility.FacilityOrderCount"},"facilityId":{"type":"string"},"lastOrderCount":{"type":"number","format":"int64"},"entryDate":{"type":"string","format":"date"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The org.apache.ofbiz.product.facility.FacilityGroup object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"org.apache.ofbiz.product.facility.FacilityGroup":{"title":"Facility Group","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.product.facility.FacilityGroup"},"facilityGroupId":{"type":"string"},"facilityGroupTypeId":{"type":"string"},"primaryParentGroupId":{"type":"string"},"facilityGroupName":{"type":"string"},"description":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The org.apache.ofbiz.product.facility.FacilityGroup.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"org.apache.ofbiz.product.facility.FacilityGroup.PK":{"title":"Facility Group","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.product.facility.FacilityGroup.PK"},"facilityGroupId":{"type":"string"}}}}}}
```

## The co.hotwax.facility.FacilityGroupAndMember object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.facility.FacilityGroupAndMember":{"title":"Facility Group And Member","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.facility.FacilityGroupAndMember"},"parentFacilityTypeId":{"type":"string"},"facilityGroupId":{"type":"string"},"facilityGroupTypeId":{"type":"string"},"primaryParentGroupId":{"type":"string"},"facilityGroupName":{"type":"string"},"description":{"type":"string"},"facilityId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"},"sequenceNum":{"type":"number","format":"int64"},"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"},"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"}}}}}}
```

## The org.apache.ofbiz.product.facility.FacilityGroupMember object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"org.apache.ofbiz.product.facility.FacilityGroupMember":{"title":"Facility Group Member","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.product.facility.FacilityGroupMember"},"facilityId":{"type":"string"},"facilityGroupId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"},"sequenceNum":{"type":"number","format":"int64"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The org.apache.ofbiz.product.facility.FacilityGroupMember.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"org.apache.ofbiz.product.facility.FacilityGroupMember.PK":{"title":"Facility Group Member","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.product.facility.FacilityGroupMember.PK"},"facilityId":{"type":"string"},"facilityGroupId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"}}}}}}
```

## The co.hotwax.search.SearchServices.autoCompleteSolrFacet.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.search.SearchServices.autoCompleteSolrFacet.Out":{"type":"object","properties":{"response":{"type":"string"}}}}}}
```

## The moqui.service.job.ServiceJobRun object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise 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"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The moqui.service.job.ServiceJobRunLock object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise 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"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The ruleGroup object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"ruleGroup":{"title":"Rule Group","type":"object","properties":{"_entity":{"type":"string","default":"ruleGroup"},"ruleGroupId":{"type":"string"},"productStoreId":{"type":"string"},"groupName":{"type":"string"},"groupTypeEnumId":{"type":"string"},"statusId":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"jobName":{"type":"string"},"description":{"type":"string"},"createdByUser":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastModifiedDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The ruleGroup.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"ruleGroup.PK":{"title":"Rule Group","type":"object","properties":{"_entity":{"type":"string","default":"ruleGroup.PK"},"ruleGroupId":{"type":"string"}}}}}}
```

## The ruleGroup.default object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"ruleGroup.default":{"title":"Rule Group (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"ruleGroup"},"ruleGroupId":{"type":"string"},"productStoreId":{"type":"string"},"groupName":{"type":"string"},"groupTypeEnumId":{"type":"string"},"statusId":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"jobName":{"type":"string"},"description":{"type":"string"},"createdByUser":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastModifiedDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"},"decisionRules":{"type":"array","items":{"$ref":"#/components/schemas/rule"}}}},"rule":{"title":"Decision Rule","type":"object","properties":{"_entity":{"type":"string","default":"rule"},"ruleId":{"type":"string"},"ruleGroupId":{"type":"string"},"ruleName":{"type":"string"},"statusId":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"createdDate":{"type":"string","format":"date-time"},"createdByUser":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The rule object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"rule":{"title":"Decision Rule","type":"object","properties":{"_entity":{"type":"string","default":"rule"},"ruleId":{"type":"string"},"ruleGroupId":{"type":"string"},"ruleName":{"type":"string"},"statusId":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"createdDate":{"type":"string","format":"date-time"},"createdByUser":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The ruleGroup.default.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"ruleGroup.default.PK":{"title":"Rule Group (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"ruleGroup.PK"},"ruleGroupId":{"type":"string"}}}}}}
```

## The co.hotwax.rule.DecisionRuleServices.scheduleNowRuleGroup.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.rule.DecisionRuleServices.scheduleNowRuleGroup.Out":{"type":"object","properties":{"jobRunId":{"type":"string"}}}}}}
```

## The co.hotwax.rule.DecisionRuleServices.getRuleGroupSchedule.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.rule.DecisionRuleServices.getRuleGroupSchedule.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"},"createdStamp":{"type":"string","format":"date-time"}}}}}}}}
```

## The co.hotwax.rule.DecisionRuleServices.storeRuleGroupSchedule.In object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.rule.DecisionRuleServices.storeRuleGroupSchedule.In":{"type":"object","properties":{"ruleGroupId":{"type":"string"},"systemMessageRemoteId":{"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"},"createdStamp":{"type":"string","format":"date-time"}},"required":["ruleGroupId","systemMessageRemoteId"]}}}}
```

## The co.hotwax.rule.DecisionRuleServices.storeRuleGroupSchedule.Out object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"co.hotwax.rule.DecisionRuleServices.storeRuleGroupSchedule.Out":{"type":"object","properties":{"jobName":{"type":"string"}}}}}}
```

## The ruleGroupRuns object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"ruleGroupRuns":{"title":"Rule Group Run","type":"object","properties":{"_entity":{"type":"string","default":"ruleGroupRuns"},"ruleGroupRunId":{"type":"string"},"ruleGroupId":{"type":"string"},"productStoreId":{"type":"string"},"createdByUser":{"type":"string"},"hasError":{"type":"string"},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"},"ruleGroupRunResult":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The rule.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"rule.PK":{"title":"Decision Rule","type":"object","properties":{"_entity":{"type":"string","default":"rule.PK"},"ruleId":{"type":"string"}}}}}}
```

## The rule.default object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"rule.default":{"title":"Decision Rule (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"rule"},"ruleId":{"type":"string"},"ruleGroupId":{"type":"string"},"ruleName":{"type":"string"},"statusId":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"createdDate":{"type":"string","format":"date-time"},"createdByUser":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"},"ruleConditions":{"type":"array","items":{"$ref":"#/components/schemas/ruleCondition"}},"ruleActions":{"type":"array","items":{"$ref":"#/components/schemas/ruleAction"}}}},"ruleCondition":{"title":"Rule Condition","type":"object","properties":{"_entity":{"type":"string","default":"ruleCondition"},"ruleId":{"type":"string"},"conditionSeqId":{"type":"string"},"conditionTypeEnumId":{"type":"string"},"fieldName":{"type":"string"},"operator":{"type":"string"},"joinOperator":{"type":"string"},"fieldValue":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"},"ruleConditionType":{"$ref":"#/components/schemas/enums"}}},"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"},"createdStamp":{"type":"string","format":"date-time"}}},"ruleAction":{"title":"Rule Action","type":"object","properties":{"_entity":{"type":"string","default":"ruleAction"},"ruleId":{"type":"string"},"actionSeqId":{"type":"string"},"actionTypeEnumId":{"type":"string"},"fieldName":{"type":"string"},"fieldValue":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"},"ruleActionType":{"$ref":"#/components/schemas/enums"}}}}}}
```

## The ruleCondition object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"ruleCondition":{"title":"Rule Condition","type":"object","properties":{"_entity":{"type":"string","default":"ruleCondition"},"ruleId":{"type":"string"},"conditionSeqId":{"type":"string"},"conditionTypeEnumId":{"type":"string"},"fieldName":{"type":"string"},"operator":{"type":"string"},"joinOperator":{"type":"string"},"fieldValue":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"},"ruleConditionType":{"$ref":"#/components/schemas/enums"}}},"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"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The enums object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise 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"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The ruleAction object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"ruleAction":{"title":"Rule Action","type":"object","properties":{"_entity":{"type":"string","default":"ruleAction"},"ruleId":{"type":"string"},"actionSeqId":{"type":"string"},"actionTypeEnumId":{"type":"string"},"fieldName":{"type":"string"},"fieldValue":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"},"ruleActionType":{"$ref":"#/components/schemas/enums"}}},"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"},"createdStamp":{"type":"string","format":"date-time"}}}}}}
```

## The rule.default.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"rule.default.PK":{"title":"Decision Rule (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"rule.PK"},"ruleId":{"type":"string"}}}}}}
```

## The ruleCondition.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"ruleCondition.PK":{"title":"Rule Condition","type":"object","properties":{"_entity":{"type":"string","default":"ruleCondition.PK"},"ruleId":{"type":"string"},"conditionSeqId":{"type":"string"}}}}}}
```

## The ruleAction.PK object

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"components":{"schemas":{"ruleAction.PK":{"title":"Rule Action","type":"object","properties":{"_entity":{"type":"string","default":"ruleAction.PK"},"ruleId":{"type":"string"},"actionSeqId":{"type":"string"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.hotwax.co/documents/integrate-with-hotwax/components/available-to-promise/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.