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

# Introduction

HotWax Commerce technical documentation helps you integrate the platform with external systems such as enterprise resource planning (ERP), warehouse management systems (WMS), and point of sale (POS) systems. Use HotWax Commerce Omnichannel Order Management System (OMS) capabilities to manage orders, inventory, and fulfillment workflows.

Use the following resources to plan and build an integration:

* [APIs](/documents/integrate-with-hotwax/hotwax-commerce-api-and-data-feeds/orders.md) for requests, responses, and endpoint-specific examples
* [Data feeds](/documents/integrate-with-hotwax/hotwax-commerce-api-and-data-feeds/fulfillment/fulfilled-order-items-feed.md) for OMS data sent to external systems
* [Journeys](/documents/integrate-with-hotwax/journeys/buy-online-pickup-in-store.md) for end-to-end business workflows

## APIs

APIs enable external systems to interact with HotWax Commerce OMS for operations such as order management, inventory updates, and fulfillment processing.

Start with [authentication](/documents/integrate-with-hotwax/hotwax-commerce-api-and-data-feeds/initial-api-authentication.md), then use the API documentation for request and response structures, available endpoints, and their use cases.

### Example: Retrieve orders

Use the [Get Orders API](/documents/integrate-with-hotwax/hotwax-commerce-api-and-data-feeds/orders/get-orders.md) to retrieve existing order documents from OMS. Send a `GET` request with a bearer token:

```http
GET https://<instance.name>.hotwax.io/api/<publish_point>/orders
Authorization: Bearer <your_token>
Accept: application/json
```

The response includes a `count` and a `docs` array. Each document contains order details, including the external order ID, status, and ship groups.

## Data feeds

Out-of-the-box data feeds facilitate integration between HotWax Commerce OMS and external systems such as ERP, WMS, and POS.

They support use cases such as:

* Inventory synchronization
* Product data updates
* Operational data import and export

The data-feed documentation includes step-by-step guidance and sample files in CSV and JSON formats.

### Example: Send fulfillment data to an ERP

Use the [Fulfilled Order Items Feed](/documents/integrate-with-hotwax/hotwax-commerce-api-and-data-feeds/fulfillment/fulfilled-order-items-feed.md) to send OMS fulfillment data to an ERP. The JSON feed contains completed order items from a specific facility, including fields such as `productStoreId`, `orderId`, `orderName`, and `orderStatusId`.

## Journeys

Journeys represent end-to-end business workflows powered by a combination of APIs and data feeds.

They help you:

* Understand real-world integration flows
* Configure out-of-the-box journeys
* Customize workflows based on business requirements

The journey documentation explains the available journeys and how to adapt them for specific operational needs.

## Example integration flow

Use the following flow to update an ERP after order fulfillment:

1. Create an integration user and generate a bearer token using the [authentication guide](/documents/integrate-with-hotwax/hotwax-commerce-api-and-data-feeds/initial-api-authentication.md).
2. Use the [Get Orders API](/documents/integrate-with-hotwax/hotwax-commerce-api-and-data-feeds/orders/get-orders.md) to retrieve order documents and identify the order data your integration needs.
3. Consume the [Fulfilled Order Items Feed](/documents/integrate-with-hotwax/hotwax-commerce-api-and-data-feeds/fulfillment/fulfilled-order-items-feed.md) after OMS fully fulfills an order from a facility.
4. Map the feed's completed order item data to the ERP's inventory update format.


---

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

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.hotwax.co/documents/integrate-with-hotwax/readme.md?ask=<question>&goal=<endgoal>
```

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

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.