> 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/order-api/order-api/order-api.md).

# Overview

{% @code-walkthrough/alert-block title="" message="The URLs for the Order API have been migrated to hybrid tenant. Developer portal has been updated to reflect this. Retailers onboarded prior to February 2025 will continue to use the existing URLs." type="error" %}

The Order Transaction API is the central order management layer in the ESW cross-border commerce platform. It handles the full lifecycle of orders — from initial creation through fulfilment, cancellation, line-item operations, appeasements, replacements, allocation, and financial transaction search.

It provides a suite of functionalities for managing order-related activities. It allows for retrieving order transactions, canceling entire orders or specific line items, issuing replacements or appeasements, and updating shopper contact details.

The Order API is asynchronous, which means that when ESW receives the API request, the ESW system validates it and returns a response indicating whether your request is accepted or not. If your request is accepted and subsequently processed, the ESW system triggers success or failure event notifications to let you know that your request has now been actioned. Note that these event notifications are sent only if you are subscribed to receive notifications from ESW.

#### What this API does

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-cover-dark data-type="image">Cover image (dark)</th></tr></thead><tbody><tr><td>Cancellation &#x26; fulfilment</td><td><a href="/files/olXwLqCseGvtMiZECV02">/files/olXwLqCseGvtMiZECV02</a></td><td><a href="/files/2y1H51dw9rduWJ3AvRDO">/files/2y1H51dw9rduWJ3AvRDO</a></td></tr><tr><td>Appeasements</td><td><a href="/files/GU7COBef3iqcAr7ascjb">/files/GU7COBef3iqcAr7ascjb</a></td><td><a href="/files/iJ3CLp8J62WzNDJZgnzw">/files/iJ3CLp8J62WzNDJZgnzw</a></td></tr></tbody></table>


---

# 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/order-api/order-api/order-api.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.
