1 of 58

Integrate with HotWax

Introduction

Read 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

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.

Data Feeds

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

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.

HotWax Commerce API and Data feeds

Authentication

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

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.

How to generate a bearer token?

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

Authentication Endpoint

Sample endpoint: https://<host_name>.hotwax.io/<api_name>/login

APIs Requiring Authentication

The following HotWax APIs require an authentication token:

updateInventory

For more information about Bearer token authentication, refer to this video.

Orders

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.

Get Orders

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.

Request

End Point https://<instance.name>.hotwax.io/api/<publish_point>/orders

Example: https://demo-oms.hotwax.io/api/<publish_point>/orders

Headers

Authorization: Bearer <your_token>
Accept: application/json

Request Format

{
  "viewIndex": "",
  "viewSize": "1",
  "filters": {
    "partyId": "",
    "partyId_op": "",
    "partyId_ic": ""
  }
}

Parameter Table

Parameter

Description

viewIndex

Index of the view in pagination.

viewSize

Number of records to fetch per page.

filters

Filters to apply for querying specific orders.

Filters Usage

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).

Example

{
  "filters": {
    "externalId": "10025",
    "externalId_op": "equals",
    "externalId_ic": "Y"
  }
}

This example will fetch all the orders where externalId is 10025, with case-insensitive matching (ignore case set to Y).

Response

Status Code

HTTP/1.1 200 OK

Headers

Content-Type: application/json

Body

{
  "count": "2",
  "docs": [
    {
      "id": "",
      "externalId": "",
      "orderName": "",
      "channel": "",
      "channelDesc": "",
      "customerId": "",
      "customerExternalId": "",
      "customerName": "",
      "priority": "",
      "orderDate": "",
      "entryDate": "",
      "expireDate": "",
      "statusId": "",
      "statusDesc": "",
      "productStoreId": "",
      "productStoreName": "",
      "webSiteId": "",
      "webSiteName": "",
      "currencyCode": "",
      "currencyCodeDesc": "",
      "remainingSubTotal": null,
      "grandTotal": null,
      "tags": "",
      "note": "",
      "orderContacts": {
        "email": {
          "id": "",
          "externalId": ""
        }
      },
      "orderIdentifications": [
        {
          "orderIdentificationTypeId": "",
          "orderIdentificationDesc": "",
          "idValue": ""
        }
      ],
      "shipGroup": [
        {
          "facilityId": "",
          "externalId": "",
          "facilityName": "",
          "maySplit": "",
          "shipBy": "",
          "shipAfter": "",
          "carrierPartyId": "",
          "shipmentMethodTypeId": "",
          "carrierPartyName": "",
          "trackingNumber": "",
          "shipFrom": {
            "postalAddress": {
              "id": "",
              "externalId": "",
              "address1": "",
              "address2": "",
              "city": "",
              "stateCode": "",
              "postalCode": "",
              "country": ""
            },
            "email": {
              "id": "",
              "externalId": "",
              "email": ""
            },
            "phoneNumber": {
              "id": "",
              "externalId": "",
              "areaCode": "",
              "contactNumber": ""
            }
          },
          "shipTo": {
            "postalAddress": {
              "id": "",
              "externalId": "",
              "toName": "",
              "address1": "",
              "address2": "",
              "city": "",
              "stateCode": "",
              "postalCode": "",
              "country": ""
            },
            "email": {
              "id": "",
              "externalId": "",
              "email": ""
            },
            "phoneNumber": {
              "id": "",
              "externalId": "",
              "areaCode": "",
              "contactNumber": ""
            }
          },
          "items": [
            {
              "itemSeqId": "",
              "itemExternalId": "",
              "productId": "",
              "sku": "",
              "name": "",
              "status": "",
              "quantity": null,
              "unitPrice": null,
              "unitListPrice": null,
              "itemAdjustments": [
                {
                  "id": "",
                  "type": "",
                  "comments": "",
                  "amount": null,
                  "sourcePercentage": null
                }
              ]
            }
          ]
        }
      ],
      "orderAdjustments": [
        {
          "id": "",
          "type": "",
          "typeDesc": "",
          "comments": "",
          "amount": null,
          "sourcePercentage": null
        }
      ],
      "orderPaymentPref": [
        {
          "id": "",
          "paymentMethodTypeId": "",
          "paymentMethodTypeDesc": "",
          "paymentMode": "",
          "cardName": "",
          "code": "",
          "maxAmount": null,
          "statusId": "",
          "statusDesc": ""
        }
      ],
      "billTo": {
        "postalAddress": {
          "id": "",
          "externalId": "",
          "toName": "",
          "address1": "",
          "address2": "",
          "city": "",
          "stateCode": "",
          "postalCode": "",
          "country": ""
        },
        "email": {
          "id": "",
          "externalId": "",
          "email": ""
        },
        "phoneNumber": {
          "id": "",
          "externalId": "",
          "areaCode": "",
          "contactNumber": ""
        }
      },
      "billFrom": {
        "id": "",
        "externalId": "",
        "name": "",
        "postalAddress": {
          "id": "",
          "externalId": "",
          "address1": "",
          "address2": "",
          "city": "",
          "stateCode": "",
          "postalCode": "",
          "country": ""
        },
        "email": {
          "id": "",
          "externalId": "",
          "email": ""
        },
        "phoneNumber": {
          "id": "",
          "externalId": "",
          "areaCode": "",
          "contactNumber": ""
        }
      }
    }
  ]
}

Parameter Table

Parameter

Description

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 Reconciliations

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.

Request

End Point https://<instance.name>.hotwax.io/api/solr-query

Example: https://demo-oms.hotwax.io/api/solr-query

Request Format

Parameter Table

Response

Body

Sample

Parameter Table

Inventory

Explore API and data feeds within the 'Inventory' documentation.

Brokering

Explore API and data feeds within the 'Brokering' documentation.

Inbound Shipment

Explore API and data feeds within the 'Inbound Shipment' documentation

Facility

Explore API and data feeds within the 'Facility' documentation.

Fulfillment

Explore API and data feeds within the 'Fulfillment' documentation.

Appeasements

Check API and data feeds within the 'Appeasements' documentation.

Miscellaneous

Explore API and data feeds within the 'Miscellaneous' documentation.

Journeys

Sample Files

OMS Release Versions

Get Orders

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.

Request

End Point https://<instance.name>.hotwax.io/api/<publish_point>/orders

Example: https://demo-oms.hotwax.io/api/<publish_point>/orders

Headers

Authorization: Bearer <your_token>
Accept: application/json

Request Format

{
  "viewIndex": "",
  "viewSize": "1",
  "filters": {
    "partyId": "",
    "partyId_op": "",
    "partyId_ic": ""
  }
}

Parameter Table

Parameter

Description

viewIndex

Index of the view in pagination.

viewSize

Number of records to fetch per page.

filters

Filters to apply for querying specific orders.

Filters Usage

Filters allow users to query orders based on various fields. The structure of the filter includes:

Example

{
  "filters": {
    "externalId": "10025",
    "externalId_op": "equals",
    "externalId_ic": "Y"
  }
}

This example will fetch all the orders where externalId is 10025, with case-insensitive matching (ignore case set to Y).

Response

Status Code

HTTP/1.1 200 OK

Headers

Content-Type: application/json

Body

{
  "count": "2",
  "docs": [
    {
      "id": "",
      "externalId": "",
      "orderName": "",
      "channel": "",
      "channelDesc": "",
      "customerId": "",
      "customerExternalId": "",
      "customerName": "",
      "priority": "",
      "orderDate": "",
      "entryDate": "",
      "expireDate": "",
      "statusId": "",
      "statusDesc": "",
      "productStoreId": "",
      "productStoreName": "",
      "webSiteId": "",
      "webSiteName": "",
      "currencyCode": "",
      "currencyCodeDesc": "",
      "remainingSubTotal": null,
      "grandTotal": null,
      "tags": "",
      "note": "",
      "orderContacts": {
        "email": {
          "id": "",
          "externalId": ""
        }
      },
      "orderIdentifications": [
        {
          "orderIdentificationTypeId": "",
          "orderIdentificationDesc": "",
          "idValue": ""
        }
      ],
      "shipGroup": [
        {
          "facilityId": "",
          "externalId": "",
          "facilityName": "",
          "maySplit": "",
          "shipBy": "",
          "shipAfter": "",
          "carrierPartyId": "",
          "shipmentMethodTypeId": "",
          "carrierPartyName": "",
          "trackingNumber": "",
          "shipFrom": {
            "postalAddress": {
              "id": "",
              "externalId": "",
              "address1": "",
              "address2": "",
              "city": "",
              "stateCode": "",
              "postalCode": "",
              "country": ""
            },
            "email": {
              "id": "",
              "externalId": "",
              "email": ""
            },
            "phoneNumber": {
              "id": "",
              "externalId": "",
              "areaCode": "",
              "contactNumber": ""
            }
          },
          "shipTo": {
            "postalAddress": {
              "id": "",
              "externalId": "",
              "toName": "",
              "address1": "",
              "address2": "",
              "city": "",
              "stateCode": "",
              "postalCode": "",
              "country": ""
            },
            "email": {
              "id": "",
              "externalId": "",
              "email": ""
            },
            "phoneNumber": {
              "id": "",
              "externalId": "",
              "areaCode": "",
              "contactNumber": ""
            }
          },
          "items": [
            {
              "itemSeqId": "",
              "itemExternalId": "",
              "productId": "",
              "sku": "",
              "name": "",
              "status": "",
              "quantity": null,
              "unitPrice": null,
              "unitListPrice": null,
              "itemAdjustments": [
                {
                  "id": "",
                  "type": "",
                  "comments": "",
                  "amount": null,
                  "sourcePercentage": null
                }
              ]
            }
          ]
        }
      ],
      "orderAdjustments": [
        {
          "id": "",
          "type": "",
          "typeDesc": "",
          "comments": "",
          "amount": null,
          "sourcePercentage": null
        }
      ],
      "orderPaymentPref": [
        {
          "id": "",
          "paymentMethodTypeId": "",
          "paymentMethodTypeDesc": "",
          "paymentMode": "",
          "cardName": "",
          "code": "",
          "maxAmount": null,
          "statusId": "",
          "statusDesc": ""
        }
      ],
      "billTo": {
        "postalAddress": {
          "id": "",
          "externalId": "",
          "toName": "",
          "address1": "",
          "address2": "",
          "city": "",
          "stateCode": "",
          "postalCode": "",
          "country": ""
        },
        "email": {
          "id": "",
          "externalId": "",
          "email": ""
        },
        "phoneNumber": {
          "id": "",
          "externalId": "",
          "areaCode": "",
          "contactNumber": ""
        }
      },
      "billFrom": {
        "id": "",
        "externalId": "",
        "name": "",
        "postalAddress": {
          "id": "",
          "externalId": "",
          "address1": "",
          "address2": "",
          "city": "",
          "stateCode": "",
          "postalCode": "",
          "country": ""
        },
        "email": {
          "id": "",
          "externalId": "",
          "email": ""
        },
        "phoneNumber": {
          "id": "",
          "externalId": "",
          "areaCode": "",
          "contactNumber": ""
        }
      }
    }
  ]
}

Parameter Table

Parameter

Description

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).