Using the Advanced Shipping Rules API, developers can fetch a Shop's shipping methods and rates by providing an array of items and a destination address. The API exposes the same rates that appear at checkout when the Advanced Shipping Rules App is installed on a Shop.
An App ID is required to use this API. We selectively provide App IDs to individual Shops and 3rd party apps upon request. To obtain an App ID for individual use or to become an Integration Partner, please contact us.
The Advanced Shipping Rules API is organized around REST and makes use of built-in HTTP features such as HTTP Basic Authentication. Cross-origin resource sharing (CORS) is supported, allowing you to interact securely with our API from a client-side web application (although as usual, you should not expose your secret App ID or API Key in any publicly accessible client-side code).
All API requests must be sent over HTTPS, and all requests must be authenticated. JSON is returned in all responses, including error responses.
To get started, you will need:
- An App ID. Contact us to obtain an App ID.
- A Shop's API Key, found on the Settings > General page of the Advanced Shipping Rules App.
Note that this API currently has only one endpoint, for fetching a Shop's rates that have been set up through their Advanced Shipping Rules App installation. To request additional API features, please contact us.