Facilities
Get the facilities
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
In the absence of a product specific days to ship in ProductFacility, this will be used
This field store the unit of measurement of dimension (length, width and height)
This field stores facility ID of the external system
GET /rest/s1/inventory-cycle-count/facilities HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "co.hotwax.facility.FacilityAndType",
"typeDescription": "text",
"facilityId": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"productStoreId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-07-12T07:10:35.602Z",
"closedDate": "2025-07-12T07:10:35.602Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text",
"parentTypeId": "text",
"hasTable": "text"
}
]Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Note that this corresponds with the organizationPartyId that GL transactions will be posted to.
If immediately fulfilled (for physical stores, etc): don't send email notices, don't reserve inventory, and IFF inventory info isn't found on the server then don't issue inventory right away
If set to Y, when a new sales order is created with backordered items, then reservations on the facility/product are reassigned according to the priority given by the shipBeforeDate field.
Specify the type (Billing Account or Financial Account) of Store Credit Account used for refund return. Default to Financial Account. This field is override by ReturnHeader.billingAccountId or ReturnHeader.finAccountId, whichever is specified but if only finAccountId is specified explicitly then system will first try to locate any billing account with -ve amount. If found, then amount is credit to this billing account else the amount will be credit to the financial account of the user.
Default Y. Invoice digital items when order is placed rather than waiting for completing order items (though shipment/fulfillment).
Default Y. Require Shipping Address for Digital Items? Note this only has an effect if there are ONLY digital goods in the cart.
default Y; if set to N do not show isExempt checkbox for PartyTaxAuthInfo, always force to N
The auto-suggestion list is a special ShoppingList that the addSuggestionsToShoppingList service will maintain for cross-sells of ordered items.
default Y; if set to Y an additional constraint will of isVariant!=Y will be added to all product searches for the store
For auto-orders try other Credit Card expiration dates (if date is wrong or general failure where type not known)?
For auto-orders try other Credit Cards for the customer?
For auto-orders if Credit Cards fails for NSF (Not Sufficient Funds) try again later?
For auto-orders if Credit Cards fails for NSF try again how many times?
How many days that store credit is valid for. Null value implies no expiration.
If Y or empty, sales invoices created from orders will be marked ready.
If N, orders will not be automatically approved when payment is authorized.
If N, the captureOrderPayments will cause a service error if credit card capture fails.
If Y or empty, set the inventory item owner upon issuance.
Default N. This is the default value for the ReturnHeader.needsInventoryReceive field. If set to Y return will automatically go to the Received status when Accepted instead of waiting for actual receipt of the return.
Default N. If Y then on add to cart remove all products in cart with a ProductAssoc record related to or from the product and with the PRODUCT_INCOMPATABLE type.
Default N. If Y then on add to cart remove all products in cart with a ProductAssoc record related from the product and with the PRODUCT_UPGRADE type.
Default N. If Y then before the order is stored the OrderPaymentPreference record will be split, one for each OrderItemShipGroup.
If Y, the preparator can choose the InventoryItem by this lotId when he makes the picklist.
Default Y. If N then out of stock products will not be displayed on site
use to indicate if decimal quantity can be ordered for this producStore. Default value is Y
Allow comments for order line items per store
Catalog Url mount point to be used
Restocking fee percentage
Flag to identify if order payments have to be captured when order is added to CSV with value Y or N
Order for products of store will be placed with defined term type.
Mainly used to control nearest facility work flow
Flag to identify if the external promotions are enabled for the store.
Indicates number of days till order can be returned
Indicates Fee charged for Restocking.
Flag to identify if the return will be accepted automatically.
Product identifier to identify unique product
Flag to enable/disable auto preorder releasing on particular store/brand.
Flag to enable/disable brokering on particular store/brand.
Image path for display brand specific logo
In the absence of a product specific days to ship in ProductFacility, this will be used
This field store the unit of measurement of dimension (length, width and height)
This field stores facility ID of the external system
GET /rest/s1/inventory-cycle-count/facilities/productStores HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "co.hotwax.product.store.ProductStoreFacilityDetail",
"storeExternalId": "text",
"parentFacilityTypeId": "text",
"productStoreId": "text",
"facilityId": "text",
"fromDate": "2025-07-12T07:10:35.602Z",
"thruDate": "2025-07-12T07:10:35.602Z",
"sequenceNum": 1,
"primaryStoreGroupId": "text",
"storeName": "text",
"companyName": "text",
"title": "text",
"subtitle": "text",
"payToPartyId": "text",
"daysToCancelNonPay": 1,
"manualAuthIsCapture": "text",
"prorateShipping": "text",
"prorateTaxes": "text",
"viewCartOnAdd": "text",
"autoSaveCart": "text",
"autoApproveReviews": "text",
"isDemoStore": "text",
"isImmediatelyFulfilled": "text",
"inventoryFacilityId": "text",
"oneInventoryFacility": "text",
"checkInventory": "text",
"reserveInventory": "text",
"reserveOrderEnumId": "text",
"requireInventory": "text",
"balanceResOnOrderCreation": "text",
"requirementMethodEnumId": "text",
"orderNumberPrefix": "text",
"defaultLocaleString": "text",
"defaultCurrencyUomId": "text",
"defaultTimeZoneString": "text",
"defaultSalesChannelEnumId": "text",
"allowPassword": "text",
"defaultPassword": "text",
"explodeOrderItems": "text",
"checkGcBalance": "text",
"retryFailedAuths": "text",
"headerApprovedStatus": "text",
"itemApprovedStatus": "text",
"digitalItemApprovedStatus": "text",
"headerDeclinedStatus": "text",
"itemDeclinedStatus": "text",
"headerCancelStatus": "text",
"itemCancelStatus": "text",
"authDeclinedMessage": "text",
"authFraudMessage": "text",
"authErrorMessage": "text",
"visualThemeId": "text",
"storeCreditAccountEnumId": "text",
"usePrimaryEmailUsername": "text",
"requireCustomerRole": "text",
"autoInvoiceDigitalItems": "text",
"reqShipAddrForDigItems": "text",
"showCheckoutGiftOptions": "text",
"selectPaymentTypePerItem": "text",
"showPricesWithVatTax": "text",
"showTaxIsExempt": "text",
"vatTaxAuthGeoId": "text",
"vatTaxAuthPartyId": "text",
"enableAutoSuggestionList": "text",
"enableDigProdUpload": "text",
"prodSearchExcludeVariants": "text",
"digProdUploadCategoryId": "text",
"autoOrderCcTryExp": "text",
"autoOrderCcTryOtherCards": "text",
"autoOrderCcTryLaterNsf": "text",
"autoOrderCcTryLaterMax": 1,
"storeCreditValidDays": 1,
"autoApproveInvoice": "text",
"autoApproveOrder": "text",
"shipIfCaptureFails": "text",
"setOwnerUponIssuance": "text",
"reqReturnInventoryReceive": "text",
"addToCartRemoveIncompat": "text",
"addToCartReplaceUpsell": "text",
"splitPayPrefPerShpGrp": "text",
"managedByLot": "text",
"showOutOfStockProducts": "text",
"orderDecimalQuantity": "text",
"allowComment": "text",
"oldStyleSheet": "text",
"oldHeaderLogo": "text",
"oldHeaderMiddleBackground": "text",
"oldHeaderRightBackground": "text",
"catalogUrlMountPoint": "text",
"restockingFeePercentage": 1,
"capturePmntsOnOrdApproval": "text",
"termTypeId": "text",
"autoSetFacility": "text",
"enableExternalPromotion": "text",
"daysToReturn": 1,
"restockingFeeFixed": 1,
"autoAcceptReturn": "text",
"allowSplit": "text",
"storeDomain": "text",
"productIdentifierEnumId": "text",
"enablePreOrderAutoReleasing": "text",
"enableBrokering": "text",
"storeLogoImageUrl": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-07-12T07:10:35.602Z",
"closedDate": "2025-07-12T07:10:35.602Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text"
}
]Was this helpful?