Onlineshop API Overview

This page gives a high-level overview of how the different pieces of the Onlineshop API work and fit together.

Different types of Data

In the Onlineshop API, there are 3 different types of data: product data, inventory data, and everything else.

Listing your Items

In order to list your items, the Onlineshop first needs sufficient product data for the items, then it needs your particular inventory data. You cannot send your product data directly to the Onlineshop, rather you have to upload a CSV file to a publicly accessible URL and tell the Onlineshop the location of the file through the /import-files/ REST API endpoint. The file will be downloaded and processed asynchronously after you send the file's URL, usually within a few minutes. You can check the status of your import file with the /import-files/sellers/ REST API endpoint. Once the asynchronous import of your product data file is done (i.e. product_feed_async_done == 1, you can then send your inventory for those items. Details about product data files are available on the Managing Product Data page.

When updating your inventory data, you have two options. If you only need to update the inventory of a few items, you can update each item individually with separate POST requests to the /units/ REST API endpoint, as shown on the Getting Started page. If you have many items to update, it is more efficient to update them all in a batch by sending a single CSV file to the Onlineshop. Again, as with the product data files, inventory files cannot be uploaded directly to the Onlineshop, you must tell the Onlineshop the location of the file through the /import-files/sellers/ REST API endpoint, from which it will be downloaded and processed asynchronously. Details about inventory files are available on the Managing Inventory page.

Managing your Sales

Information about your items that have sold is available through the REST API. In particular, the items you have sold are available as Orders and problems with existing Orders are available as Claims. Also, summary reports about your inventory and sales are available at the various /reports/ endpoints.