Your own connection via the API

If your webshop or system is not in the list of platforms, you connect it yourself through the Stockhub API. To do so, you choose API for a new sales channel. Stockhub then creates a token that your own system uses to send orders to Stockhub and to request, for example, stock and shipments.

With an API channel, Stockhub does not fetch anything itself and does not send anything to your system. Your own system, or the developer who builds it, calls the API.

API channel or OpenAPI connection

An API channel is the same as a connection on the OpenAPI connections page (Integrations > OpenAPI connections). You can create it in two places:

• through Integrations > Sales channels, as described below. You then also fill in a Shipping name.
• with the New OpenAPI connection button on the OpenAPI connections page. This is explained in Koppelen met de Stockhub API.

Whichever way you create it, the channel then appears on the OpenAPI connections page, not in the Sales channels overview.

Creating the connection in Stockhub

1. In the menu, go to Integrations > Sales channels.

2. Click New sales channel. The Add sales channel window opens.

3. Choose API.

4. Fill in the fields:

   • Description: a recognisable name for the connection. On the OpenAPI connections page you see it as Name.
   • Shipping name: the name that appears on the shipping label.

   You do not enter any login details for API. Test connection is not needed: there is nothing to test yet.

   

5. Click Next.

6. You see the settings under Synchronisations. For an API channel, Stockhub does not use these settings, because your own system sends and requests the data. You can leave them as they are.

7. Click Save.

After creating

An API channel is active straight away. The fulfilment company does not have to activate it first. If you still see the message Pending sales channel approval after saving, you can ignore it for an API channel.

You find the token of the connection on the OpenAPI connections page: in the menu, go to Integrations > OpenAPI connections. There you also change the name or delete the connection. How that works, and where to find the technical documentation of the API, is explained in Koppelen met de Stockhub API.

Orders that your system creates through the API come in on this channel. You see them in Stockhub together with your other orders.

Only share the token with whoever builds your connection. With the token, someone can create orders on your behalf.