Platform and Stream API documentation

Use the Productsup Platform and Stream API documentation for successful integration with the Productsup platform.

The REST API provides programmatic access to read and write Productsup data. Create sites, upload product data, enable export channels, and more.

Platform API (v2)

For successful integration, it is necessary to have all systems in sync. Productsup provides an API to upload and update data and control other processes within the Productsup Platform to build a more seamless integration. See Platform API (v2).

Overview of the Platform API functionalities

  • Authentication - This is crucial for access to the Platform API. You can request a token from support@productsup.com. For more details on how to authenticate, see Authentication.

  • Version - The stable version of the Productsup Platform API is V2. To have access to all functionalities, always use the latest API version. See Version.

  • Cursor pagination - See Cursor pagination.

  • Projects - It is possible to list, create, edit and delete. See Projects.

  • Sites - It is possible to list, create, edit and delete. See Sites.

  • Site Errors - The API can list site errors per site. You can also use site errors to add information to a site. See Site errors.

  • Import History - You can request the import history per site. See Import history.

  • Channels - You can get a list of all channels in the account or from a specific site. See Channels.

  • Channel History - You can request the history of each channel. See Channel history.

  • Product Data (Write) - You can upload, commit, and discard product data. See Product data (write).

  • Product Data (Read) - To request selected site product data, see Product data (read).

  • Site stream data sources. See Site stream data sources.

  • Process - Use the API to trigger a site process. See Process.

  • Status - To request the status for a specific purpose, see Status.

  • API Errors - Get an overview of API Errors. See API errors.

Stream API (v0.2)

The Stream API is the latest addition to the APIs Productsup offers. Streams support a high throughput or number of items that undergo product changes. Streams can leverage how clients use their data in the Productsup Platform.

The Stream API does not have a PHP library, we maintain an Open API Specification file that can be used to generate a client. Download the OpenApi specification file.

Overview of the Stream API functionalities