Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Explore API and data feeds within the 'Inventory' documentation.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Explore API and data feeds within the 'Brokering WIP' documentation.
Loading...
Explore API and data feeds within the 'Inbound Shipment' documentation
Loading...
Loading...
Loading...
Loading...
Loading...
Explore API and data feeds within the 'Facility' documentation.
Loading...
Loading...
Explore API and data feeds within the 'Fulfillment' documentation.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Explore API and data feeds within the 'Appeasements WIP' documentation.
Loading...
Explore API and data feeds within the 'Miscellaneous' documentation.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Learn about authentication requirements for secure transactions on HotWax's platform. Ensure safe API requests effortlessly.
To ensure secure transactions on HotWax's platform, all applications connecting with the HotWax API require authentication when making API requests. The primary method of authentication employed is Bearer token authentication.
Bearer token authentication utilizes security tokens. After a successful login request, the server generates a secret string known as a bearer token. When making requests for protected resources, the user must include the token in the authorization header.
Hotwax Commerce relies on robust security features provided by JWT (JSON Web Token) to ensure a safe and trustworthy API communication environment. This mechanism guarantees user authenticity, authorizes their actions, and maintains data integrity through digital signatures. To create JWT, follow these steps:
Create a unique user from users.hotwax.io by using integration template or assign the integration permissions.
Make sure that Reset Password on Login is unchecked.
Navigate to the Hamburger menu in OMS: https://{instanceName}.hotwax.io/
Access the Settings option and choose Create JWT Token.
Input the user ID.It will display only the users having integration permissions.
Token Configuration:**
Define the validation period.
Specify the purpose of the token.
Click Create, and the resulting JWT token will be displayed in the dedicated section.
Copy Token and use it to build connection
Sample endpoint: https://<host_name>.hotwax.io/<api_name>/login
The following HotWax APIs require an authentication token:
updateInventory
For more information about Bearer token authentication, refer to this video.
Explore how the Order Reconciliations API call offers insights into failed orders, aiding in Shopify to HotWax Commerce synchronization.
Provides log insights for failed orders that may not have been successfully downloaded from Shopify to HotWax Commerce. To retrieve the log details of these failed orders, make a GET request to the /solr-query endpoint.
End Point https://<instance.name>.hotwax.io/api/solr-query
Example: https://demo-oms.hotwax.io/api/solr-query
docType
The Type of the document
coreName
A single index or associated transaction log and configuration files
site
Shopify Store URL containing order details
shopifyOrderName
Unique identifier of the order in Shopify
orderCreatedDate
Date when the order was created on Shopify
firstAttemptedImport
Date when the order import from Shopify to HotWax Commerce was first attempted
docType
The type of the document
ttl
Time duration of the data, also called time to live
errorMessage
The error message for the job failure
timestamp
The timestamp for the API call
expire_at
Data expiry date
document-id
Unique identifier of the document
Learn about the Returns Financial Feed, a JSON-formatted return-wise feed generated from HotWax Commerce OMS.
The Returns Financial Feed, generated from HotWax Commerce OMS, is a JSON-formatted feed containing details about returns created against orders, originating from both online and in-store channels. This feed facilitates financial reconciliation, particularly when integrating with third-party systems such as ERP.
The Returns financial feed is useful for retailers who use ERP for their accounting purposes and requires financial reconciliation during specific cycles. This feed provides the out-of-the-box data available from OMS, and retailers can use it as is or after transformation to ingest into external systems through file-based integration.
The Returns Financial Feeed Order Items feed has certain out-of-the-box customizations that allow users to generate the feed as per the requirements.
Parameter
Description
orderId
Filter return details for a specific order ID.
returnId
Filter return details for a specific return ID.
sinceReturnDate
Filter returns after a specific return date. Corresponds to the return date in HotWax Commerce.
sinceReturnCompletedDate
Filter returns completed in HotWax Commerce after a specific date. Corresponds to the completion date for return items in HotWax Commerce.
sinceEntryDate
Filter returns created after a specific date in HotWax Commerce. Corresponds to the entry date in HotWax Commerce.
productStoreIds
Sets the product store IDs to generate brand-specific feeds. For example, "WSC_STORE".
returnChannelEnumId
Identifies returns made from different channels such as e-commerce returns or in-store returns.
customParametersMap
Defines custom conditions, allowing flexibility in specifying new conditions. For example, {"returnReasonId_op": "empty", "returnReasonId_not": "Y"}.
optimize
Optimize the query or process for better performance.
The following attributes have been prepared in the feed:
returnId
Identifier for the return.
returnItemSeqId
Sequence ID for the return item.
entryDate
Date of entry for the return.
returnDate
Date of the return.
orderSalesChannelEnumId
Enum ID for the order sales channel.
orderSalesChannel
Sales channel for the order.
returnChannelEnumId
Enum ID for the return channel.
orderId
Identifier for the order.
orderItemSeqId
Sequence ID for the order item.
returnItemAmountTotal
Total amount for the return item.
statusId
Identifier for the status.
completedDatetime
Date and time when the return was completed.
productStoreId
Identifier for the product store.
orderName
Name of the order.
productStoreExternalId
External ID for the product store.
customerPartyId
Identifier for the customer party.
billTo
Object containing billing address information.
isShippingChargesSent
Flag indicating if shipping charges were sent.
returnAdjustments
Array of adjustments related to the return.
customerPartyIdentifications
Array of identifications for the customer party.
tenderAmount
Amount tendered for the return.
payments
Array of payments related to the return.
returnItems
Array of items being returned.
Nested Fields within billTo:
houseNumberExt
Extension for the house number.
address2
Additional address information.
postalCode
Postal code of the address.
...
More fields for the billing address.
Nested Fields within returnAdjustments:
customerReferenceId
Identifier for customer reference.
amount
Amount of the adjustment.
description
Description of the adjustment.
...
More fields for the return adjustments.
Nested Fields within customerPartyIdentifications:
partyId
Identifier for the party.
idValue
Value of the identification.
...
More fields for the customer party identifications.
Nested Fields within payments:
paymentMethodTypeId
Type of payment method.
paymentMethodDescription
Description of the payment method.
statusId
Identifier for the status.
...
More fields for the payments.
Nested Fields within returnItems:
returnId
Identifier for the return.
returnItemSeqId
Sequence ID for the return item.
orderId
Identifier for the order.
...
More fields for the return items.
Nested Fields within shipTo:
houseNumberExt
Extension for the house number.
contactMechId
Identifier for the contact mechanism.
postalCode
Postal code of the address.
...
More fields for the shipping address.
Nested Fields within productIdentifications:
productId
Identifier for the product.
goodIdentificationTypeId
Type of good identification.
idValue
Value of the identification.
...
More fields for the product identifications.
Nested Fields within returnItemAdjustments:
customerReferenceId
Identifier for customer reference.
amount
Amount of the adjustment.
description
Description of the adjustment.
...
More fields for the return item adjustments.
Explore API and data feeds within the 'Orders' documentation.
APIs and data feeds specifically designed for order related operations in OMS. These tools provide businesses with the flexibility to integrate their systems with HotWax and automate various order-related processes.
Explore how the Find Order API call offers details about orders present in the system.
Retrieve details a list of orders imported from external systems in your OMS. To find the order, send a GET request to the /solr-query endpoint with appropriate query parameters.
End Point https://<instance.name>.hotwax.io/api/solr-query
Example: https://demo-oms.hotwax.io/api/solr-query
Order Details Table
Discover how the created order feed JSON assists external systems in tracking and consuming new orders entering the OMS.
The Created Orders feed is an order-wise JSON-formatted feed generated from HotWax Commerce OMS. This feed contains details about created order in OMS, which can be approved in OMS based on certain configurable checks. The feed can be used for integration with other external systems.
The Created Order Items feed is a valuable resource for retailers using NetSuite ERP. NetSuite's workflow requires order creation as a prerequisite for other order-related operations. By exporting created orders from the OMS and transforming them into the desired NetSuite format, retailers can integrate these orders into NetSuite for subsequent processing.
The Created Orders feed has certain out-of-the-box customizations that allow users to generate the feed as per the requirements.The created order feed JSON helps external systems track new orders that are entering the OMS and consume them for their linked actions.
Here is a sample feed of that the created order feed looks like
Discover how to retrieve stock details for products at specific locations with the 'Check Inventory' subcategory.
Get the stock details of the product on the specific locations. To get the stock details, you will need to call the /checkInventory endpoint with the POST method.
https://<host>/api/checkInventory
Example: https://demo-oms.hotwax.io/api/checkInventory
Content-Type: application/json
In case of checking a product's inventory at multiple facility.
In case of checking multiple product's inventory at single facility.
Sample
HTTP/1.1 200 OK
Content-Type: application/json
This document provides instructions for retrieving comprehensive details of a specific orde
Improved Sentence:
Retrieves of detailed information about specific order within OMS. This functionality is valuable for verifying order status, contents, and associated details based on their unique identifiers. To retrieve the order, send a GET request to the OMS endpoint with query parameters.
End Point https://<instance.name>.hotwax.io/api/<publish_point>/orders/<order_id>
Example: https://demo-oms.hotwax.io/api/<publish_point>/orders/<order_id>
HTTP/1.1 200 OK
Content-Type: application/json
Learn how order adjustments categorize various order-level charges for streamlined management.
Order adjustments provide a flexible way to categorize various order-level charges. By storing adjustments as distinct types, rather than including them directly in the order header, they can be easily adapted to meet the specific requirements of custom implementations and integrations.
This document provides instructions for getting the list of all orders
GET orders API allows retrieval of existing order documents from the OMS. Supports flexible filtering options to fetch orders based on specific criteria such as partyId or statusId.
Additionally, the API supports sorting functionality. By utilizing the sortBy and sortOrder parameters in the URL, data can be arranged based on fields like grandTotal in either ascending or descending order.
End Point https://<instance.name>.hotwax.io/api/<publish_point>/orders
Example: https://demo-oms.hotwax.io/api/<publish_point>/orders
Filters allow users to query orders based on various fields. The structure of the filter includes:
Field: The field to filter by (e.g., externalId, partyId, statusId). Field_op: Operator used for the filter condition (e.g., equals, like, etc.). Field_ic: Ignore case flag (Y for yes, N for no).
This example will fetch all the orders where externalId is 10025, with case-insensitive matching (ignore case set to Y).
HTTP/1.1 200 OK
Content-Type: application/json
docType
The Type of the document
q
Basic solr query
wt
Format of data returned by api (json/csv)
rows
No of documents returned
sort
Field name and sort order (asc/desc) to sort response
filter
Additional query parameters
fields
List of fields returned in response document
orderId
Unique identifier for the order
orderName
Name or reference given to the order
orderItemSeqId
Sequential ID for the order item
orderItemTypeId
Type of order item (e.g., product, service)
productId
Unique identifier for the product
parentProductName
Name of the parent product (if applicable)
productName
Name of the product
productTypeId
Type of product
internalName
Internal name or code for the product
productTypeDesc
Description of the product type
isPromo
Indicates if the item is part of a promotion
supplierProductId
Supplier's unique identifier for the product
quantity
Quantity ordered
unitPrice
Unit price of the product
unitListPrice
List price of the product
orderItemStatusId
Status of the order item
orderItemStatusDesc
Description of the order item status
orderItemSubTotal
Subtotal for the order item
orderItemAssocTypeId
Type of association between order items
supplierPartyIds
List of supplier party IDs involved in the order
salesRepName
Name of the sales representative
salesChannelEnumId
ID of the sales channel
salesChannelDesc
Description of the sales channel
orderTypeId
Type of order (e.g., sales, purchase)
productStoreId
ID of the product store
productStoreName
Name of the product store
orderStatusId
Status of the order
orderStatusDesc
Description of the order status
statusSeqId
Sequential ID for the order status
orderRoles
Roles associated with the order
customerPartyId
ID of the customer party
customerEmailId
Customer's email address
customerPartyName
Name of the customer party
shipToCountry
Country where the order will be shipped
shipToState
State where the order will be shipped
shipToCity
City where the order will be shipped
shippingMethod
Shipping method used for the order
supplierPartyId
ID of the supplier party
supplierPartyName
Name of the supplier party
orderDate
Date the order was placed
orderNotes
Notes or comments associated with the order
orderDateString
Date string representation of the order date
estimatedDeliveryDate
Estimated delivery date
autoCancelDate
Date when the order will be automatically canceled
correspondingPoId
ID of the corresponding purchase order (if applicable)
title
Title or reference given to the order
facilityId
ID of the facility involved in the order
facilityName
Name of the facility
orderGrandTotal
Total amount of the order
orderSize
Size of the order
lastInventoryCount
Last recorded inventory count
categoryHierarchy
Hierarchical structure of product categories
workEffortId
ID of the related work effort
workEffortTypeId
Type of work effort
currentStatus
Current status of the work effort
workEffortPurposeTypeId
Purpose of the work effort
workEffortParentId
ID of the parent work effort (if applicable)
priority
Priority of the work effort
workEffortName
Name of the work effort
description
Description of the work effort
estimatedStartDate
Estimated start date of the work effort
estimatedCompletionDate
Estimated completion date of the work effort
actualStartDate
Actual start date of the work effort
actualCompletionDate
Actual completion date of the work effort
backOrderedQuantity
Quantity of backordered items
orderToReleaseTime
Time taken from order placement to release
releaseToPickTime
Time taken from release to picking
pickToShipTime
Time taken from picking to shipping
partyClassificationGroupIds
IDs of the party classification groups
currencyUomId
ID of the currency unit of measurement
placingPartyName
Name of the party placing the order
placingPartyId
ID of the party placing the order
primaryProductCategoryNameFacet
Primary category name facet
priceType
Type of pricing (e.g., retail, wholesale)
promoCodeIds
IDs of applied promo codes
orderIdentifications
List of order identification codes
promisedDatetime
Promised date and time for delivery
shipmentMethodTypeId
ID of the shipment method type
numFound
Total number of documents found matching the search criteria
start
Starting index of the returned documents
numFoundExact
Indicates whether the numFound value is exact or an estimate
sku
The SKU of the product
N
sku_op
The operator to be used for the sku field
N
productId
HotWax Commerce internal product Id
N
facilityId
The HotWax Commerce facility Id where product inventory is located
N
facilityId_op
The operator to be used for the facility Id
N
sku_op
The operator to be used for the sku field
N
Note: It is required to pass either sku or productId.
count
Results count
docs
The array of results found
facilityId
The Id of the facility in HotWax
atp
The available to promise inventory of the product
id
The unique identifier for the order.
externalId
External system identifier for the order.
orderName
The name or reference number of the order.
channel
Sales channel through which the order was placed.
channelDesc
Description of the sales channel.
customerId
The unique identifier for the customer.
customerExternalId
External system identifier for the customer.
customerName
The name of the customer.
priority
Priority level of the order.
orderDate
The date when the order was placed.
entryDate
The date when the order was entered into the system.
expireDate
The expiration date of the order.
statusId
Current status of the order.
statusDesc
Description of the order status.
productStoreId
Identifier for the product store associated with the order.
productStoreName
Name of the product store.
webSiteId
Identifier for the website associated with the order.
webSiteName
Name of the website.
currencyCode
The currency code for the order.
currencyCodeDesc
Description of the currency code.
remainingSubTotal
The remaining subtotal for the order.
grandTotal
The grand total amount for the order.
tags
Tags associated with the order.
note
Notes associated with the order.
orderContacts
Contact information for the order.
orderIdentifications
Identifications related to the order.
shipGroup
Shipping group details for the order.
orderAdjustments
Adjustments applied to the order.
orderPaymentPref
Payment preferences for the order.
billTo
Billing information for the order.
billFrom
Billing information from the order origin.
ADDITIONAL_FEATURE
-
Additional Feature
CGST
GST_TAX
Central Goods and Services Tax
DEPOSIT_ADJUSTMENT
-
Deposit
DEPOSIT_REFUND
-
Deposit Refund
DISCOUNT_ADJUSTMENT
-
Discount
DONATION_ADJUSTMENT
-
Donation
DUTY
-
Duty
EXT_PROMO_ADJUSTMENT
-
External promotion adjustment
EXT_SHIP_ADJUSTMENT
-
External shipping adjustment
FEE
-
Fee
GST_TAX
-
Goods and Services Tax
IGST
GST_TAX
Integrated Goods and Services Tax
MISCELLANEOUS_CHARGE
-
Miscellaneous Charge
MKTG_PKG_AUTO_ADJUST
-
Marketing Package Adjustment
OFF_INV_ADJUSTMENT
DISCOUNT_ADJUSTMENT
Off Invoice Adjustment
PROMOTION_ADJUSTMENT
-
Promotion
PYMNT_PROCESS_FEE
FEE
Payment Processing Fee
REPLACE_ADJUSTMENT
-
Replacement
SALES_TAX
-
Sales Tax
SGST
GST_TAX
State Goods and Services Tax
SHIPPING_CHARGES
-
S&H
SHIPPING_SALES_TAX
-
S&H Tax
SURCHARGE_ADJUSTMENT
-
Surcharge
UTGST
GST_TAX
Union Territories State Goods and Services Tax
VAT_PRICE_CORRECT
-
VAT Price Correction
VAT_TAX
-
VAT Tax
WARRANTY_ADJUSTMENT
-
Warranty
viewIndex
Index of the view in pagination.
viewSize
Number of records to fetch per page.
filters
Filters to apply for querying specific orders.
id
Unique identifier of the order.
externalId
External identifier of the order.
orderName
Name or identifier of the order.
channel
Sales channel through which the order was placed.
channelDesc
Description of the sales channel.
customerId
ID of the customer associated with the order.
customerExternalId
External ID of the customer.
customerName
Name of the customer.
priority
Priority level of the order.
orderDate
Date and time when the order was created.
entryDate
Date and time when the order was entered into the system.
expireDate
Date and time when the order expires.
statusId
ID indicating the current status of the order.
statusDesc
Description of the current status of the order.
productStoreId
ID of the product store associated with the order.
productStoreName
Name of the product store.
webSiteId
ID of the website associated with the order.
webSiteName
Name of the website.
currencyCode
Currency code used for the order.
currencyCodeDesc
Description of the currency used.
remainingSubTotal
Remaining subtotal amount of the order.
grandTotal
Total amount of the order.
tags
Tags associated with the order.
note
Additional notes or comments related to the order.
orderContacts
Contact information associated with the order (e.g., email).
orderIdentifications
Array of identification details associated with the order (e.g., marketplaces, order IDs).
shipGroup
Array containing shipping group details for the order.
orderAdjustments
Adjustments made to the order (e.g., shipping charges).
orderPaymentPref
Payment preferences for the order (e.g., payment method, status).
billTo
Billing details for the order (e.g., postal address, email, phone).
billFrom
Originating entity details for the order (e.g., company name, address, email, phone).
<order_id>
The unique identifier of the order to retrieve.
The BOPIS (Buy Online, Pick-up In Store) Check Inventory API allows you to retrieve stock details for products at specific locations. By calling the /checkBopisInventory endpoint with the POST method, you can check the availability of BOPIS inventory.
URL: https://<host>/rest/s1/ofbiz-oms-usl/checkBopisInventory
This API uses our next generation OMS instance. All traditional instances have access to this next generation OMS by replacing "oms" with "maarg" in the host name.
Production
Current Name: demo-oms
Maarg Name: demo-maarg
UAT
Current Name: demo-uat
Maarg Name: demo-maarg-uat
Example: https://demo-maarg.hotwax.io/rest/s1/ofbiz-oms-usl/checkBopisInventory
GET (Recommended if your library supports sending a body in a GET request) POST
Content-Type: application/json
Single product and facility
Multiple products and facilities
productStoreId
The ID of the product store
"STORE"
productIds
HotWax Commerce internal product ID
"11855"
internalNames
The well known ID of a product, usually UPC or SKU based on configuration
"XS-BLACK"
facilityIds
The HotWax Commerce facility ID where product inventory is located
"114"
inventoryGroupId
HotWax Commerce inventory group ID
"SHOPIFY_FAC_GRP"
If both productIds and internalNames are passed, the value of productIds will be honored.
Select Products
Products can be queried in the inventory API by both their HotWax ID or their internalName. The internal name refers to the UPC or SKU, whichever one is selected as a primary identifier during product configuration. While both fields are optional, one is requried to obtain a result.
productStoreId
Product Store represents a brand in HotWax Commerce. To obtain possible values, log into HotWax Commerce and view the product store list page for possible values.
inventoryGroupId Inventory groups are used to segregate inventory for different channels of sales. Obtain the inventory group ID by logging into HotWax Commerce Facilities App and browsing inventory groups.
HTTP/1.1 200 OK
Content-Type: application/json
ATP zeroed out due to the inventory checks
decisionReason explanationProductStore
The facility is not associated with the product store.
PickUpFacility
The facility does not have PickUp enabled. Add it to the PickUp facility group to enable pickup.
InventoryGroup
The facility where the product is located does not cater its inventory to that channel.
AllowPickupInventoryGroup
Pickup is not allowed globally for the inventory group.
AllowPickupFacility
The facility where the product inventory is located is disabled for catering to BOPIS orders.
Each Decision Reason also comes with a detailed log of why the given check failed.
ProductStore - Facility ${facilityId} is not associated with Product Store ${productStoreId}.
PickUp Facility - Facility ${facilityId} is not a member of a PICKUP Facility Group.
Inventory Group - Facility ${facilityId} is not a member of ${inventoryGroupId} channel.
Product Inventory Group allowPickup - Pickup is not allowed for product ${productId} ${inventoryGroupId} inventory group.
Product Facility allowPickup - Pickup is not allowed for product ${productId} at facility ${facilityId}.
Learn how to sync inventory from an external reference source to HotWax Commerce with the 'Reset Inventory' feature.
Syncs inventory from an external reference source to HotWax. After receiving the inventory file in CSV format, HotWax Commerce calculates the difference in inventory and matches its inventory levels exactly with CSV. CSV files can be imported in HotWax by two methods: using the EXIM menu in HotWax or saving the file at a designated SFTP location for HotWax to automatically download and process.
Sample path for SFTP method: /home/<host_name>-sftp/staging/incoming
Here's an example of the CSV file format:
DEMO_HC_STORE_1
TLTLTLLL01
sku
WH09-XL-Green
20
The Reset Inventory API accepts the following parameters:
facilityId
HotWax Commerce internal facility Id. Generally the same as the facility Id in Shopify.
Yes
locationSeqId
The Id of the designated location in a facility in HotWax Commerce.
Yes
idType
The type of the unique product identifier in the external reference source. Default is shopifyProductId
No
idValue
The value of the product idType in the external reference source.
Yes
availableQty
The available quantity of the product in the external reference source. This number will overwrite the current ATP level of the product in HotWax Commerce.
Yes
externalFacilityId
The Id of the facility in an external reference source.
No
productId
The internal Id of a product in HotWax Commerce.
No
comments
Optional field to store additional information.
No
Note: sku upca and shopifyProductId are commonly used product Identifiers.
The Shipping Ckeck Inventory API allows to retrive the inventory details for the products at specific locations. By calling the /checkShippingInventory endpoint of our next generation OMS with the POST/GET method, you can check the availability of the inventory available for shipping.
URL: https://<host>/rest/s1/ofbiz-oms-usl/checkShippingInventory
This API uses our next generation OMS instance. All traditional instances have access to this next generation OMS by replacing "oms" with "maarg" in the host name.
Production
Current Name: demo-oms
Maarg Name: demo-maarg
Example: https://demo-maarg.hotwax.io/rest/s1/ofbiz-oms-usl/checkShippingInventory
UAT
Current Name: demo-uat
Maarg Name: demo-maarg-uat
GET: When passing params in the URL
POST: When passing JSON body in the request
Content-Type: application/json
Using POST Method
Using GET Method
Using POST Method
Using GET Method
productStoreId
The ID of the product store
"STORE"
productIds
HotWax Commerce internal product ID
"11855"
internalNames
The well-known ID of a product, usually UPC or SKU based on configuration
"XS-BLACK"
facilityIds
The HotWax Commerce facility ID where product inventory is located
"114"
inventoryGroupId
HotWax Commerce inventory group ID
"SHOPIFY_FAC_GRP"
Notes
Either productIds and internalNames value is required, If both values are passed, then the value of productIds will be honored.
This API does not necessarily require the inventoryGroupId and facilityIds, If both values are not provided API will return an inventory of products at all the locations.
Select Products
Products can be queried in the inventory API by both their HotWax ID or their internalName. The internal name refers to the UPC or SKU, whichever one is selected as a primary identifier during product configuration. While both fields are optional, one is required to obtain a result.
productStoreId
Product Store represents a brand in HotWax Commerce. To obtain possible values, log into HotWax Commerce and view the product store list page for possible values.
inventoryGroupId
Inventory groups are used to segregate inventory for different channels of sales. Obtain the inventory group ID by logging into HotWax Commerce Facilities App and browsing inventory groups.
HTTP/1.1 200 OK
Content-Type: application/json
decisionReason explanationProductStore
The facility is not associated with the product store.
ProductFacility
The facility does not have PickUp enabled. Add it to the PickUp facility group to enable pickup.
InventoryGroup
The facility where the product is located does not cater its inventory to that channel.
AllowBrokeringInventoryGroup
Brokering is not allowed globally for the given inventory group.
AllowBrokeringFacility
The facility where the product inventory is located is disabled for brokering.
Each Decision Reason also comes with a detailed log of why the given check failed.
ProductStore - The facility ${facilityId} is not associated with Product Store ${productStoreId}.
Product Facility - The inventory for product ${productId} at facility ${facilityId} is not available.
Inventory Group - The facility ${facilityId} where the product ${productId} is located does not cater its inventory to that channel.
Inventory Group allowBrokering - Brokering of the product ${productId} for the inventory group ${inventoryGroupId} is not allowed globally.
Product Facility allowBrokering - The facility ${facilityId} where the product ${productId} inventory is located is disabled to cater to shipping orders.
Discover how to retrieve online ATP for products at specific locations with the 'getProductOnlineAtp' API
Store Associates need to access the online Available to Promise (ATP) inventory of products on their POS systems for sendsales orders. The getProductOnlineAtp API facilitates retrieving the online ATP of a product from all locations except the one it's being ordered from. The API does not count the Online ATP of a facility in the following scenarios:
Inventory for the store placing the order.
Inventory from stores with sell online turned off.
Inventory for an SKU where the inventory is turned off in specific locations.
To fetch the online ATP details, make a POST request to the /getProductOnlineAtp endpoint.
https://<host>/api/service/getProductOnlineAtp
Example https://demo-oms.hotwax.io/api/service/getProductOnlineAtp
Content-Type: application/json
idType
Specifies the type of identifier being used (e.g., "SKU")
idValue
The specific value of the SKU being referenced
productStoreId
Identifies the store or location within the system where the product is available
conditionMap
Contains conditions for filtering or specifying attributes related to the request
externalFacilityId_value
The value of the external facility ID
externalFacilityId_op
The operation or condition applied to the external facility ID (e.g., "notEqual")
HTTP/1.1 200 OK
Content-Type: application/json
onlineAtp
The online available to promise inventory of the product
Discover the Brokered Order Items feed, a JSON-formatted feed generated from HotWax Commerce OMS for streamlined order management.
The Brokered Order Items feed is an order-wise JSON-formatted feed generated from HotWax Commerce OMS. This feed contains details about brokered order items, which can be brokered to either Warehouse or Store Type facilities. The feed can be used for integration with other external systems.
The Brokered Order Items feed is useful for retailers who would like to do fulfillment outside OMS through an external system such as a Warehouse Management System (WMS). This feed provides the out-of-the-box data available from OMS, and retailers can use it as is or after transformation to ingest into external systems through file-based integration.
The Brokered Order Items feed has certain out-of-the-box customizations that allow users to generate the feed as per the requirements.
Parameter
Description
orderId
Allows to generate the feed for a specific order ID.
orderItemSeqId
Allows to generate the feed for a specific order item sequence ID within an order.
parentFacilityTypeIds
Specifies the type of facility from which the brokered order items are being fetched.
productStoreIds
Allows you to set the product store IDs to generate brand-specific feeds.
systemMessageTypeId
The SFTP path where the feed will be stored.
systemMessageRemoteId
The SFTP credentials required to access the SFTP location.
The following attributes have been prepared in the feed:
productStoreId
The ID of the product store
STORE
orderId
The HotWax Commerce unique identifier for the order
12082
orderName
The eCommerce order identifier
9000004032
orderDate
The date and time the order was placed on eCommerce
2024-02-23T03:43:23+09:00
orderStatusId
Order status
ORDER_APPROVED
entryDate
The date and time the order was imported in HotWax Commerce OMS
2024-02-23T03:50:12+09:00
orderExternalId
The external ID of the order
5384320450749
currency
The payment currency used for the order
JPY
grandTotal
The total sum of all costs associated with an order
1870
customerFirstName
The first name of the customer
jhon
customerLastName
The last name of the customer
deo
salesChannel
The sales channel
WEB_CHANNEL
customerPartyId
The customer party ID
10290
isShippingChargesSent
Indicates if shipping charges are sent
Y
billTo
The billing information
See below
orderIdentifications
The order identifications
See below
customerPartyIdentifications
The customer party identifications
See below
payments
The payments
See below
orderAdjustments
The order adjustments
See below
orderAttributes
The order attributes
See below
orderItems
The order items
See below
This object contains the following attributes, each of which has internal nesting:
billTo
The billing information
See below
orderIdentifications
The order identifications
See below
customerPartyIdentifications
The customer party identifications
See below
payments
The payments
See below
orderAdjustments
The order adjustments
See below
orderAttributes
The order attributes
See below
orderItems
The order items
See below
billTo
countryGeoCode
The country geo code
JP
stateProvinceGeoCode
The state province geo code
null
contactMechId
The contact mechanism ID
18227
toName
The name of the recipient
jhon deo
address1
The first line of the address
足立
address2
The second line of the address
null
city
The city
足立区
postalCode
The postal code
120-0015
countryGeoId
The country geo ID
JPN
stateProvinceGeoId
The state province geo ID
null
isResidentialAddress
Indicates if the address is residential
Y
phone
The phone information
See below
billTo.phone
contactMechId
The contact mechanism ID
18228
countryCode
The country code
1
areaCode
The area code
null
contactNumber
The contact number
0593785656
orderIdentifications
idValue
The ID value
5384320450749
orderId
The order ID
12082
fromDate
The from date
2024-02-23T03:50:12+09:00
thruDate
The thru date
null
customerPartyIdentifications
partyIdentificationTypeId
The party identification type ID
SHOPIFY_CUST_ID
idValue
The ID value
7053008306365
partyId
The party ID
10290
payments
paymentMethodCode
The payment method code
null
amount
The amount
1870
paymentMethodTypeId
The payment method type ID
EXT_SHOP_OTHR_GTWAY
paymentMethodDescription
The payment method description
Ext Other Gateways
orderId
The order ID
12082
statusId
The status ID
PAYMENT_AUTHORIZED
returnId
The return ID
null
createdDate
The date and time of creation
2024-02-23T03:50:12+09:00
orderAdjustments
orderAdjustmentTypeId
The order adjustment type ID
SHIPPING_SALES_TAX
amount
The amount
50
orderAdjustmentId
The order adjustment ID
null
orderId
The order ID
12082
orderAttributes
orderId
The order ID
12082
attrDescription
The attribute description
null
attrName
The attribute name
COD_FEE_ADJ_CREATED
attrValue
The attribute value
true
orderItems
productStoreId
The ID of the product store
STORE
orderId
The unique identifier for the order
12082
orderName
The name of the order
9000004032
orderDate
The date and time the order was placed
2024-02-23T03:43:23+09:00
orderStatusId
The status of the order
ORDER_APPROVED
entryDate
The date and time the order was entered
2024-02-23T03:50:12+09:00
orderExternalId
The external ID of the order
5384320450749
currency
The currency used for the order
JPY
grandTotal
The total amount of the order
1870
orderItemSeqId
The sequence ID of the order item
00101
itemStatusId
The status of the item
ITEM_APPROVED
orderItemQuantity
The quantity of the order item
1
reservedItemQuantity
The quantity of reserved items
1
unitPrice
The unit price of the item
1200
orderItemExternalId
The external ID of the order item
12915436126397
itemDescription
The description of the item
ソックス クルー 3ペア ホワイト
shipGroupSeqId
The sequence ID of the ship group
00001
shipmentMethodTypeId
The shipment method type ID
STANDARD
postalContactMechId
The postal contact mechanism ID
18224
telecomContactMechId
The telecom contact mechanism ID
18225
carrierPartyId
The carrier party ID
NA
externalFulfillmentOrderItemId
The external fulfillment order item ID
null
fulfillmentStatus
The fulfillment status
null
customerFirstName
The first name of the customer
jhon
customerLastName
The last name of the customer
deo
facilityId
The facility ID
WH0615
facilityExternalId
The external ID of the facility
22
facilityTypeId
This attribute contains the facility Type Id.
WAREHOUSE
parentFacilityTypeId
This attribute contains ID of the parent facility for facilityId.
DISTRIBUTION_CENTER
statusDatetime
The date and time of the status
2024-02-23T04:05:15+09:00
productId
The product's unique identifier in HotWax Commerce
60757
productTypeId
The type of product identification
FINISHED_GOOD
internalName
String
-
salesChannel
The sales channel
WEB_CHANNEL
customerPartyId
The customer's unique identification in HotWax Commerce
10290
shipTo
The shipping information
See below
goodIdentifications
The product/good identifications
See below
orderItemAdjustments
The order item adjustments
See below
orderItemAttributes
The order item attributes
See below
facilityGroupMembers
The facility group members
See below
fromOrderItemAssocs
The from order item associations
See below
toOrderItemAssocs
The to order item associations
See below
productFeatures
The product features
See below
orderItems.shipTo
countryGeoCode
The country geo code
JP
stateProvinceGeoCode
The state province geo code
null
contactMechId
The contact mechanism ID
18224
toName
The name of the recipient
jhon deo
address1
The first line of the address
足立
address2
The second line of the address
null
city
The city
足立区
postalCode
The postal code
120-0015
countryGeoId
The country geo ID
JPN
stateProvinceGeoId
The state province geo ID
null
countyGeoId
The county geo ID
null
isResidentialAddress
Indicates if the address is residential
Y
phone
The phone information
See below
orderItems.phone.shipTo
contactMechId
The contact mechanism ID
18228
countryCode
The country code
1
areaCode
The area code
null
contactNumber
The contact number
0593785656
orderItem.goodIdentification
idValue
The good identifications ID value
37639003275453
fromDate
The identification creation date
2023-12-25T03:48:21+09:00
productId
The HotWax Commerce's product ID
60757
goodIdentificationTypeId
The type of good identification
SHOPIFY_PROD_ID
thruDate
The identification expiration date
null
orderItems.orderItemAdjustments:
amount
The amount of order adjustment
120
orderAdjustmentTypeId
The order adjustment type ID
SALES_TAX
orderId
The order ID
12082
orderItemSeqId
The Order Item Seq ID.
0001
orderItemAttributes
orderId
The order ID
12082
attrDescription
The attribute description
null
attrName
The attribute name
COD_FEE_ADJ_CREATED
attrValue
The attribute value
true
orderItemSeqId
the Order item sequence id.
00001
facilityGroupMembers
facilityId
The facility ID
WH0615
facilityGroupId
The facility group ID
22
thruDate
The thru date
null
fromDate
The from date
2024-02-23T03:50:12+09:00
sequenceNum
The sequence number for the member.
1
fromOrderItemAssocs:
orderId
The order ID of kit product
12082
orderItemSeqId
The order items seq ID of the kit product.
00101
toOrderId
The order ID of the component product.
null
toOrderItemSeqId
The order items seq ID of the component product.
00001
shipGroupSeqId
The ship group seq ID of the kit product.
00002
toShipGroupSeqId
The ship group seq ID of the component product.
00003
orderItemAssocTypeId
The order item assoc type ID.
KIT_COMPONENT
toOrderItemAssocs:
orderId
The order ID of kit product
12082
orderItemSeqId
The order items seq ID of the kit product.
00101
toOrderId
The order ID of the component product.
null
toOrderItemSeqId
The order items seq ID of the component product.
00001
shipGroupSeqId
The ship group seq ID of the kit product.
00002
toShipGroupSeqId
The ship group seq ID of the component product.
00003
orderItemAssocTypeId
The order item assoc type ID like.
KIT_COMPONENT
productFeatures:
productFeatureApplTypeId
the feature Appl type like
STANDARD_FEATURE
productFeatureId
the unique feature ID.
10000
productFeatureCategoryId
the product feature category ID.
10015
description
the description of the feature.
Red, L
productId
the Product ID.
10000
productFeaturTypeId
the feature type like
COLOR
Return adjustments are used to categorize different return-level charges. By storing all adjustments as types of adjustments that can be applied to the return, instead of including them in the return header, they can be extended based on the needs of custom implementations and integrations.
RET_ADD_FEATURE_ADJ
Return Additional Feature
RET_DEPOSIT_ADJ
Return Deposit Adjustment
RET_DISCOUNT_ADJ
Return Discount
RET_DUTY_ADJ
RMA Duty
RET_EXT_PRM_ADJ
Return External Promotion Adjustment
RET_FEE_ADJ
Return Fee
RET_MAN_ADJ
Return Manual Adjustment
RET_MISC_ADJ
Return Miscellaneous Charges
RET_MKTG_PKG_ADJ
Return Marketing Package Adjustment
RET_PROMOTION_ADJ
Return Promotion
RET_REPLACE_ADJ
Return Replacement
RET_RMA_ADJ
RMA Fee Adjustment
RET_SALES_TAX_ADJ
Return Sales Tax
RET_SHIPPING_ADJ
Return S&H
RET_SURCHARGE_ADJ
Return Surcharge
RET_VAT_PC_ADJ
Return VAT Price Correction
RET_VAT_TAX_ADJ
Return VAT Tax
RET_WARRANTY_ADJ
Return Warranty
ECOM_RTN_CHANNEL
RETURN_CHANNEL
Ecom Return Channel
01
POS_RTN_CHANNEL
RETURN_CHANNEL
POS Return Channel
02
Discover how returns are generated Return Header wise, with each return containing the list of returned items.
The feed will be generated Return Header wise, with each return containing the list of items returned.
Parameters which can be variable for the Returns Financial Feed Feed are
orderId - Parameter to fetch Return details for a specific orderId.
returnId - Parameter to fetch Return details for a specific returnId.
systemMessageTypeId - The System Message Type ID for generating Returns Financial Feed.
systemMessageRemoteId - The System Message Remote ID to send Returns Financial Feed.
sinceReturnDate - Parameter to fetch Returns after a specific Return Date. This date corresponds to the ReturnHeader.returnDate in HC.
sinceReturnCompletedDate - Parameter to fetch Returns which are completed in HC after a specific Date. This date corresponds to the ReturnStatus.completedDatetime for Return Items in HC.
sinceEntryDate - Parameter to fetch Returns created after a specific Date in HC. This date corresponds to the ReturnHeader.entryDate in HC.
productStoreIds - to set the product store ids to generate brand specific feeds. eg. WSC_STORE
returnChannelEnumId - Identify the Returns being made from different channels like Ecom Returns, In-Store etc.
customParamatersMap - This map defines custom conditions, allowing flexibility in defining new conditions. Eg. {"returnReasonId_op": "empty", "returnReasonId_not": "Y"}
Views used
FinancialReturnItemsSyncQueue
ReturnItemView
In the first entity, find on the FinancialReturnItemsSyncQueue view fetches the eligible records for the feed.
The conditions on the FinancialReturnItemsSyncQueue are:
productStoreId - Support for productStoreId was added to generate brand specific feeds.
If productStoreId comes from the in-parameter productStoreIds which is a list then the productStoreId field is prepared based on the following cases:
If only one value comes in the productStoreIds list then the productStoreId field will be set from that value in the list.
If nothing is passed in the productStoreIds list or there are more than one value in the list then the productStoreId field will be a default prefix that will be set from the property added in the Moqui conf file. In this case, the default prefix will be 'HOTWAX'.
NOTE: If the view does not return any records, the Feed file of HotWax will not generate, and logs the message, "No eligible returns to prepare Returns Financial Feed at ${nowDate}, not generating the HotWax Feed file."
If FinancialReturnItemsSyncQueue has eligible returns to prepare the feed then prepare the Return level details in the service:
billTo
returnAdjustments
customerPartyIdentifications
payments
Prepared the returnItems list i.e. fetched the returns items through eligible returns:
shipTo
productIdentifications
returnItemAdjustments
Prepare the isShippingChargesSent field and fetch Return level adjustments with return adjustment type 'RET_SHIPPING_ADJ', 'RET_SALES_TAX_ADJ' to create ReturnAdjustmentHistory records:
ReturnAdjustmentAndHistory View is created for the purpose to maintain the Return level Adjustments history which are sent as part of Feed to external systems.
The condition on the view is such that it will fetch Return level adjustments which are not sent to external systems.
The ReturnAdjustmentHistory record will be created for the Shipping Charges and Shipping Sales Tax.
If for a Return some items that are completed later and are eligible to appear in the next feed, then the isShippingChargesSent value will be sent as 'Y'.
Based on the value of isShippingChargesSent, the custom transformations can be prepared.
This is done so that financials can be done in the right way and order level adjustments are not computed multiple times which may cause discrepancies in the order totals when reconciliations are done.
NOTE: For now only Shipping Charges and Shipping Sales Tax are considered as the Order level Adjustments for which we are maintaining the history.
If FinancialReturnItemsSyncQueue has eligible returns to prepare feed then to prepare values of other fields as per the Chain Drive format, for each return item fetched from the first view, entity find is done on the second view, ReturnItemView.
The Return Level Adjustments list (shipping charges, shipping sales tax, etc) for the feed is prepared in the service.
The Return Item Level Adjustments list (return item sales tax, return item discount, etc) for the feed is prepared in the service.
NOTE: The specific amount for returnAdjustmentTypeIds from the Return Header Level Adjustments list and Return Item Level Adjustments list will be prepared in the Jolt Transform.
To Prepare total amount (TENDER_AMOUNT)
Logic used -> ReturnPrice * quantity + sum of the Item Level Adjustments
For TENDER_AMOUNT, there is the scenario: If the Return has three items and two of them are completed today and eligible for today's feed then in the feed TENDER_AMOUNT will be the sum(of amounts) of only these two items + shipping charges and shipping sales tax.
Next day if the third item will be completed and eligible for the feed then in the feed TENDER_AMOUNT will be the sum(of amounts) of only this item + shipping charges and shipping sales tax.
Note - This is part of special handling used the ReturnItemAndAdjustment view to prepare the TENDER_AMOUNT using the formula ReturnPrice * quantity + sum of the Item Level Adjustments(sum function used on the amounts in the view).
For preparing ShipToAddress, PostalAddressView is used with the condition on shipToContactMechId from ReturnItemView.
For preparing BillToAddress, first OrderContactMech is used to get contactMechId for the contactMechPurposeTypeId = 'BILLING_LOCATION'. Then PostalAddressView is used with a condition on contactMechId from OrderContactMech.
For maintaining the history of records sent as part of the Financial feed, the entity record for FinancialReturnHistory is created in the service itself.
returnId
ReturnItem.returnId
returnItemSeqId
ReturnItem.returnItemSeqId
entryDate
ReturnHeader.entryDate
returnDate
ReturnItem.returnId -> ReturnHeader.returnDate
returnChannelEnumId
ReturnHeader.returnChannelEnumId
orderSalesChannelEnumId
OrderHeader.salesChannelEnumId
orderSalesChannel
OrderHeader.salesChannelEnumId -> Enumeration.enumCode
orderId
ReturnItem.orderId
orderItemSeqId
ReturnItem.orderItemSeqId
returnItemAmountTotal
ReturnItem.returnItemPrice
statusId
ReturnItem.returnId, ReturnItem.returnItemSeqId -> ReturnStatus.statusId
completedDatetime
ReturnItem.returnId, ReturnItem.returnItemSeqId -> ReturnStatus.completedDatetime
productStoreId
ReturnItem.orderId -> OrderHeader.orderId
orderName
ReturnItem.orderId -> OrderHeader.orderName
productStoreExternalId
ReturnItem.orderId -> OrderHeader.productStoreId -> ProductStore.productStoreId
customerPartyId
ReturnItem.returnId -> ReturnHeader.fromPartyId
billTo
ReturnItem.orderId -> orderContactMech.contactMechId -> PostalAddress
billTo.countryGeoCode
orderContactMech.contactMechId -> PostalAddress.countryGeoId -> Geo.geoId
billTo.stateProvinceGeoCode
orderContactMech.contactMechId -> PostalAddress.stateGeoId -> Geo.geoId
billTo.contactMechId
orderContactMech.contactMechId -> PostalAddress.contactMechId
billTo.toName
orderContactMech.contactMechId -> PostalAddress.toName
billTo.attnName
orderContactMech.contactMechId -> PostalAddress.attnName
billTo.address1
orderContactMech.contactMechId -> PostalAddress.address1
billTo.address2
orderContactMech.contactMechId -> PostalAddress.address2
billTo.houseNumber
orderContactMech.contactMechId -> PostalAddress.houseNumber
billTo.houseNumberExt
orderContactMech.contactMechId -> PostalAddress.houseNumberExt
billTo.city
orderContactMech.contactMechId -> PostalAddress.city
billTo.cityGeoId
orderContactMech.contactMechId -> PostalAddress.cityGeoId
billTo.postalCode
orderContactMech.contactMechId -> PostalAddress.postalCode
billTo.postalCodeExt
orderContactMech.contactMechId -> PostalAddress.postalCodeExt
billTo.countryGeoId
orderContactMech.contactMechId -> PostalAddress.countryGeoId
billTo.stateProvinceGeoId
orderContactMech.contactMechId -> PostalAddress.stateProvinceGeoId
billTo.countyGeoId
orderContactMech.contactMechId -> PostalAddress.countyGeoId
billTo.municipalityGeoId
orderContactMech.contactMechId -> PostalAddress.municipalityGeoId
billTo.postalCodeGeoId
orderContactMech.contactMechId -> PostalAddress.postalCodeGeoId
billTo.geoPointId
orderContactMech.contactMechId -> PostalAddress.geoPointId
billTo.encodedAddressKey
orderContactMech.contactMechId -> PostalAddress.encodedAddressKey
isShippingChargesSent
Define the custom variable to identify shipping charges, shipping sales tax, and whether shipping adjustments were sent or not.
returnAdjustments
List of Return Level Adjustments
returnAdjustments.returnAdjustmentId
ReturnItem.returnId -> ReturnAdjustment.returnAdjustmentId
returnAdjustments.returnId
ReturnItem.returnId -> ReturnAdjustment.returnId
returnAdjustments.returnItemSeqId
ReturnItem.returnId -> ReturnAdjustment.returnItemSeqId
returnAdjustments.returnAdjustmentTypeId
ReturnItem.returnId -> ReturnAdjustment.returnAdjustmentTypeId
returnAdjustments.amount
ReturnItem.returnId -> ReturnAdjustment.amount
customerPartyIdentifications
List of the partyIdentifications
customerPartyIdentifications.partyId
ReturnItem.returnId -> ReturnHeader.fromPartyId -> PartyIdentification.partyId
customerPartyIdentifications.partyIdentificationTypeId
ReturnItem.returnId -> ReturnHeader.fromPartyId -> PartyIdentification.partyIdentificationTypeId
customerPartyIdentifications.idValue
ReturnItem.returnId -> ReturnHeader.fromPartyId -> PartyIdentification.idValue
customerPartyIdentifications.lastUpdatedStamp
ReturnItem.returnId -> ReturnHeader.fromPartyId -> PartyIdentification.lastUpdatedStamp
payments
List of the Payment related
payments.paymentMethodCode
ReturnItem.returnId -> ReturnItemResponse.orderPaymentPreferenceId -> OrderPaymentPreference.paymentMethodTypeId -> PaymentMethodType.paymentMethodCode
payments.createdDate
ReturnItem.returnId -> ReturnItemResponse.orderPaymentPreferenceId -> OrderPaymentPreference.createdDate
payments.paymentMethodTypeId
ReturnItem.returnId -> ReturnItemResponse.orderPaymentPreferenceId -> OrderPaymentPreference.paymentMethodTypeId -> PaymentMethodType.paymentMethodTypeId
payments.paymentMethodDescription
ReturnItem.returnId -> ReturnItemResponse.orderPaymentPreferenceId -> OrderPaymentPreference.paymentMethodTypeId -> PaymentMethodType.paymentMethodDescription
payments.statusId
ReturnItem.returnId -> ReturnItemResponse.orderPaymentPreferenceId -> OrderPaymentPreference.statusId
payments.amount
ReturnItem.returnId -> ReturnItemResponse.orderPaymentPreferenceId -> OrderPaymentPreference.amount
payments.orderId
ReturnItem.returnId -> OrderPaymentPreference.orderId
tenderAmount
ReturnItem.returnId -> ReturnAdjustment.amount (Return Price * Quantity + Return Item Adjustments)
returnItems
List of the return items.
returnItems.returnId
ReturnItem.returnId
returnItems.returnItemSeqId
ReturnItem.returnItemSeqId
returnItems.orderId
ReturnItem.orderId
returnItems.orderItemSeqId
ReturnItem.orderItemSeqId
returnItems.returnItemPrice
ReturnItem.returnItemPrice
returnItems.returnQuantity
ReturnItem.returnQuantity
returnItems.returnReasonId
ReturnItem.returnReasonId
returnItems.returnReasonNote
ReturnItem.reason
returnItems.orderItemRequestedShipMethTypeId
OrderItem.returnReasonId
returnItems.productId
ReturnItem.productId
returnItems.orderName
ReturnItem.orderId -> OrderHeader.orderName
returnItems.facilityExternalId
ReturnItem.returnId -> ReturnHeader.destinationFacilityId -> Facility.externalId
returnItems.facilityId
ReturnItem.returnId -> ReturnHeader.destinationFacilityId -> Facility.facilityId
returnItems.productStoreExternalId
ReturnItem.orderId -> OrderHeader.productStoreId -> ProductStore.externalId
returnItems.currencyUom
ReturnItem.returnId -> ReturnHeader.currencyUomId -> Uom.abbreviation
returnItems.customerPartyId
ReturnItem.returnId -> ReturnHeader.fromPartyId
returnItems.shipToContactMechId
ReturnItem.returnId -> ReturnHeader.originContactMechId
returnItems.shipTo
ReturnItem.orderId -> orderContactMech.contactMechId -> PostalAddress
returnItems.billToContactMechId
ReturnItem.orderId -> orderContactMech.contactMechId -> PostalAddress.contactMechId
returnItems.billTo
ReturnItem.orderId -> orderContactMech.contactMechId -> PostalAddress
Discover how the Post Code Lookup API fetches information related to postal codes, aiding developers in various applications.
The Post Code Lookup API provides developers with the ability to fetch information related to postal codes. This API offers three main functionalities:
Fetching postal codes for a given latitude and longitude within a specified range
Fetching latitude and longitude for a given postal code
Fetching latitude and longitude for a partial postal code
Fetches the postal code for a specific location based on its latitude and longitude. The API can also return postal codes for locations within a specified distance range from the provided latitude and longitude. To get the postal code, you will need to call /postcodeLookup endpoint with the POST method.
https://<host>/api/postcodeLookup
Content-Type: application/json
q
The query parameter
N
fq
Applies a filter to the query search results
N
pt
The latitude and longitude of the location
N
d
The distance from which postal code needs to be fetched
N
Note:
pt and d parameters are required to get the post codes
d = 0 will fetch exact post code value for passed latitude and longitude
d > 0 will fetch post codes within the given distance
HTTP/1.1 200 OK
Content-Type: application/json
numfound
The number of results found
postcode
The postal code for the provided latitude and longitude
latitude
The latitude of the postal code
longitude
The longitude of the postal code
country
The country of the provided postal code
country-code-ID
The country code ID of the provided country
location
The latitude and longitude points of the postal code
Fetches the latitude longitude for a specific postal code. To look up the latitude longitude you will need to call the endpoint with the POST method.
https://<host>/api/postcodeLookup
Content-Type: application/json
postcode
The postal code
Y
HTTP/1.1 200 OK
Content-Type: application/json
postcode
The postal code for the provided latitude and longitude
latitude
The latitude of the postal code
longitude
The longitude of the postal code
country
The country of the provided postal code
country-code-ID
The country code ID of the provided country
location
The latitude and longitude points of the postal code
Fetches the latitude longitude for a partial postal code. This API fetches all the latitude and longitude matching the partial postal code. To look up the latitude longitude for a partial postal code you will need to call the endpoint with the POST method.
https://<host>/api/postcodeLookup
Content-Type: application/json
postcodelike
The partial postal code
Y
fields
The data fields or attributes that are included in the response body of the API call
Y
HTTP/1.1 200 OK
Content-Type: application/json
latitude
The latitude of the postal code
longitude
The longitude of the postal code
Explore API and data feeds within the 'inbound shipment documentatoin' documentation.
external-shipment-id
Unique identifier for the external shipment
12009298
product-sku
Product SKU (internal name)
26897
quantity
Quantity of the product being transferred
11
origin-facility-id
ID of the originating facility
116
destination-facility-id
ID of the destination facility
281
item-external-id
External identifier for the item
1
tracking-number
Tracking number associated with the shipment
788944217767
shipment-attribute
Additional attributes (e.g., EXTERNAL_ORDER_ID)
EXTERNAL_ORDER_ID:TO0005374
shipment-type
Type of the shipment (e.g., IN_TRANSFER)
IN_TRANSFER
DROP_SHIPMENT
Drop Shipment
TRANSFER
Transfer
INCOMING_SHIPMENT
Inbound Shipment
OUTGOING_SHIPMENT
Outbound Shipment
PURCHASE_SHIPMENT
INCOMING_SHIPMENT
Purchase Shipment
SALES_RETURN
INCOMING_SHIPMENT
Sales Return Shipment
IN_TRANSFER
INCOMING_SHIPMENT
Inbound Transfer Shipment
SALES_SHIPMENT
OUTGOING_SHIPMENT
Sales Shipment
OUT_TRANSFER
OUTGOING_SHIPMENT
Outbound Transfer Shipment
PURCHASE_RETURN
OUTGOING_SHIPMENT
Purchase Return Shipment
Sample Shipment file
To create a return for a customer's order that has already been fulfilled and completed, you will need to call the /createReturn endpoint with the POST method.
POST: https://{host}/api/createReturn
Content-Type: application/json
In the request body, include the information necessary for creating a return, including all the parameters listed below:
Parameter Name
Description
externalId
Order identification in the external system (e.g. Shopify or Netsuite)
customerId
Customer’s Identification in HotWax Commerce (partyId)
companyId
Identification for the Company owning the brand
currencyCode
Currency unit of measurement (USD, INR, YEN, etc.)
facilityId
Facility where order is returned
idType
Identification Type
orderId
Unique HotWax Commerce Order Identification
items
List of Order Items
orderName
Shopify Order Name
orderItemSeqId
Order Item Sequence
status
Current status of the return
grandTotal
Sum total of return items
returnIdentificationTypeId
Global Identification for the return (“SHOPIFY_RTN_ID”)
IdValue (in returnIdentification)
Unique Value for return identification
idType
Global Identification Type (SKU, INVOICE_EXPORT, ISBN, UPCA, UPCE)
idValue
Unique Id value for the global identification
shipFrom
Customer's address
shipTo
Destination address for returned order
sku
SKU for returned item
id (in item list)
Product id for that item
price
Price of the individual item
quantity
Product Quantity
orderItemExternalId (in item list)
Order Item id for external system (Shopify or Netsuite)
itemAdjustments
Record of adjustments (taxes or discounts) applied on the particular item
type
Type of return adjustments
returnAdjustments
Record of adjustments applied on the return
Types of Return Adjustments:
Return adjustments are used to categorize different return-level charges. By storing all adjustments as types of adjustments that can be applied to the return, instead of including them in the return header, they can be extended based on the needs of custom implementations and integrations.
RET_ADD_FEATURE_ADJ
Return Additional Feature
RET_DEPOSIT_ADJ
Return Deposit Adjustment
RET_DISCOUNT_ADJ
Return Discount
RET_DUTY_ADJ
RMA Duty
RET_EXT_PRM_ADJ
Return External Promotion Adjustment
RET_FEE_ADJ
Return Fee
RET_MAN_ADJ
Return Manual Adjustment
RET_MISC_ADJ
Return Miscellaneous Charges
RET_MKTG_PKG_ADJ
Return Marketing Package Adjustment
RET_PROMOTION_ADJ
Return Promotion
RET_REPLACE_ADJ
Return Replacement
RET_RMA_ADJ
RMA Fee Adjustment
RET_SALES_TAX_ADJ
Return Sales Tax
RET_SHIPPING_ADJ
Return S&H
RET_SURCHARGE_ADJ
Return Surcharge
RET_VAT_PC_ADJ
Return VAT Price Correction
RET_VAT_TAX_ADJ
Return VAT Tax
RET_WARRANTY_ADJ
Return Warranty
Content-Type: application/json
The response will include all the parameters provided in the request body, along with any error messages and login information.
Discover how the 'In Progress Orders' API fetches a comprehensive list of orders currently in the process of pickup for fulfillment.
Fetches a comprehensive list of all orders which are in process of pickup for fulfillment. To get in progress orders, you will need to call the /solr-query endpoint with the POST method.
https://<host>/api/solr-query
Example: https://demo-oms.hotwax.io/api/solr-query
Query Parameters
API Parameters
Learn how to efficiently generate packing slips in PDF format for your shipments.
Downloads a packing slip in PDF format for the shipment. To download the shipping label PDF, you will need to call the /PackingSlip.pdf endpoint with the POST method.
https://<host>/api/PackingSlip.pdf?shipmentId=<>
Downloads a packing slip in pdf format which is handed over with the shipment.
Discover how HotWax Commerce fetches a comprehensive list of outstanding orders brokered at a facility for fulfillment.
Fetches a comprehensive list of all orders that are brokered at a facility for fulfillment. To get the outstanding orders, you will need to call the /solr-query endpoint with the POST method.
https://<host>/api/solr-query
Example: https://demo-oms.hotwax.io/api/solr-query
Learn how to add a shipment box for order fulfillment with the 'Add Shipment Box' feature.
Adds a shipment box for the order for fulfillment. To add a shipment box, you will need to call the /addShipmentPackage endpoint with the POST method.
https://<host>/api/addShipmentPackage
Example: https://demo-oms.hotwax.io/api/addShipmentPackage
Learn how to create picklists for order item pickups efficiently within the 'Brokering WIP' documentation.
Creates a picklist of the order items to be picked up. To create a picklist, you will need to call the /createPicklist endpoint with the POST method.
https://<host>/api/createPicklist
Example: https://demo-oms.hotwax.io/api/createPicklist
Note: Pass the data in form format.
Discover how the Store Lookup API facilitates finding stores accepting BOPIS orders near the customer's location using the POST method.
The API allows to look up the stores accepting BOPIS orders near the customer’s location using the POST method.
https://< host >/api/storeLookup
Example: Host: https://demo-oms.hotwax.io/api/storeLookup
Content-Type: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Filter is a parameter that allows you to narrow down the results of a query or search to only include items that meet specific criteria. For storeLookup API, users can filter results for each parameter given in the response:
RETAIL
WAREHOUSE
RETAIL_STORE
OUTLET_WAREHOUSE
OUTLET_STORE
DISTRIBUTION_CENTER
rows
The number of groups
No
sort
The order of search results
No
group
Filter to group orders
Yes
group.field
The field to be grouped
Yes
group.limit
The maximum number of items allowed in the group
Yes
group.ngroups
The number of groups that have matched the query in the results. The default value is false
No
defType
Selects the query parser to be used to process the query
No
q.op
Specifies the default operator for query expressions, overriding the default operator specified in the Schema. Possible values are "AND" or "OR"
No
qf
The query fields
No
docType
Reference index
No
start
Index page number
No
orderTypeId
The ID of the order type in HotWax
Yes
picklistItemStatusID
The picking status of the order item
No
shipmentMethodTypeId
The ID of the shipment method type
No
fulfillmentStatus
The status of fulfillment which needs to be neglected
No
facilityId
The ID of the facility where fulfillment is taking place
No
orderId
The ID of the order.
orderItemSeqId
The ID of the order item sequence.
shipGroupSeqId
The ID of the ship group sequence.
inventoryItemId
The ID of the inventory item.
reservedDatetime
The time and date of reservation.
itemQuantity
The item quantity.
quantityNotAvailable
The item quantity not available at the location.
productId
The ID of the product in HotWax.
keywordSearchText
The keyword used for search.
productName
The name of the product.
spellchecker
The spellchecker.
productSku
The SKU ID of the product.
virtualProductName
The name of the parent product.
uniqueOrderItemsCount
The count of the unique order items.
picklistBinId
The ID of the picklist bin.
picklistId
The ID of the picklist.
picklistItemStatusId
The ID of the picklist item status.
picklistItemStatusDesc
The description of the picklist item status.
fulfillmentStatus
The current fulfillment status of the item.
orderDate
The date when the order was placed.
orderTypeId
The ID of the order type.
productStoreId
The ID of the product store.
orderStatusId
The ID of the order status.
customerId
The ID of the customer.
customerName
The name of the customer.
shipmentMethodTypeId
The ID of the shipment method type.
shipmentMethodTypeDesc
The description of the shipment method type.
shipmentMethodTypeSeqNum
The sequence number of the shipment method type.
facilityId
The ID of the facility.
facilityName
The name of the facility.
facilityTypeId
The ID of the facility type.
companyIds
The IDs of the companies associated with the order.
orderIdentifications
The secondary unique identifier of the order.
docType
The type of the document.
identifier
The identifier of the document.
docType-identifier
The type and identifier of the document.
rows
The number of groups.
No
group
Filter to group orders.
Yes
group.field
The field to be grouped.
Yes
group.limit
The maximum number of items allowed in the group.
Yes
group.ngroups
The number of groups that have matched the query in the results. The default value is false.
No
defType
Selects the query parser to be used to process the query.
No
q.op
Specifies the default operator for query expressions, overriding the default operator specified in the Schema. Possible values are "AND" or "OR".
No
qf
The query fields.
No
docType
Reference index.
No
quantityNotAvailable
The quantity of the item that is not available.
Yes
orderTypeId
The ID of the order type in HotWax.
Yes
orderStatusId
The ID of the order status in HotWax.
Yes
isPicked
The status of the order if picked or not. Default value: N.
No
shipmentMethodTypeId
The ID of the shipment method type.
No
fulfillmentStatus
The status of fulfilment.
No
facilityId
The ID of the facility.
No
orderId
The ID of the order.
orderItemSeqId
The ID of the order item sequence.
shipGroupSeqId
The ID of the ship group sequence.
inventoryItemId
The ID of the inventory item.
reservedDatetime
The time and date of reservation.
itemQuantity
The item quantity.
productId
The ID of the product in HotWax.
keywordSearchText
The keyword used for search.
productName
The name of the product.
spellchecker
The spellchecker.
productSku
The SKU ID of the product.
virtualProductName
The name of the parent product.
uniqueOrderItemsCount
The count of the unique order items.
isPicked
Indicates whether the item has been picked or not.
fulfillmentStatus
The current fulfillment status of the item.
orderDate
The date when the order was placed.
orderTypeId
The ID of the order type.
productStoreId
The ID of the product store.
orderStatusId
The ID of the order status.
customerId
The ID of the customer.
customerName
The name of the customer.
shipmentMethodTypeId
The ID of the shipment method type.
shipmentMethodTypeDesc
The description of the shipment method type.
shipmentMethodTypeSeqNum
The sequence number of the shipment method type.
facilityId
The ID of the facility.
facilityName
The name of the facility.
facilityTypeId
The ID of the facility type.
companyIds
The IDs of the companies associated with the order.
orderIdentifications
The secondary unique identifier of the order.
docType
The type of the document.
identifier
The identifier of the document.
docType-identifier
The type and identifier of the document separated by a hyphen.
shipmentPackageSeqId
The ID of the shipment package sequence
shipmentRouteSegmentId
The ID of the shipment route segment
shipmentId
The ID of the shipment
_EVENT_MESSAGE_
The communication message of the event
facilityId
The ID of the facility
facilityId_o_0
The ID of the picklist bin
shipmentMethodTypeId_o_0
The ID of the shipment method type
itemStatusId_o_0
The ID of the item status
shipGroupSeqId_o_0
The ID of the ship group sequence
orderId_o_0
The ID of the order
orderItemSeqId_o_0
The ID of the order item sequence
productId_o_0
The ID of the product
quantity_o_0
The quantity of the items
inventoryItemId_o_0
The ID of the inventory item
picked_o_0
The number of items to be picked
_rowSubmit_o_0
pickerIds
The ID of the picker
picklistId_o_0
The ID of the picklist
picklistBinId_o_0
The ID of the picklist bin
itemStatusId_o_0
The ID of the item status
picklistId
The ID of the picklist
picklistBinId
The ID of the picklist bin
productId_o_0
The ID of the product
viewSize
The total number of results in the API response
N
filter
Filter records based on the passed parameters
N
point
The latitude-longitude of a specific location to find nearby stores
N
distance
The distance from the passed latitude-longitude
N
sortBy
Sort data based on the attribute, for example: "storeDistance asc" sorts results by distance
N
keyword
Keyword search (only on storeName, storeCode, and externalId)
N
fieldsToSelect
The list of fields to select, all the fields can be filtered in response
N
numFound
The number of results found
docs
The array of results found
docType
Reference index
storeCode
The ID of the facility (store) in HotWax
identifier
DocType-Identifier
country
Country
storeType
The type of the store
storeName
Store Name
externalId
The Id of the store in the external reference source
primaryFacilityGroupId
The Id of the primary facility group
primaryFacilityGroupName
primaryShopifyShopId
The Id of the primary Shopify Shop
address1
The address of the store
city
City
postalCode
Postal Code
country
Country
countryCode
Country Code
stateCode
State Code
latLon
The latitude and longitude of the facility
<day_of_week>_open
The opening time of the store on the day of a week
<day_of_week>_close
The closing time of the store on the day of a week
country
Country
storeType
The type of the store
storeName
Store Name
externalId
The Id of the store in the external reference source
primaryFacilityGroupId
The Id of the primary facility group
primaryFacilityGroupName
The name of the primary facility group
primaryShopifyShopId
The Id of the primary Shopify Shop
city
City
postalCode
Postal Code
countryCode
Country Code
stateCode
State Code
latlon
The latitude and longitude of the facility
shipment ID
The ID of the shipment of groups
Yes
picklistBinId
The ID of the picklist bin
shipmentBoxTypeId
The ID of the shipment box type
Explore our 'Ready To Ship Items' page for a comprehensive list of orders picked, packed, and ready to delight your customers.
Fetches a comprehensive list of all orders items which are picked, packed and ready to ship to customers. To get ready to ship orders, you will need to call the /solr-query endpoint with the POST method.
https://<host>/api/solr-query
Example: https://demo-oms.hotwax.io/api/solr-query
rows
The number of groups.
No
sort
Sort data based on attributes.
No
group
Filter to group orders.
Yes
group.field
The field to be grouped.
Yes
group.limit
The maximum number of items allowed in the group.
Yes
group.ngroups
The number of groups that have matched the query in the results. The default value is false.
No
defType
Selects the query parser to be used to process the query.
No
q.op
Specifies the default operator for query expressions, overriding the default operator specified in the Schema. Possible values are "AND" or "OR".
No
qf
The query fields.
No
filter
Filters record based on parameters passed.
No
itemShippedDate
The filter to get orders based on their shipped date.
-
docType
Reference index.
No
start
Index page number.
No
orderTypeId
The ID of the order type in HotWax.
Yes
picklistItemStatusID
The status of the order if picked or not. Default value: N.
No
-shipmentMethodTypeId
The ID of the shipment method type which needs to be neglected.
No
shipmentMethodTypeIdFacet
The name of the facet.
No
excludeTags
Removes specific tags from facet counts.
No
mincount
Specifies the minimum counts required for a facet field to be included in the response.
No
limit
Controls how many constraints should be returned for each facet.
No
sort
Controls how faceted results are sorted.
No
type
-
No
facet
The arrangement of search results into categories based on indexed terms.
No
ordersCount
The count of orders.
No
-fulfillmentStatus
The status of fulfilment which needs to be neglected.
No
facilityId
The ID of the facility.
No
matches
The results matching the query.
ngroups
The number of unique groups in the result set.
groupValue
The value of the grouped field.
numFound
The total number of results found.
start
The offset of the first result in the result set.
orderId
The ID of the order.
orderItemSeqId
The ID of the order item sequence.
shipGroupSeqId
The ID of the ship group sequence.
inventoryItemId
The ID of the inventory item.
reservedDatetime
The date and time of reservation.
itemQuantity
The quantity of order items.
quantityNotAvailable
The quantity of items not available.
productId
The ID of the product.
keywordSearchText
The keyword used for search.
productName
The name of the product.
spellchecker
The spellchecker used.
productSku
The SKU (Stock Keeping Unit) of the product.
virtualProductName
The name of the virtual product.
uniqueOrderItemsCount
The count of unique order items.
isPicked
The status of picking.
picklistBinId
The ID of the picklist bin.
picklistId
The ID of the picklist.
picklistItemStatusId
The ID of the picklist item status.
picklistItemStatusDesc
The description of the picklist item status.
fulfillmentStatus
The status of fulfillment.
orderDate
The date when the order was placed.
orderTypeId
The ID of the order type.
productStoreId
The ID of the product store.
orderStatusId
The ID of the order status.
customerId
The ID of the customer.
customerName
The name of the customer.
maySplit
The filter for order splitting.
shipmentMethodTypeId
The ID of the shipment method type.
shipmentMethodTypeDesc
The description of the shipment method type.
shipmentMethodTypeSeqNum
The number of the shipment method type in the sequence.
facilityId
The ID of the facility.
facilityName
The name of the facility.
facilityTypeId
The ID of the facility type.
companyIds
The ID of the company.
shipmentId
The ID of the shipment.
shipmentStatusId
The ID of the shipment status.
shipmentCarrierPartyId
The ID of the shipment carrier party.
shipmentShipMethodTypeId
The ID of the shipment method type.
isManifested
The filter for document manifestation.
manifestContentId
The ID of the manifest content.
docType
The type of the document.
identifier
The identifier of the document.
docType-identifier
The type and identifier of the document separated by a hyphen.
Explore API and data feeds within the 'Shipping Label and PackingSlip' documentation.
Downloads a shipping label in PDF format for the shipment. To download the shipping label PDF, you will need to call the /LabelAndPackingSlip.pdf endpoint with the POST method.
https://<host>/api/LabelAndPackingSlip.pdf
shipment ID
The ID of the shipment of groups
Yes
Downloads a shipping label and packing slip in pdf format for the shipment.
Explore API and data feeds within the 'Shipping Label PDF' documentation.
Downloads a shipping label in PDF format for the shipment. To download the shipping label PDF, you will need to call the /ShippingLabel.pdf endpoint with the POST method.
https://<host>/api/ShippingLabel.pdf?shipmentId=<>
shipment ID
The ID of the shipment of groups
Yes
Downloads a shipping label in pdf format which is pasted on the shipment.
Discover how to redownload shipping labels in PDF format for completed shipments with HotWax Commerce.
Redownloads shipping label in PDF format for the completed shipment. To re-download the shipping label PDF, you will need to call the /retryShippingLabel endpoint with the GET method.
https://<host>/api/retryShippingLabel
shipment ID
The ID of the shipment of groups
Yes
Redownloads a shipping label for the shipment in pdf format.
Explore API and data feeds within the 'Update and Import File' documentation.
Imports shipped order details with the tracking code. To import file, you will need to call the /uploadAndImportfile endpoint with the POST method.
https://<host>/api/uploadAndImportfile
Example: https://demo-oms.hotwax.io/api/uploadAndImportfile
Note: Provide this information in form format
uploadedFile
The uploaded file
Y
configId
The datamanager configuration ID which is useed to import files
Y
uploadFileContentId
The content ID of the uploadFile
filePath
The location of a file in a web site's folder structure
_EVENT_MESSAGE_
The communication message of the event
Explore the Fulfilled Order Items Feed, containing items fulfilled from a specific facility in HotWax Commerce
The Fulfilled Order Items Feed is a JSON-formatted feed generated from HotWax Commerce OMS, organized by order. It includes order items that have been successfully fulfilled from a specific facility. This feed is crucial for updating inventory deltas to ensure accurate inventory levels in external systems like ERP. Notably, it only includes orders that have been fully fulfilled; orders with reserved items that have not yet shipped are excluded as they may still undergo rejection and re-brokering to another facility for fulfillment.
The Fulfilled Order Items Feed helps retailers who use fulfill orders through external systems but require updates to inventory deltas for maintaining accurate inventory levels, particularly within their inventory management systems like ERPs. This feed provides essential raw data directly from OMS, enabling retailers to utilize it as is or after transformation for seamless integration into external systems via file-based methods. This ensures that inventory records remain precise and up-to-date across various platforms.
The Appeasements Financial Feeed Order Items feed has certain out-of-the-box customizations that allow users to generate the feed as per the requirements.
Parameter
Description
productStoreId
Allows you to set the product store IDs to generate brand-specific feed.
itemQuantity
Ordered quantity
productId
The internal Id of the product in HotWax
facilityId
The internal Id of the facility in HotWax
facilityExternalId
The Id of the facility in the external systems
facilityTypeId
The type of the facility
ParentFacilityTypeId
The type of the parent facility, used to group various facility types.
shippedQuantity
The quantity of items shipped from the ordered quantity.
goodIdentifications
All identifications of the product in HotWax Commerce used to identify the product in external systems
goodIdentificationTypeId
The type of the unique product Identifier in the external systems (e.g. Shopify product SKU)
IdValue
The value of the GoodIdentificationTypeId
Explore HotWax Commerce's technical documentation for insights on integrating with ERP, WMS, and POS systems.
HotWax Commerce Technical Documentation is designed to provide a comprehensive understanding of the platform's integration capabilities with systems such as ERP, WMS, and POS, and how to leverage them effectively. This documentation will help navigate through the various aspects of HotWax Commerce OMS, including Journeys, APIs Data Feeds and detailed information on each API, including how to authenticate, make requests, and handle responses.
APIs allow other systems to interact with different aspects of OMS such as Orders and Inventory. The APIs provide the flexibility to perform operations such as managing inventory and fulfilling orders. The documentation provides detailed information on each API, including how to authenticate, make requests, and handle responses.
Out-of-the-box data feeds enable integration between systems such as ERP, WMS, POS, and OMS. Whether looking to synchronize inventory, update product, or import/export data, data feeds make it easy to connect HotWax Commerce with other systems. The documentation provides step-by-step instructions on how to use data feeds such as CSVs and Jsons to meet integration requirements.
Journeys represent the interactions of multiple APIs and feeds to deliver specific user experiences. The documentation will guide through the various out-of-the-box Journeys available, helping understand how to configure and customize them to meet specific business and integration needs.
Explore APIs and data feeds facilitating order brokering and allocation for a seamless customer experience.
The APIs and data feeds that connect to deliver a specific order brokering and order allocation experience.
Explore APIs and data feeds powering the Buy Online Pickup in Store (BOPIS) experience.
The APIs and data feeds that connect to deliver Buy Online Pickup in Store experience.
Learn about the Appeasements Financial Feed, a JSON-formatted refund-wise feed generated from HotWax Commerce OMS.
The Appeasements Financial Feed is a refund-wise JSON-formatted feed generated from HotWax Commerce OMS. This feed contains details about appeasements provided against the orders. The feed can be used for financial reconciliation when third-party external systems such as ERP are involved.
The Appeasements financial feed is useful for retailers who use ERP for their accounting purposes and requires financial reconciliation during specific cycles. This feed provides the out-of-the-box data available from OMS, and retailers can use it as is or after transformation to ingest into external systems through file-based integration.
The Appeasements Financial Feeed Order Items feed has certain out-of-the-box customizations that allow users to generate the feed as per the requirements.
Parameter
Description
productStoreId
Allows you to set the product store IDs to generate brand-specific feed.
The following attributes have been prepared in the feed:
returnId
HotWax Commerce Return's identification
11724
entryDate
The entry date of return in HotWax Commerce
2021-11-17T04:51:54-05:00
returnDate
The return date
null
customerPartyId
HotWax Commerce customer identification
36143
originContactMechId
The origin contact mechanism ID
null
comments
Comments regarding the return
Appeasement Shipping refund
amount
The total return amount
30
returnAdjustmentTypeId
The return adjustment type against the order
APPEASEMENT
orderName
The Shopify order identification
SMUS#8113
orderId
The HotWax Commerce Order Identification
27923
orderTypeId
The order type ID
SALES_ORDER
productStoreExternalId
The external ID of the product store
1
billTo
The order billing address
See below
shipTo
The order shipping address
See below
totalAmount
The sum total amount of all items
32.66
customerPartyIdentifications
HotWax Commerce Customer identifications
See below
payments
The payments related to order
See below
billTo
countryGeoCode
The country geo code
US
stateProvinceGeoCode
The state/province geo code
NY
contactMechId
The contact mechanism ID
101540
toName
The recipient's name
Petter William
attnName
The attention name
null
address1
The first line of the address
588 Abia Martin Drive
address2
The second line of the address
null
houseNumber
The house number
null
houseNumberExt
The house number extension
null
directions
Directions
null
city
The city
New York
cityGeoId
The city geo ID
null
postalCode
The postal code
10005
postalCodeExt
The postal code extension
null
countryGeoId
The country geo ID
USA
stateProvinceGeoId
The state/province geo ID
NY
countyGeoId
The county geo ID
null
municipalityGeoId
The municipality geo ID
null
postalCodeGeoId
The postal code geo ID
null
geoPointId
The geo point ID
25097
encodedAddressKey
The encoded address key
null
shipTo
countryGeoCode
The country geo code
US
stateProvinceGeoCode
The state/province geo code
CA
contactMechId
The contact mechanism ID
150857
toName
The recipient's name
cat lin
attnName
The attention name
null
address1
The first line of the address
830 Bay Blvd
address2
The second line of the address
null
houseNumber
The house number
null
houseNumberExt
The house number extension
null
directions
Directions
null
city
The city
Chula Vista
cityGeoId
The city geo ID
null
postalCode
The postal code
91911
postalCodeExt
The postal code extension
null
countryGeoId
The country geo ID
USA
stateProvinceGeoId
The state/province geo ID
CA
countyGeoId
The county geo ID
null
municipalityGeoId
The municipality geo ID
null
postalCodeGeoId
The postal code geo ID
null
geoPointId
The geo point ID
37116
encodedAddressKey
The encoded address key
null
customerPartyIdentifications
idValue
The value of identification
6460087566485
lastUpdatedStamp
The date and time of the last update
2022-09-19T09:29:15-04:00
partyId
HotWax Commerce's party identification
36143
partyIdentificationTypeId
The party identification type ID
SHOPIFY_CUST_ID
payments
paymentMethodCode
The payment method code
VISA
createdDate
The date and time of creation
2022-09-20T01:51:46-07:00
paymentMethodTypeId
The payment method type ID
EXT_SHOP_VISA
paymentMethodDescription
The payment method description
Ext VISA
statusId
The status ID
PAYMENT_REFUNDED
orderId
The order ID
27923
amount
The payment amount
18.03
Discover HotWax Commerce's BOPIS PDP experience enabling customers to browse all pickup store options for desired products on Shopify's PDP.
To show available pickup facilities near the customer, the latitude and longitude coordinates of the customer are required. There are two ways to obtain these coordinates:
If the customer inputs their postal code,
Use the postcodeLookup API to convert the postal code into latitude and longitude coordinates
If the customer allows access to their system location,
Obtain the latitude and longitude coordinates directly from their device
Method: POST
Request
Response
Using the latitude and longitude coordinates, call the storeLookup API to fetch all the facilities within a given distance that allow BOPIS. Note: The distance parameter is configurable to narrow down the search results. You can allow customers to input their preferred distance or set a default value.
Method: POST
Request
Response
For each store that allows BOPIS, use the checkInventory API to check the available to promise (ATP) inventory for the desired product. Display all the facilities with non-zero inventory numbers on the product detail page (PDP) for customers to select and place a BOPIS order.
Note: If a facility has 0 inventory for the product, you can still display it for the Ship-to-store PDP experience.
Method: POST
Request
Response
In case the customer's location is not available, you can display all the available store pickup locations for the product using the storeLookup API and checkInventory API. Here's how to handle this scenario:
Step 1: Call the storeLookup API without passing latitude and longitude coordinates to retrieve all facilities allowing BOPIS
Step 2: Use the facility IDs returned in the response of the storeLookup API with the checkInventory API to get the facilities having inventory for the product
Step 3: Display all the locations with non-zero inventory on the PDP
Request
Identifying In-Store Pickup Orders:
When customers add qualifying items for in-store pickup, HotWax OMS will require the order to have the line item property _pickupstore prefilled with the pickup store location.
Note: The line item property can be added by the merchant development team.
Order Download Process:
BOPIS orders placed on Shopify are downloaded into HotWax Commerce alongside regular orders via the 'New Import' job. HotWax Commerce checks the line item property and sends the order to the customer's selected pickup location without brokering. Store associates access BOPIS orders through their BOPIS fulfillment app, preparing orders for customer pickup.
Learn how to integrate Order Management System (OMS) with Marketing Automation Platforms for automated 'Ready to Pickup' email notifications.
These guidelines provide detailed steps for integrating the Order Management System (OMS) with Marketing Automation Platforms to enable the automated delivery of 'Ready to Pickup' email notifications to customers. These notifications are triggered when store staff packs the ordered items in a shipment and indicate their readiness for pickup using HotWax Commerce's BOPIS fulfillment app or Fulfillment APIs.
When store staff pack the order items and indicate their readiness for pickup, the quickShipEntireShipGroup API creates a shipment from the selected shipgroup and moves it to the "Packed" status.
orderId
The unique identifier of the order.
Yes
setPackedOnly
A flag indicating if the shipment should only be packed. If the customer is going to pickup their order at the fulfillment location, then this should be enabled to prevent the order from being marked as shipped. Default value is 'Y' if not specified.
Yes
dimensionUomId
The unit of measurement for dimensions (e.g., inches, centimeters).
Yes
shipmentBoxTypeId
The Id of the shipment box type.
Yes
weight
The weight of the package.
Yes
weightUomId
The unit of measurement for weight (e.g., pounds, kilograms).
Yes
shipGroupSeqId
The Id of the ship group sequence.
Yes
shipmentId
The Id of the shipment made.
_EVENT_MESSAGE_
The message for the event performed.
sendReadyToPickupItemNotification chained event condition action (ECA) serviceWhen the shipment status is packed, the sendReadyToPickupItemNotification chained ECA service is triggered to check the order type of the shipment and the configuration for sending ready-for-pickup emails.
The chained service works for both Store pickup and Ship to store shipments. Emails are triggered when Store pickup shipments are moved to packed status and Ship to store shipments are moved to "scheduled" status. The system responsible for sending the email and order details is configured in the following Product Store setting.
Note: Additionally, this ECA service also offers the option to manually trigger the "ready to pickup" email notification. When this ECA service is triggered, it internally initiates the email for shipment process. This feature allows users to manually initiate the sending of email notifications to inform recipients that their item is ready for pickup.
ProductStoreEmailSetting
The email settings in the Order Management System (OMS) for the product store identifier.
emailType
The type of email to be sent.
productStoreId
The Id of the product store.
subject
The subject of the email.
templateContentId
The Id of the template content.
systemMessageRemoteId
The Id of the system responsible for sending the email.
The email transmission system is identified by the parameter systemMessageRemoteId, while the information to configure the email's content is specified by the templateContentId. This templateContentId enables the OMS (Order Management System) to locate and fetch the content required for composing the email.
shipmentId
The Id of the shipment.
Yes
emailType
The type of the email.
Yes
When the marketing automation platform handles email transmission, the OMS shares the required information in JSON format, specified by the templateContentId, to the platform.
First Name
The first name of the recipient.
Last Name
The last name of the recipient.
To Facility Name
The name of the facility for pickup.
Address 1
The first line of the pickup location's address.
Address 2
The second line of the pickup location's address (if applicable).
City
The city where the pickup facility is located.
State Name
The name of the state or region where the pickup facility is located.
Country Name
The name of the country where the pickup facility is located.
Order Name
The name or reference number of the pickup order.
Product Name
The name of the product being picked up.
Quantity
The quantity of the product being picked up.
Price
The price of the product.
Image
An image or visual representation of the product.
Subtotal
The subtotal amount for the pickup order.
GrandTotal
The grand total amount for the pickup order.
Note: If the OMS is responsible for sending the email, it incorporates the data into a preconfigured email template within its system.
After recieving the required content, the marketing automation platform personalizes the customer's email using the provided details and delivers the email to the customer.
HotWax Commerce has ready integration with Listrak, a marketing automation platform. Added below is a JSON file sample
By following these steps, you can send Ready-For-Pickup email notifications from the OMS to the marketing automation platform.
Fetches data from the Order Management System (OMS) entities. By making a GET request to this endpoint, you can retrieve the required data based on specific search criteria.
https://<host>/api/performFind
Example: https://demo-oms.hotwax.io/api/performFind
Content-Type: application/json
https://demo-oms.hotwax.io/api/performFind?inputFields=&entityName=&fieldList=&fieldList=&viewSize=1
The following parameters can be sent in the request:
inputFields
Specifies search conditions for retrieving data from the OMS entities
Yes
fieldList
Defines fields or attributes of the entities to include in the response
No
entityName
The specific entity type within the OMS from which you want to fetch data
Yes
noConditionFind
Fetches all data from the specified entity without any specific conditions applied
No
viewSize
Determines the number of records or data items to be included in a single page of the response
No
viewIndex
The index to be included in the response
No
distinct
Returns only distinct (different) values.
No
orderBy
Sorts the result-set in ascending or descending order
No
filterByDate
Filter records based on fromDate and thruDate
No
fromDateName
Filter by date field name if field name is different from default fromDate field
No
thruDateName
Filter by date field name if field name is different from default thruDate field
No
Note: If noConditionFind is 'Y' then 'inputFields' parameter is optional.
HTTP/1.1 200 OK
Content-Type: application/json
The response body will include the following data:
count
Results count
docs
The array of results found
To learn more about performFind API, watch this video
Learn how to ensure accurate promise date change communication from OMS to Marketing Automation Platform.
This document outlines the steps to ensure accurate promise date change communication from the Order Management System (OMS) to the Marketing Automation Platform. This integration enhances the customer experience and reduces manual efforts.
The bulkSendPromiseDateChange service in OMS identifies all the sales order items whose promise dates have changed throughout the day. The frequency of this service can be configured according to specific requirements, but it is recommended to set it to once a day.
fromDate
The starting date and time range to find order item changes
No
toDate
The ending date and time range to find order item changes
No
The bulkSendPromiseDateChange service identifies all the updated sales order items whose promise dates have changed between the fromDate and toDate and gathers order context needed to hand off to the Marketing Automation Platform.
sendDeliveryDateChangedNotification serviceAfter bringing all the updated items in response, the bulkSendPromiseDateChange service calls the sendDeliveryDateChangedNotification service for each item.
orderId
The ID of the order in Shopify
Yes
orderItemSeqId
The numerical sequence ID of the item in the order
Yes
The sendDeliveryDateChangedNotification service identifies the configured email integration platform and picks the appropriate API template. The service then uses the input parameters orderId and orderItemSequenceID to add all the sales order items with changed promise dates in the email template being pushed to the Marketing Automation Platform.
HotWax Commerce has ready integration with Klaviyo, a marketing automation platform. Here's a sample JSON file that is shared with Klaviyo's API for each order:
The service calls the email platform's API and sends the details to the email integration platform which will then further deliver it to the customer.
Explore how APIs and data feeds connect to deliver pre-order and backorder experiences seamlessly.
The APIs and data feeds that connect to deliver Pre-orders and Backorders experience.
Explore API and data feeds within the 'Sample Return Feed' documentation.
Discover how HotWax Commerce's Soft Allocation feature conducts real-time eligibility checks for items in a customer's cart.
Hotwax Commerce's Soft Allocation feature performs real-time eligibility checks for the items in a customer's shopping cart. By evaluating the list of items in the cart along with the destination zip code, Soft Allocation ensures compliance with predefined criteria set by retailers such as checking if all items can be shipped from one location.
This process alse helps guarantee an efficient validation of shipping eligibility, aligning with the requirements of various specialty shipping carriers.
Internally, the Soft Allocation process adheres to a structured set of steps:
To check eligible shipping facilities near the customer, the latitude and longitude coordinates of the customer are required. There are two ways to obtain these coordinates:
a. If the customer inputs their postal code:
Use the API to convert the postal code into latitude and longitude coordinates. Learn more about how to use the postCodeLookup API and convert postal codes into latitudes and longitudes.
b. If the customer allows access to their system location:
Obtain the latitude and longitude coordinates directly from their device.
postCodeLookup :/POSTUtilize the checkCartInventory API to determine same-day delivery eligibility for cart items across facilities. This API evaluates eligibility based on key factors, including facility latitude and longitude and a predefined distance (typically within 50 miles for same-day delivery by carriers). The results indicate the closest facility eligible for fulfillment.
checkCartInventory:/POSTUpon receiving the response indicating facility's eligiblity for fulfillment, the application follows a systematic comparison process:
Lead Time Comparison for Same Day Delivery: The client side in-browser script compares the order preparation lead time predefined within the app with the difference between the customer's current time and the facility's closing time.
Eligibility Assessment: If the lead time is less than the time difference, the cart is deemed eligible for same-day delivery. Conversely, if the lead time exceeds the time difference, the order is marked as eligible for next-day delivery.
This structured approach ensures precise determination of delivery eligibility, providing customers with accurate information about their order's expected delivery date.
In addition to the eligibility assessment process:
a. Multiple Zip Code Exploration: The application enables customers to explore multiple zip codes directly on the product detail page and mini cart to check same-day delivery eligibility in various locations by submitting their cart against multiple times with different destination zip codes.
b. Real-time Status Updates: Customers can view the same-day delivery status not only on the product detail page but also in the cart details and the "mini cart" interface, ensuring consistent and real-time visibility of delivery options.
c. Mixed Cart Handling: If a customer's cart contains both Delivery and Buy Online, Pick Up In Store (BOPIS) items, it is suggested that the client side script submit all items for soft allocation irrespective of shipping method to provide a simple experience for the customer.
These additional features enhance the customer experience, providing flexibility and transparency in the delivery process.
Explore API and data feeds within the 'Sample Reset Inventory csv' documentation.
Discover the versions of HotWax Commerce OMS releases.
For information on previous releases, please consult the .
To find details about SOLR versions, refer to the
No SQL data to upload.
No upgrade steps to follow.
Upgrade Data
Learn how to update product inventory in HotWax by logging variances of inputted amounts.
Updates the inventory of products in HotWax by logging a variance of the inputted amount. To update inventory you will need to call the endpoint with the POST method.
Example:
https://<host>/api/service/updateInventoryByIdentification
Example:
Content-Type: application/json
To access this endpoint, you need to include the authorization token in the request header.
Authorization: Bearer <access_token>
To learn more about Bearer token authentication, read this
Sample:
Table of valid variance reasons and their IDs:
HTTP/1.1 200 OK
Content-Type: application/json
Sample:
If you are preparing a new release, use this
Release Version
v5.18.10
Release Type
Hotfix
Image Tag
v5.18.10
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest-v5.18.10
Diff
Changelog
Release Version
v5.18.9
Release Type
Hotfix
Image Tag
v5.18.9
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest-v5.18.9
Diff
Changelog
Release Version
v5.18.8
Release Type
Hotfix
Image Tag
v5.18.8
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest-v5.18.8
Diff
Changelog
Release Version
v5.18.6
Release Type
Hotfix
Image Tag
v5.18.6
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest-v5.18.6
Diff
Changelog
Release Version
v5.18.3
Release Type
Hotfix
Image Tag
v5.18.3
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest-v5.18.3
Diff
Changelog
Release Version
v5.18.2
Release Type
Hotfix
Image Tag
v5.18.2
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest-v5.18.2
Diff
Changelog
Release Version
v5.18.1
Release Type
Hotfix
Image Tag
v5.18.1
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest-v5.18.1
Diff
Changelog
Release Version
v5.18.0
Release Type
Minor
Image Tag
v5.18.0
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest
Diff
Changelog
Release Version
v5.17.17
Release Type
Hotfix
Image Tag
v5.17.17
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.17.17
Diff
Changelog
Release Version
v5.17.16
Release Type
Hotfix
Image Tag
v5.17.16
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.17.16
Diff
Changelog
Release Version
v5.17.14
Release Type
Hotfix
Image Tag
v5.17.14
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.17.14
Diff
Changelog
Release Version
v5.17.11
Release Type
Hotfix
Image Tag
v5.17.11
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.17.11
Diff
Changelog
Release Version
v5.17.10
Release Type
Hotfix
Image Tag
v5.17.10
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.17.10
Diff
Changelog
Release Version
v5.17.9
Release Type
Hotfix
Image Tag
v5.17.9
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.17.9
Diff
Changelog
Release Version
v5.17.8
Release Type
Hotfix
Image Tag
v5.17.8
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.17.8
Diff
Changelog
Release Version
v5.17.7
Release Type
Hotfix
Image Tag
v5.17.7
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.17.7
Diff
Changelog
Release Version
v5.17.6
Release Type
Hotfix
Image Tag
v5.17.6
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.17.6
Diff
Changelog
Release Version
v5.17.5
Release Type
Hotfix
Image Tag
v5.17.5
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.17.5
Diff
Changelog
Release Version
v5.17.4
Release Type
Hotfix
Image Tag
v5.17.4
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.17.4
Diff
Changelog
Release Version
v5.17.3
Release Type
Hotfix
Image Tag
v5.17.3
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.17.3
Diff
Changelog
Release Version
v5.17.2
Release Type
Hotfix
Image Tag
v5.17.2
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.17.2
Diff
Changelog
Release Version
v5.17.1
Release Type
Hotfix
Image Tag
v5.17.1
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.17.1
Diff
Changelog
Release Version
v5.17.0
Release Type
Minor
Image Tag
v5.17.0
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest
Diff
Changelog
Release Version
v5.16.13
Release Type
Hotfix
Image Tag
v5.16.13
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.16.13
Diff
Changelog
Release Version
v5.16.12
Release Type
Hotfix
Image Tag
v5.16.12
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.16.12
Diff
Changelog
Release Version
v5.16.11
Release Type
Hotfix
Image Tag
v5.16.11
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.16.11
Diff
Changelog
Release Version
v5.16.10
Release Type
Hotfix
Image Tag
v5.16.10
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.16.10
Diff
Changelog
Release Version
v5.16.9
Release Type
Hotfix
Image Tag
v5.16.9
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.16.9
Diff
Changelog
Release Version
v5.16.8
Release Type
Hotfix
Image Tag
v5.16.8
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.16.8
Diff
Changelog
Release Version
v5.16.7
Release Type
Hotfix
Image Tag
v5.16.7
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.16.7
Diff
Changelog
Release Version
v5.16.6
Release Type
Hotfix
Image Tag
v5.16.6
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.16.6
Diff
Changelog
Release Version
v5.16.5
Release Type
Hotfix
Image Tag
v5.16.5
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.16.5
Diff
Changelog
Release Version
v5.16.2
Release Type
Minor
Image Tag
v5.16.2
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest
Diff
Changelog
Release Version
v5.15.8
Release Type
Hotfix
Image Tag
v5.15.8
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.15.8
Diff
Changelog
Release Version
v5.15.7
Release Type
Hotfix
Image Tag
v5.15.7
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.15.7
Diff
Changelog
Release Version
v5.15.5
Release Type
Hotfix
Image Tag
v5.15.5
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.15.5
Diff
Changelog
Release Version
v5.15.4
Release Type
Hotfix
Image Tag
v5.15.4
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.15.4
Diff
Changelog
Release Version
v5.15.3
Release Type
Hotfix
Image Tag
v5.15.3
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.15.3
Diff
Changelog
Release Version
v5.15.2
Release Type
Hotfix
Image Tag
v5.15.2
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.15.2
Diff
Changelog
Release Version
v5.15.1
Release Type
Hotfix
Image Tag
v5.15.1
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.15.1
Diff
Changelog
Release Version
v5.15.0
Release Type
Minor
Image Tag
v5.15.0
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest
Diff
Changelog
Release Version
v5.14.9
Release Type
Hotfix
Image Tag
v5.14.9
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.14.9
Diff
Changelog
Release Version
v5.14.7
Release Type
Hotfix
Image Tag
v5.14.7
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.14.7
Diff
Changelog
Release Version
v5.14.6
Release Type
Hotfix
Image Tag
v5.14.6
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.14.6
Diff
Changelog
Release Version
v5.14.5
Release Type
Hotfix
Image Tag
v5.14.5
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.14.5
Diff
Changelog
Release Version
v5.14.4
Release Type
Hotfix
Image Tag
v5.14.4
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.14.4
Diff
Changelog
Release Version
v5.14.3
Release Type
Hotfix
Image Tag
v5.14.3
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.14.3
Diff
Changelog
Release Version
v5.14.2
Release Type
Hotfix
Image Tag
v5.14.2
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.14.2
Diff
Changelog
Release Version
v5.14.1
Release Type
Hotfix
Image Tag
v5.14.1
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.14.1
Diff
Changelog
Release Version
v5.14.0
Release Type
Minor
Image Tag
v5.14.0
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest
Diff
Changelog
Release Version
v5.13.11
Release Type
Hotfix
Image Tag
v5.13.11
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.13.10
Diff
Changelog
Release Version
v5.13.10
Release Type
Hotfix
Image Tag
v5.13.10
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.13.10
Diff
Changelog
Release Version
v5.13.9
Release Type
Hotfix
Image Tag
v5.13.9
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.13.9
Diff
Changelog
Release Version
v5.13.8
Release Type
Hotfix
Image Tag
v5.13.8
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.13.8
Diff
Changelog
Release Version
v5.13.7
Release Type
Hotfix
Image Tag
v5.13.7
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.13.7
Diff
Changelog
Release Version
v5.13.6
Release Type
Hotfix
Image Tag
v5.13.6
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.13.6
Diff
Changelog
Release Version
v5.13.4
Release Type
Hotfix
Image Tag
v5.13.4
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.13.4
Diff
Changelog
Release Version
v5.13.3
Release Type
Hotfix
Image Tag
v5.13.3
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.13.3
Diff
Changelog
Release Version
v5.13.2
Release Type
Hotfix
Image Tag
v5.13.2
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.13.2
Diff
Changelog
Release Version
v5.13.1
Release Type
Hotfix
Image Tag
v5.13.1
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.13.1
Diff
Changelog
Release Version
v5.13.0
Release Type
Minor
Image Tag
v5.13.0
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest
Diff
Changelog
Release Version
v5.12.10
Release Type
Hotfix
Image Tag
v5.12.10
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.12.10
Diff
Changelog
Release Version
v5.12.9
Release Type
Hotfix
Image Tag
v5.12.9
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.12.9
Diff
Changelog
Release Version
v5.12.7
Release Type
Hotfix
Image Tag
v5.12.7
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.12.7
Diff
Changelog
Release Version
v5.12.5
Release Type
Hotfix
Image Tag
v5.12.5
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.12.5
Diff
Changelog
Release Version
v5.12.4
Release Type
Hotfix
Image Tag
v5.12.4
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.12.4
Diff
Changelog
Release Version
v5.12.3
Release Type
Hotfix
Image Tag
v5.12.3
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.12.3
Diff
Changelog
Release Version
v5.12.2
Release Type
Hotfix
Image Tag
v5.12.2
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.12.2
Diff
Changelog
Release Version
v5.12.1
Release Type
Hotfix
Image Tag
v5.12.1
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.12.1
Diff
Changelog
Release Version
v5.12.0
Release Type
Minor
Image Tag
v5.12.0
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest
Diff
Changelog
Release Version
v5.11.5
Release Type
Hotfix
Image Tag
v5.11.5
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.11.5
Diff
Changelog
Release Version
v5.11.4
Release Type
Hotfix
Image Tag
v5.11.4
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.11.4
Diff
Changelog
Release Version
v5.11.3
Release Type
Hotfix
Image Tag
v5.11.3
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.11.3
Diff
Changelog
Release Version
v5.11.2
Release Type
Hotfix
Image Tag
v5.11.2
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.11.2
Diff
Changelog
Release Version
v5.11.1
Release Type
Hotfix
Image Tag
v5.11.1
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.11.1
Diff
Changelog
Release Version
v5.11.0
Release Type
Minor
Image Tag
v5.11.0
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest
Diff
Changelog
Release Version
v5.10.6
Release Type
Hotfix
Image Tag
v5.10.6
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.10.6
Diff
Changelog
Release Version
v5.10.5
Release Type
Hotfix
Image Tag
v5.10.5
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.10.5
Diff
Changelog
Release Version
v5.10.4
Release Type
Hotfix
Image Tag
v5.10.4
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.10.4
Diff
Changelog
Release Version
v5.10.3
Release Type
Hotfix
Image Tag
v5.10.3
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.10.3
Diff
Changelog
Release Version
v5.10.2
Release Type
Hotfix
Image Tag
v5.10.2
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.10.2
Diff
Changelog
Release Version
v5.10.1
Release Type
Hotfix
Image Tag
v5.10.1
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.10.1
Diff
Changelog
Release Version
v5.10.0
Release Type
Minor
Image Tag
v5.10.0
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest
Diff
Changelog
Release Version
v5.9.5
Release Type
Hotfix
Image Tag
v5.9.5
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.9.5
Diff
Changelog
Release Version
v5.9.4
Release Type
Hotfix
Image Tag
v5.9.4
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.9.4
Diff
Changelog
Release Version
v5.9.3
Release Type
Hotfix
Image Tag
v5.9.3
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.9.3
Diff
Changelog
Release Version
v5.9.2
Release Type
Hotfix
Image Tag
v5.9.2
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.9.2
Diff
Changelog
Release Version
v5.9.1
Release Type
Hotfix
Image Tag
v5.9.1
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.9.1
Diff
Changelog
Release Version
v5.9.0
Release Type
Minor
Image Tag
v5.9.0
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:v5.9.0
Diff
Changelog
Release Version
v5.8.9
Release Type
Hotfix
Image Tag
v5.8.9
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.8.9
Diff
Changelog
Release Version
v5.8.3
Release Type
Hotfix
Image Tag
v5.8.3
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.8.3
Diff
Changelog
Release Version
v5.8.2
Release Type
Hotfix
Image Tag
v5.8.2
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.8.2
Diff
Changelog
Release Version
v5.8.1
Release Type
Hotfix
Image Tag
v5.8.1
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.8.1
Diff
Changelog
Release Version
v5.8.0
Release Type
Minor
Image Tag
v5.8.0
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest
Diff
Changelog
Release Version
v5.7.6
Release Type
Hotfix
Image Tag
v5.7.6
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.7.6
Diff
Changelog
Release Version
v5.7.4
Release Type
Hotfix
Image Tag
v5.7.4
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.7.4
Diff
Changelog
Release Version
v5.7.3
Release Type
Hotfix
Image Tag
v5.7.3
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.7.3
Diff
Changelog
Release Version
v5.7.0
Release Type
Minor
Image Tag
v5.7.0
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest
Diff
Changelog
Release Version
v5.6.2
Release Type
Hotfix
Image Tag
v5.6.2
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.6.2
Diff
Changelog
Release Version
v5.6.1
Release Type
Hotfix
Image Tag
v5.6.1
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.6.1
Diff
Changelog
Release Version
v5.6.0
Release Type
Minor
Image Tag
v5.6.0
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest
Diff
Changelog
Release Version
v5.5.6
Release Type
Hotfix
Image Tag
v5.5.6
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.5.6
Diff
Changelog
Release Version
v5.5.5
Release Type
Hotfix
Image Tag
v5.5.5
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.5.5
Diff
Changelog
Release Version
v5.5.4
Release Type
Hotfix
Image Tag
v5.5.4
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.5.4
Diff
Changelog
Release Version
v5.5.3
Release Type
Hotfix
Image Tag
v5.5.3
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.5.3
Diff
Changelog
Release Version
v5.5.1
Release Type
Hotfix
Image Tag
v5.5.1
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.5.1
Diff
Changelog
Release Version
v5.5.0
Release Type
Minor
Image Tag
v5.5.0
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest
Diff
Changelog
Release Version
v5.4.5
Release Type
Hotfix
Image Tag
v5.4.5
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.4.5
Diff
Changelog
Release Version
v5.4.3
Release Type
Hotfix
Image Tag
v5.4.3
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.4.3
Diff
Changelog
Release Version
v5.4.1
Release Type
Hotfix
Image Tag
v5.4.1
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.4.1
Diff
Changelog
Release Version
v5.4.0
Release Type
Minor
Image Tag
v5.4.0
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest
Diff
Changelog
Release Version
v5.3.3
Release Type
Hotfix
Image Tag
v5.3.3
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.3.3
Diff
Changelog
Release Version
v5.3.2
Release Type
Hotfix
Image Tag
v5.3.2
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.3.2
Diff
Changelog
Release Version
v5.3.0
Release Type
Minor
Image Tag
v5.3.0
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest
Diff
Changelog
Release Version
v5.2.1
Release Type
Hotfix
Image Tag
v5.2.1
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-v5.2.1
Diff
Changelog
Release Version
v5.2.0
Release Type
Minor
Image Tag
v5.2.0
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest
Diff
Changelog
Release Version
v5.1.0
Release Type
Minor
Image Tag
v5.1.0
Image URL
[Latest Image URL]
Diff
Changelog
idType
The type of product identifier. Currently supported ID types are SKU, UPCA,Shopify_Prod_ID
Y
idValue
The value of product identifier
Y
availableDelta
The variance in inventory quantity(delta)
Y
facilityId
The external facility ID where inventory item needs to be updated
Y
locationSeqId
The location ID in the facility where inventory item needs to be updated
Y
varianceReasonId
The ID of the reason that caused variance in inventory
Y
MISMATCH
Inventory does not match the available SKU
NOT_IN_STOCK
SKU is not available
NO_VARIANCE_LOG
Use to pass null variance where variance field is required but not used
REJ_RSN_DAMAGED
Ordered SKU is rejected due to inventory damage
POS_SALE
Inventory consumed by sales made on an external point of sale system in the store
VAR_DAMAGED
Reduce damaged inventory from available quantity
VAR_LOST
SKU inventory is lost
VAR_FOUND
Lost SKU inventory is found
WORN_DISPLAY
SKU inventory is worn and unsuable from being on display
VAR_MANUAL
SKU inventory adjustment is done manually
Release Version
v5.18.13
Release Type
Hotfix
Image Tag
v5.18.13
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest-v5.18.13
Diff
Changelog
Release Version
v5.18.11
Release Type
Hotfix
Image Tag
v5.18.11
Image URL
289432782788.dkr.ecr.us-east-1.amazonaws.com/omscoreimage:omscoreimage-latest-v5.18.11
Diff
Changelog
Learn how to update orders in progress yet to be shipped with HotWax Commerce using the updateOrder endpoint and POST method.
Updates orders that are currently in progress and have not yet been shipped, to update the orders, you will need to call the updateOrder endpoint with the POST method. There are two main reasons for updating orders: changing the shipment box and rejecting specific order items.
https://<host>/api/updateOrder
Example: https://demo-oms.hotwax.io/api/updateOrder
Body
Note: Pass this information as a form data.
Body
Body
Body
facilityId
The ID of the facility.
Yes
box_shipmentId_0
The shipment ID of the item.
Yes
0_box_rowSubmit
The row in the order where the item belongs.
Yes
box_shipmentBoxTypeId_0
The box type of the shipment.
Yes
rej_shipmentId_0
The ID of the rejected shipment item.
Yes
rej_shipmentItemSeqId_0
The sequence ID of the rejected shipment ID.
No
0_rej_rowSubmit_
The row in the order where the rejected shipment item belongs.
No
rej_rejectionReason_0
The reason for rejecting the order item.
Yes
facilityId
The ID of the facility.
Yes
box_shipmentId_1
The shipment ID of the item.
Yes
1_box_rowSubmit
The row in the order where the item belongs.
Yes
box_shipmentBoxTypeId_1
The box type of the shipment.
Yes
rtp_shipmentId_0
The ID of the ready to pack shipment item.
Yes
rtp_shipmentItemSeqId_0
The sequence ID of the ready to pack shipment ID.
No
0_rtp_rowSubmit_
The row in the order where the ready to pack shipment item belongs.
No
rtp_rejectionReason_0
The reason for rejecting the ready to pack order item.
Yes