Product Status Report API Overview
The Product Status Report API (or PSR API) provides read access to Product Status Report data. Query the PSR API to get up-to-date information about your products, such as validation status, current price, and available stock.
Possible data lags
The data served by the PSR API is near real-time and usually lags only by a few minutes. However, this lag may sometimes increase to a few hours for short periods.
PSR data is also available through the Article Listing in zDirect UI, but you must have a Merchant Partner account to access that portal.
Note that this API is read only. For information on product onboarding, setting prices, and setting stock levels, see Products and Product Onboarding, Manage Prices, and Manage Stock.
Scopes
Use of the PSR API requires the Products/products/read scope.
Many zDirect APIs require clients to have specific permissions or scopes for read or write access. You may assign scopes to your apps in the "Applications" section of the zDirect Portal.
For more information on configuring app scopes, see the Applications section of our zDirect Portal guide.
Rate Limiting
Each app may only make 240 requests per minute.
For more information, see Rate Limiting.
Sandbox Behavior
Sandbox requests are not currently supported by the PSR API. However, because the API is read only, you can safely test it against your production data.
Additional Resources
- For detailed instructions about the PSR API and how to use it, see Product Status Reports in our Developer Guide.
- For instructions on how to use the interactive reference to the PSR API using the Insomnia GraphQL client, see Using Insomnia to View the PSR API Documentation in our Developer Guide.
- For the PSR API OpenAPI reference, see Product Status Reports API.