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

# ESW Developer Platform

<h2 align="center">ESW Developer Documentation Portal</h2>

<p align="center"><mark style="color:$info;">Explore our developer documentation for eCommerce integrations, REST APIs, authentication, checkout, webhooks, setup guides, and more.</mark></p>

{% columns %}
{% column width="25%" %}

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden align="center"></th><th data-hidden data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>Configure your developer environment and launch faster.</td><td align="center"></td><td></td><td><a href="/files/2IsHQnugVFiS1QfQUMOA">/files/2IsHQnugVFiS1QfQUMOA</a></td><td><a href="/spaces/S1VBiRsVGuY2lQIOaVbI/pages/PbYb0GukRhiS4qCHdRal">/spaces/S1VBiRsVGuY2lQIOaVbI/pages/PbYb0GukRhiS4qCHdRal</a></td></tr></tbody></table>
{% endcolumn %}

{% column width="25%" %}

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden align="center"></th><th data-hidden data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>Explore our integration options to find what best fits your business.</td><td align="center"></td><td><a href="https://esw.com/">https://esw.com/</a></td><td><a href="/files/IC9zVaZsnSBTC6Pw36Iu">/files/IC9zVaZsnSBTC6Pw36Iu</a></td><td><a href="/spaces/bB3UcHnWX3RLHHoolsLd/pages/63zaM42oSVVKYnCgVEI2">/spaces/bB3UcHnWX3RLHHoolsLd/pages/63zaM42oSVVKYnCgVEI2</a></td></tr></tbody></table>
{% endcolumn %}

{% column %}

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden align="center"></th><th data-hidden data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>Browse our API documentation for technical reference details</td><td align="center"><h4><strong>API References</strong></h4></td><td><a href="https://esw.com/">https://esw.com/</a></td><td><a href="/files/lr08tWEMQW1rFYx0d2Pj">/files/lr08tWEMQW1rFYx0d2Pj</a></td><td><a href="/spaces/sF5ifQjsfzalpf6LcO1G/pages/Xh8kfHbBIugc76WYNqOX">/spaces/sF5ifQjsfzalpf6LcO1G/pages/Xh8kfHbBIugc76WYNqOX</a></td></tr></tbody></table>
{% endcolumn %}

{% column %}

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden align="center"></th><th data-hidden data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>Discover the ESW Agentic Commerce Hub for faster task management.</td><td align="center"><h4><strong>Agentic Commerce Hub</strong></h4></td><td></td><td><a href="/files/zG5aO0O3peKQY1cd2kI0">/files/zG5aO0O3peKQY1cd2kI0</a></td><td><a href="/spaces/oNiYzXq5W9lF4B0fAZ9e/pages/JIgaZMvLkPNFqXMIZfW8">/spaces/oNiYzXq5W9lF4B0fAZ9e/pages/JIgaZMvLkPNFqXMIZfW8</a></td></tr></tbody></table>
{% endcolumn %}
{% endcolumns %}

{% columns %}
{% column width="41.66666666666667%" valign="middle" %}

<h3 align="center">Get Started with APIs</h3>

<p align="center">ESW offers REST APIs and integration patterns in its Developer Portal, using resource-based URLs, JSON payloads, and standard HTTP status codes.</p>

<p align="center"><a href="/spaces/S1VBiRsVGuY2lQIOaVbI/pages/7FvWQMF0kTK7HGhlQfmo" class="button secondary" data-icon="rocket-launch">Go to Authentication</a></p>
{% endcolumn %}

{% column width="58.33333333333333%" valign="middle" %}

```json
POST /api/v4/Package HTTP/1.1
Host: logistics-package-api.sandbox.eshopworld.com/
Authorization: Bearer YOUR_SECRET_TOKEN
{
  "brandCode": "GOC",
  "orderReference": "ABC1234567890",
  "packageReference": "AAA1234567890",
  "orderType": "CHECKOUT",
  "weight": {
    "weight": 1.34,
    "weightUnit": "KG"
  },
```

{% endcolumn %}
{% endcolumns %}

<h2 align="center">ESW Help Center and Client Hub</h2>

<table data-card-size="large" data-view="cards"><thead><tr><th align="center"></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><h2>Client Hub</h2><p>Use the ESW Client Hub to manage platform configuration, pricing, messaging, roles, and self-service support.</p></td><td data-object-fit="contain"><a href="/files/tKhwls7zNO5uTm7zOcHt">/files/tKhwls7zNO5uTm7zOcHt</a></td><td><a href="https://esp.eshopworld.com/">https://esp.eshopworld.com/</a></td></tr><tr><td align="center"><h2>Help Center</h2><p>Access ESW user guides, onboarding resources, and support documentation to get started faster.</p></td><td data-object-fit="contain"><a href="/files/jL86O2bsflB4dqaDGrMw">/files/jL86O2bsflB4dqaDGrMw</a></td><td><a href="https://help.esw.com">https://help.esw.com</a></td></tr></tbody></table>

<h2 align="center">Popular Topics</h2>

{% columns %}
{% column width="33.33333333333333%" %}

#### Get Started

* [Quick Start Guide](/getting-started/get-started-with-esw/readme.md)
* [Authentication](/getting-started/get-started-with-esw/readme/quickstart.md)
* [Access Tokens](/getting-started/get-started-with-esw/readme/publish-your-docs.md)
* [FAQs](/getting-started/get-started-with-esw/faqs.md)
* [Test Cards](/getting-started/get-started-with-esw/readme/test-cards.md)
  {% endcolumn %}

{% column width="33.33333333333333%" %}

#### APIs

* [Custom Catalog](/customs-catalog-api/customs-catalog-api/overview.md)
* [Package](/package-api/package-api/overview.md)
* [Checkout](/checkout-api/checkout-api/overview.md)
* [Returns](/returns-api/grp-returns-api/overview.md)
* [API References](/api-reference/standard-http-response-codes.md)
  {% endcolumn %}

{% column width="33.33333333333333%" %}

#### Commerce Platform Connectors

* [Salesforce Commerce](#salesforce-commerce)
* [Shopify](/shopify/shopify-native.md)
* [Adobe Commerce](/shopify/shopify-native.md)
* [Agentic Commerce](/agentic-commerce/coming-soon.md)
  {% endcolumn %}
  {% endcolumns %}


---

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