> 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/integrations/integration-methods.md).

# Integration Methods

Integrate with ESW using APIs, SFTP files, apps, or webhooks. Most integrations use a mix.

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref">Details</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><strong>APIs</strong><br>Real-time calls for checkout and order flows.</td><td><a href="#apis">#apis</a></td><td><a href="/files/1YNAMasrye5haytF6Qot">/files/1YNAMasrye5haytF6Qot</a></td><td><a href="/files/HJUQoSBnwA9DoDa7T8Kb">/files/HJUQoSBnwA9DoDa7T8Kb</a></td></tr><tr><td><strong>File integration (SFTP)</strong><br>Bulk and scheduled feeds for catalogs and packages.</td><td><a href="#file-integration-sftp">#file-integration-sftp</a></td><td><a href="/files/XCzeUsZZ5xMCqiOK8gzc">/files/XCzeUsZZ5xMCqiOK8gzc</a></td><td><a href="/files/3MBubEJJZmNSZKxvVECM">/files/3MBubEJJZmNSZKxvVECM</a></td></tr><tr><td><strong>Commerce Platform Connectors</strong><br>Fastest path on supported ecommerce platforms.</td><td><a href="/pages/63zaM42oSVVKYnCgVEI2#commerce-platform-connectors">/pages/63zaM42oSVVKYnCgVEI2#commerce-platform-connectors</a></td><td><a href="/files/NZ6ut502fUclyC5umZeT">/files/NZ6ut502fUclyC5umZeT</a></td><td><a href="/files/rl81lIU4IzM94CVbDwLL">/files/rl81lIU4IzM94CVbDwLL</a></td></tr><tr><td><strong>Webhooks</strong><br>Event notifications pushed from ESW to your systems.</td><td><a href="#webhooks">#webhooks</a></td><td><a href="/files/M5wiaw4wIMU3xS9ksqkA">/files/M5wiaw4wIMU3xS9ksqkA</a></td><td><a href="/files/TfyiylYsmQ3yg88FFAfY">/files/TfyiylYsmQ3yg88FFAfY</a></td></tr></tbody></table>

### Integration methods

{% tabs %}
{% tab title="APIs" %}
{% @code-walkthrough/alert-block title="" message="ESW APIs are built on REST principles with resource-oriented URLs" type="warning" %}

* APIs return standard HTTP response codes.
* API responses are in JSON format.
* Use APIs to integrate with ESW Checkout, Shipping, and Returns.

#### ESW provides

* Endpoints and request/response models.
* Swagger definitions and API reference material.

#### Prereqs

* Tenant credentials and base URLs.
  {% endtab %}

{% tab title="File integration (SFTP)" %}
{% hint style="warning" icon="file-circle-info" %}
ESW offers file integration capabilities that enable you to transfer data securely using SFTP (Secure File Transfer Protocol).
{% endhint %}

* This method of integration is useful for bulk data transfer.
* Common examples are product catalog data and package / ASN data.
* File integration is supported for **Catalog** and **Package** integrations only.
* Use it alongside APIs, not instead of them.

#### Best for

* Bulk product catalog loads.
* Package feeds and Advanced Shipping Notice (ASN).

#### ESW provides

* Processing aligned to agreed file formats.

#### Prereqs

* ESW-issued SFTP access and an agreed schema.

{% hint style="danger" %}
File integration is supported for **Catalog** and **Package** only.

Start here:

* [Catalog File Integration](/integrations/catalog-file-integration.md)
* [Package File Integration](/integrations/package-file-integration.md)
  {% endhint %}
  {% endtab %}

{% tab title="Commerce Platform Connectors" %}
{% hint style="warning" %}
ESW has developed plugins for leading ecommerce platforms. Examples include **Magento**, **Shopify**, and **Salesforce Commerce Cloud**.
{% endhint %}

* Use a plugin to integrate your online store with ESW without writing code.

#### ESW provides

* A supported plugin or cartridge.
* Platform-specific setup guidance and configuration options.

#### Prereqs

* Supported platform version and required store permissions.
  {% endtab %}

{% tab title="Webhooks" %}
{% hint style="warning" icon="webhook" %}
ESW allows you to subscribe to events that take place on the ESW platform. For example, you can use the Order Confirmation webhook when an order is placed.
{% endhint %}

* Each time the subscribed event takes place, ESW triggers a notification.
* ESW sends a `POST` payload to your configured URL.
* Webhook endpoints are registered with ESW.
* You can register multiple endpoints per webhook request.
* Webhook notifications are enabled by ESW during tenant creation and onboarding.

#### ESW provides

* Event payload delivery to your configured URL.
* Registration support for one or more endpoints per webhook request.

{% hint style="info" %}
Provide ESW with your endpoint URL(s) during onboarding/tenant creation so they can register them.
{% endhint %}
{% endtab %}
{% endtabs %}

### Common patterns

* **APIs + Webhooks**: real-time calls, plus event-driven updates downstream.
* **APIs + SFTP**: real-time checkout, plus batch feeds for catalogs or packages.

{% hint style="info" icon="gear-code" %}

#### Sandbox / ESW Demo tenant

ESW provides a default tenant called **ESW Demo** for early integration work. If your credentials expire, [register for a new set](https://esw.com/talk-to-an-expert/).
{% 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/integrations/integration-methods.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.