Welcome to Shipup's API reference.

In the first sections of this documentation, you'll find a precise description of all data models used by Shipup. Knowing those models will help you:

  • Send store data to Shipup, using either our FTP or API integration
  • Consume Shipup data, through webhooks or CSV reports

The last two sections of this documentation detail how to connect to Shipup's REST API and how to retrieve data from Shipup using webhooks.


You can view code examples in the area to the right. We're also displaying JSON payloads of the different resources in this area.

Core resources

Shipup's data model consists of several resources. Below is a representation of the relationships between the 5 main resources of Shipup that are received from the online retailer's shop. Those resources will be described in more detail in the below documentation.