Product data read

The product data read endpoint lets you retrieve product data from a site at a specific processing stage.

Caution

This endpoint is rate-limited to 60 requests per minute. Depending on the complexity of the filter, the database size, and the number of columns, requests can take several minutes. Do not send concurrent requests — send consecutive requests only.

Get

curl "https://platform-api.productsup.io/product/v2/site/123/stage/intermediate/0\
?filter=id+%3C%3E+%27%27\
&limit=5000\
&offset=0\
&fields%5B0%5D=id\
&fields%5B1%5D=gtin\
&hidden=0"

{
    "success": true,
    "products": [{
        "id": "123",
        "gtin": "42"
    }]
}

HTTP request — get product data

GET https://platform-api.productsup.io/product/v2/site/<siteId>/stage/<stageName>/<stageId>

URL parameters

Field	Type	Description
`siteId`	integer	Site identifier
`stageName`	string	See stage names
`stageId`	integer	Export or channel ID for export and channel stages. Set to `0` for import and intermediate stages.

Stage names

Each stage represents a point in the processing pipeline where product data is available. Transformations accumulate as data moves through the stages.

Name	Description
`import`	Data as it arrives immediately after an API upload
`intermediate`	Data after generic transformations, applied to all product data
`export`	Data after export-specific transformations
`channel`	Data after channel-specific transformations

Exports and channels serve similar purposes. Productsup no longer creates new exports — use channels for new configurations.

Query parameters

Name	Type	Default	Description
`limit`	integer	`5000`	Maximum number of products to return
`offset`	integer	`0`	Number of products to skip
`fields`	array	all fields	Array of field names to include in the response
`hidden`	`0` or `1`	`0`	Set to `1` to include hidden fields (fields not included in exports)
`filter`	string	none	SQL-syntax condition to filter products

Response fields

Field	Type	Description
`success`	boolean	Indicates request status
`products`	array	List of product records, each containing at least an `id` column

HTTP request — get product data properties

GET https://platform-api.productsup.io/product/v2/site/<siteId>/stage/<stageName>/<stageId>/properties

curl https://platform-api.productsup.io/product/v2/site/123/stage/intermediate/0/properties/

{
    "success": true,
    "columns": ["id", "gtin", "price", ...],
    "products": 42
}

Use the same URL parameters as the main product data endpoint. The response includes the available columns and the total product count for the stage.

Field	Type	Description
`success`	boolean	Indicates request status
`columns`	array	Columns available in the data set
`products`	integer	Total number of products in the data set

Response status codes

Code	Message	Details
200	—	Request succeeded
429	Too many attempts	The API is rate-limiting your request. See rate limiting for more information.

Product data read

On this page