How to install Ankorstore's API?

Last updated: July 22, 2026

Ankorstore’s API gives you the option to manage orders in your preferred ERP or order management system, without needing to visit Ankorstore’s platform. 

In this article, we’ll provide guidance on how to set up your integration and an overview on what tasks you’re able to complete when using it.

 

Ankorstore’s API allows you to perform:

  1. Order Management 

  2. Stock Management 

 

Important:

Please note that to successfully set up the integration, software development knowledge is required. So we recommend that you consult with your relevant technical teams, if you are interested in using its capabilities.

If you would like to use the Order Management API you must create a Sandbox account. 

What order management tasks am I able to perform via the API?

When integrated with the API, you will be able to complete the following tasks:

  • List all your orders with the ability to filter by either the retailer ID or the orders status

  • Retrieve a single order and find more detailed information about it (e.g. shipping data, ordered items)

  • Accept an order without any modifications to quantities of products

  • Reject an order

  • Generate a quote for shipping with your own carrier

  • Generate a quote for shipping with Ankorstore

  • Confirm the shipping quote and move the order into its shipping phase

  • Schedule a pick-up for the order (if shipped with Ankorstore)

  • Receive notifications via Webhooks when order-related events take place on Ankorstore. 

What stock management tasks am I able to perform via the API?

  • Check your stock level for a specific product or variant 

  • Update your stock levels for a specific product or variant 

  • Perform bulk updates to your stock levels for various products or variants 

 If you can share updated stock information via a link (e.g., Google Drive, SFTP, or HTTP), please contact stock@ankorstore.com. We can assist you in leveraging the public API to automatically upload the linked file daily.
To know more about it, please review the following article: 📄 Updating stock automatically without any API integration

Getting started with Ankorstore’s API

Before you can start using the API you’ll need to first follow the below set up instructions in your Ankorstore account. Once you’ve completed, follow the proceeding instructions on how to connect to the API.

 

Create your Application for your ERP system.

Go to ‘Integrations’ in your settings tabs, and select ‘Private App’. Here you will be able to create your private app so that you can access the API:

  1. Go to ‘My Account’ and choose ‘Integrations’ on the ‘Settings’ tab.

  2. On the ‘Integrations’ page, go to the ‘Private apps’ tab and click ‘Create a private integration’.

  3. Generate an authentication key by inputting the App name and email address, proceed by clicking ‘Generate Key’.

  4. When the key is generated you will be given a Client ID and Client Secret which are needed to connect to our API. Save these credentials to make changes in the future.

  5. Please treat your Client Secret like a password and never share it with anyone, once you close the dialog box you won’t be able to access the Client Secret again, so make sure to create a secure copy of it.

  6. Continue with creating the private app by clicking ‘Create an app’

  7. Once your app is created, you can receive notifications when order-related changes happen on Ankorstore.

  8. To turn on notifications, go to ‘Add a subscription’, then specify the destination URL for receiving the events and select the ones that you would like to be notified about.  

Set up the integration

Follow the instructions in our technical documentation to receive order information into your preferred system and be able to perform order management tasks without needing to visit Ankorstore website

Test your integration

To test your integration you will need a Public Sandbox account. Please try logging in with your credentials on Ankorstore Public Sandbox. If it does not work, please contact your Ankorstore Brand Development Manager and request an account. Once the account is created, you will receive an email with the Sandbox link to set up your credentials.

How does shipping work with the API?

You will see the contribution that we will make to your shipping costs in accordance with our new shipping policy. For details, view the ‘shippingCostsOverview’ feature, which details the cost of shipping and the type of cost. 

For more information on setting up and managing your orders through the API, please read this article (available in English only).