Skip to content

Product Data

The Product Data API allows you to manage product definitions and details. This includes various calls to manage products and individual items.

How to Send Static Data

To facilitate the process of sending static data, we provide a scaffolding API. Here's the recommended approach:

dpp-data-flow

Retrieve product models

  • Call /api/product/v3/products to get a list of all product models for the current customer.
  • These product models, set up by Circulor, represent product families.

Get scaffolding for a specific product model

  • Choose the desired product model.
  • Call /api/product/v3/products/{productId}/scaffolding to obtain the scaffolding.
  • This returns a list of properties for the product model, including types and descriptions.

Set the product model values

  • Add appropriate values to the scaffold.
  • Post the scaffolding to /api/product/v3/products/data.
  • Post call does allow full or partial data sets.
  • Post call returns a request ID used to check the status of the request.

Check request status

  • The post call returns a request ID
  • Use this ID to check the status of the request via /api/product/v3/products/data/{requestId}/status.
  • Poll the status until it returns Success or Failed.

After successfully posting the data, you can view and issue new product models on the Circulor DPP Portal.

See the DPP Client Endpoints for more details on how to use the Ingestion API.