The Customer API has two key features:
- Query order data within a ShippingEasy account
- Add orders to a ShippingEasy account
Example use cases include adding support for ecommerce platforms that ShippingEasy does not support and reading data from ShippingEasy for use by a third party application (accounting, warehousing, etc.).
For the Customer APIs, sample libraries in PHP and Ruby are available:
For developers using languages other than PHP or Ruby, check out our examples using cURL.
If your application will be adding orders to a ShippingEasy account, keep these considerations in mind:
When will your application add the order? As soon as the order is created? Or does the order need to have a certain work flow state within your application before it would be appropriate to send the order to ShippingEasy?
The Customer API includes a method for cancelling an order in ShippingEasy. Making use of it allows your customer to cancel the order within your application without having to then duplicate that operation in the ShippingEasy user interface.
You do not need to poll ShippingEasy for shipment information. The ShippingEasy API will notify your application via a callback URL each time a shipment occurs for an order that was added via the API.
Within a ShippingEasy account, customers can setup one or more stores. A store is just a selling channel (e.g. eBay, amazon, Shopify, Bigcommerce, Volusion, etc.).
The Query API that ShippingEasy provides can return orders across all of an account's stores or from just a single store.
The API for adding orders to a ShippingEasy account always adds those orders to a single store within the ShippingEasy account. Further, that store must be of a specific type: it must be a ShippingEasy API store.
You can create a ShippingEasy API store with the ShippingEasy user interface:
- Login to a ShippingEasy account
- Click the Settings tab
- Click the Stores entry
- Click the Add New button
- Select ShippingEasy API as the store type
Note that you will be required to provide a working URL for your web site. The ShippingEasy application will attempt to verify the URL responds to a request.
Included within the settings for a ShippingEasy API store is a field for specifying the URL of your callback. ShippingEasy will send shipment information to that URL - note that HTTPS is required and self-signed certificates are not supported.
On the Settings > Stores & Orders page within the ShippingEasy user interface the information about your ShippingEasy API store will be displayed. Make note of the Store API Key, it will be needed when you use the API: