Product Status Report API Overview
The Product Status Report API (PSR API) provides read access to product data, their onboarding and offering status. Query the PSR API to get up-to-date information about your assortment, such as validation status, current price, and available stock.
For detailed instructions about the PSR API and how to use it, see Product Status Report in our Developer Guide.
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 10 requests per second.
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 instructions about which clients to use locally for testing, building your first request payload, and how to use the interactive documentation to construct new requests, see PSR API tutorial.
- For the PSR API OpenAPI reference, see Product Status Report API.