> For the complete documentation index, see [llms.txt](https://developer.esw.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.esw.com/light-touch-integration/features/order-status-synchronization.md).

# Order Status Synchronization

ESW Light Touch Integration (LTI) can synchronize key order statuses from ESW back to your e-commerce platform. This reduces manual updates and helps keep order views aligned across systems.

The following statuses can be synchronized automatically:

<table data-view="cards"><thead><tr><th>Status</th><th>Description</th></tr></thead><tbody><tr><td>Order Completed</td><td>Set after the shopper completes payment successfully and the purchase is finalized.</td></tr><tr><td>Order Cancelled</td><td>Set when the order is canceled.</td></tr><tr><td>Order Refunded</td><td>Set when the full order is refunded.</td></tr><tr><td>Partially Refunded</td><td>Set when individual items are refunded. This status is available only on Callback API.</td></tr></tbody></table>

{% hint style="info" %}
Not every ESW order status is synchronized through LTI. ESW remains the source of truth for the full order lifecycle. If you need broader coverage, subscribe to events and update statuses from those event streams.
{% endhint %}

### Supported LTI platforms

<table data-view="cards"><thead><tr><th>Platform</th><th>Description</th></tr></thead><tbody><tr><td>BigCommerce</td><td>Supports order status synchronization through the standard LTI integration path.</td></tr><tr><td>WooCommerce</td><td>Supports order status synchronization through the standard LTI integration path.</td></tr><tr><td>Commerce Tools</td><td>Supports order status synchronization through the standard LTI integration path.</td></tr><tr><td>Callback API</td><td>Supports order status synchronization through the custom LTI integration path.</td></tr></tbody></table>

### Changing order status

You do not need to update supported order statuses manually in your e-commerce platform. ESW status sync updates them automatically when the order status changes in ESW.

This reduces the need to move between systems and keeps the shopper order journey more consistent across channels.

### How it works

{% stepper %}
{% step %}

#### Track the ESW order state

ESW manages the order state internally as the order moves through checkout, cancellation, and refund flows.
{% endstep %}

{% step %}

#### Detect supported status changes

LTI listens for supported ESW status changes and maps them to your connected commerce platform.
{% endstep %}

{% step %}

#### Update the commerce platform

For BigCommerce, WooCommerce, and Commerce Tools, LTI updates the order directly through the platform APIs.
{% endstep %}

{% step %}

#### Update custom platforms through the callback

For Callback API, LTI calls your `UpdateOrder` endpoint with a `PATCH` request to apply the status update.
{% endstep %}
{% endstepper %}

### Configuration

* For WooCommerce, Commerce Tools, and BigCommerce, no extra setup is required beyond enabling the feature.
* For Callback API, LTI uses the `UpdateOrder` endpoint to update order statuses in your system.

{% hint style="info" %}

#### Notes

* An order is marked as **completed** when payment succeeds at checkout.
* Shoppers can cancel orders before shipment. After shipment, cancellation is no longer possible.
* When cancellation succeeds, the refund can be managed through ESW Customer Service Portal.
* Total and partial returns or refunds are handled through the Returns Portal.
  {% endhint %}


---

# 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://developer.esw.com/light-touch-integration/features/order-status-synchronization.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.