Customers can generate return labels online for Partner Fulfilled orders. When they do so, an Announced Return is created in our system. Partners can use the Announced Returns API to get information about these returns and process them accordingly.
This endpoint enables you to get all announced returns from a specific merchant, or to select a subset of announced returns using the filtering parameter(s):
GET merchants/{merchant_ID}/announced-returns
This httpie call gets all announced returns for a specific merchant:
http \
https://api-sandbox.merchants.zalando.com\
/merchants/{merchant_ID}/announced-returns\
Accept:application/vnd.api+json \
"Authorization: Bearer $YOUR_ACCESS_TOKEN"
All query parameters are optional.
| Description |
All the announced returns for orders sold in a given sales channel. |
| Type |
String (UUID) |
| Example |
http https://api-sandbox.merchants.zalando.com/merchants/{merchant_ID}/announced-returns sales_channel_id=bf48ba35-149d-4b76-8ac9-d08d126b517f Accept:application/vnd.api+json "Authorization: Bearer $YOUR_ACCESS_TOKEN" |
| Description |
This parameter is returned in API responses as a cursor (next, self, or prev) for pagination. Use it as a query parameter in subsequent calls to fetch the corresponding page. |
| Type |
String |
| Example |
http https://api-sandbox.merchants.zalando.com/merchants/{merchant_ID}/announced-returns cursor=Y3Vyc29yCg Accept:application/vnd.api+json "Authorization: Bearer $YOUR_ACCESS_TOKEN" |
| Description |
Number of Announced Return returned in a single page. |
| Type |
Integer |
| Default |
50 |
| Possible values |
1..1000 |
| Example |
http https://api-sandbox.merchants.zalando.com/merchants/{merchant_ID}/announced-returns limit=10 Accept:application/vnd.api+json "Authorization: Bearer $YOUR_ACCESS_TOKEN" |
| Description |
Filter for announced returns created after the given timestamp (inclusive) in the ISO 8601 format. |
| Type |
String (ISO 8601 datetime) |
| Example |
http https://api-sandbox.merchants.zalando.com/merchants/{merchant_ID}/announced-returns after=2025-01-01T00:00:00Z Accept:application/vnd.api+json "Authorization: Bearer $YOUR_ACCESS_TOKEN" |
| Description |
Filter for announced returns created before the given timestamp (exclusive) in the ISO 8601 format. |
| Type |
String (ISO 8601 datetime) |
| Example |
http https://api-sandbox.merchants.zalando.com/merchants/{merchant_ID}/announced-returns before=2025-12-31T23:59:59Z Accept:application/vnd.api+json "Authorization: Bearer $YOUR_ACCESS_TOKEN" |
| Description |
Sorting attributes separated by a comma. Default order (without sign symbol '+' or '-') is ascending(+). Minus(-) should be used in front of an attribute name if you want descending order. The parameter value includes the attributes (separated by a comma) that the query parameter 'sort' will apply to. Currently we only support sorting on return_registered_at. |
| Type |
String |
| Default |
-return_registered_at |
| Possible values |
-return_registered_at, +return_registered_at, return_registered_at |
| Example |
http https://api-sandbox.merchants.zalando.com/merchants/{merchant_ID}/announced-returns sort=+return_registered_at Accept:application/vnd.api+json "Authorization: Bearer $YOUR_ACCESS_TOKEN" |
Contact Support