Shipping Notices API Overview
This API is for use with ZFS only.
Use the Shipping Notices API to create, get, and update shipping notices. Shipping notices are used to communicate with ZFS Operations about partner stock shipments to Zalando Warehouses.
Shipping Notices API Headers
Once a shipping notice has been created, all PUT and POST calls to the Shipping Notices API require an If-Match header with a valid ETag value for the shipping notice, and a content-type header with the value application/json.
You may include the If-Match header with GET requests, but doing so is optional.
For more information, see Shipping Notices API Headers.
Shipping Notices API Scopes
Use of the Shipping Notices API requires the /shipping-notices/read and write 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.
Rate Limiting
The Shipping Notices API does currently rate limit requests as follow:
| Request | sandbox rate limits | production rate limits | rate-limit quota |
|---|---|---|---|
| GET /zfs/shipping-notices | 10 req/min | 60 req/min | per Fashion Partner |
| ALL /zfs/shipping-notices/:shipping-notice-id | 10 req/min | 10 req/min | per Fashion Partner |
| ALL /zfs/shipping-notices/:shipping-notice-id/announced-item-sets | 10 req/min | 30 req/hour | per Fashion Partner |
| ALL /zfs/shipping-notices/:shipping-notice-id/dispatch-item-sets | 10 req/min | 30 req/hour | per Fashion Partner |
| POST /zfs/shipping-notices/:shipping-notice-id/announcement-confirmations | 10 req/min | 30 req/hour | per Fashion Partner |
| POST /zfs/shipping-notices/:shipping-notice-id/dispatch-confirmations | 10 req/min | 30 req/hour | per Fashion Partner |
| GET /zfs/tours | 10 req/min | 60 req/min | per Fashion Partner |
For more information, see Rate Limiting.
Sandbox Behavior
All Shipping Notices API requests may be run in the sandbox environment.
You may create, modify, and get shipping notices, add item sets, send announcement and dispatch confirmations, and so forth. Whenever possible, we will manipulate and return your sample shipping notice data, but some fields may include sample or null values when meaningful data is unavailable.
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 Shipping Notices API, see Shipping Stock to Zalando in our Developer Guide.
- For an OpenAPI reference, see Partner Dispatch Service.