Integration Methods

• 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.

• 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.

• 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.

• 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.