Sales Channels API Overview
Use the Sales Channels API to get a list of the sales channels available to a specified merchant.
Sales Channels API Scopes
Use of the Sales Channels API requires the Profile/sales-channels/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
You may only make the following number of requests per minute:
Request | req/min (sandbox) | req/min (production) | rate-limit quota |
---|---|---|---|
GET sales-channels | 10 | 40 | per Fashion Partner |
The data provided in the endpoint does not change frequently. The limits provided are higher than the expected usage.
For more information, see Rate Limiting.
Sandbox Behavior
Calls to the Sales Channels API in the sandbox environment are handled in the same way as calls made to the production environment.
For more information, see Sandbox Testing in our Getting Started Guide.
Additional Resources
- For instructions on using the Sales Channels API, see Sales Channels API in our Developer Guide.
- For an OpenAPI reference, see OpenAPI Specification: Merchant Profile Sales Channel API.