Merchant API: getting started
About this article
This article describes how authentication works on ChannelEngine's Merchant API, as well as webhooks and tooling.
Table of contents
To connect your ecommerce platform with ChannelEngine, you can either use ChannelEngine's Merchant API or a combination of the Merchant API and a product feed.
Before using ChannelEngine's Merchant API, check out the article ChannelEngine's extensions for ecommerce platforms.
ChannelEngine uses API keys to authenticate your access to the Merchant API. To integrate with ChannelEngine’s Merchant API, you need to generate an API key. For this, log in to your ChannelEngine account and go to Settings, Merchant API keys.
For more information, check out the article ChannelEngine: get API access.
Base API URL
The next step is to obtain your tenant’s subdomain and the base API URL. The tenant’s subdomain is the name of your tenant on ChannelEngine. E.g.: if your tenant is called Demo, your subdomain is demo.
To get the base API URL, add .channelengine.net/api as a suffix to your personal subdomain. E.g.: if your subdomain is Demo, your base API URL is https://demo.channelengine.net/api.
You can also find your API URL by logging in to ChannelEngine and going to Settings, Merchant API keys in the main menu.
A webhook enables real-time communication between two systems. Using a webhook, one system notifies the other each time a certain event occurs. E.g.: ChannelEngine sends a notification to your order management system each time a new order is created.
ChannelEngine's webhooks allow you to subscribe to the following events:
- Orders create - triggered when orders are created.
- Products change - triggered when there is a change in the product feed.
- Returns change - triggered when returns are created or updated.
- Shipments change - triggered when a shipment is created and when a cancelation is created.
- Notifications create - triggered when ChannelEngine pushes a new notification.
- Product bundles change - triggered when product bundles are created or updated.
- Orders change - triggered when the order is updated on any other field other than the status.
For more information, check out the article ChannelEngine: webhooks.
For a comprehensive guide to ChannelEngine’s Merchant API, check out ChannelEngine’s OpenAPI/Swagger specification. This API reference contains all available endpoints, methods, parameters, and responses.
To access the language-specific Merchant API client library, check out the article Merchant API: API clients. These libraries allow for easier interaction with the API and a streamlined way to access the latest features and functionality.
To test how the Merchant API works before integrating it with your system, you can make use of the Postman application. For more information on how to work with ChannelEngine's specification in Postman, check out the article Import ChannelEngine's OpenAPI/Swagger documentation into Postman.
Article is closed for comments.