Offer Blocking API Overview
The Offer Blocking API is used to create or remove offer blockers. Products which are blocked by an offer blocker are not offered to Zalando customers.
Offer Blocking API Scopes
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.
Required scopes are:
| Operation | Scope |
|---|---|
| Create an Offer Blocker | products/blockers/write |
| Delete an Offer Blocker | products/blockers/write |
| Query an Offer Blocker | products/blockers/read |
| List Offer Blockers | products/blockers/read |
Rate Limiting
Batch POST and DELETE endpoints are rate limited in number of blockers per minute. We recommend maximizing the batch size in a request AND distributing your requests evenly within the minute, otherwise it is subjected to the internal rate limit to prevent DDoS-like traffic.
GET endpoints are rate limited in number of requests per second.
| Operation | Limits |
|---|---|
| Create offer blockers for particular products of a merchant | 6000 blockers per minute |
| Delete offer blockers for particular products of a merchant | 6000 blockers per minute |
| List offer blockers based on chosen criteria of a merchant | 40 requests per second |
| Query details about a specific blocker of a merchant | 40 requests per second |
All limits are per Merchant. For more general information, see Rate Limiting.
Sandbox Behavior
All Offer Blocking API requests may be run in the sandbox environment. The behavior is identical to the production environment, however creating or removing offer blockers will have no impact on product availability.
All requests in the sandbox environment are validated, and any returned error codes are the same as you will get in production.
No sandbox request will affect your production data in any way.
For more information, see Sandbox Testing in our Getting Started Guide.
Additional Resources
- For instructions on using the Offer Blocking API, see Blocking Offers in our Developer Guide.
- For an OpenAPI reference, see OpenAPI Specification: Merchant Offer Blocking API.