[BETA] Get customer returns by provided query parameters
Use this resource to get all customer returns filtered by query parameters. Read more: <a href="../../tutorials/jak-obslugiwac-zamowienia-GRaj0qyvwtR#jak-pobrac-liste-zwrotow" target="_blank">PL</a> / <a href="../../tutorials/process-orders-PgPMlWDr8Cv#how-to-retrieve-customer-returns-list" target="_blank">EN</a>. This resource is limited to 25 requests per second for a single user and 50 requests per second for clientId.
Request
- Base URL: https://api.allegro.pl
- URL: https://api.allegro.pl/order/customer-returns
- Auth: OAuth 2 (authorization code, authorization URL https://allegro.pl/auth/oauth/authorize, token URL https://allegro.pl/auth/oauth/token, scopes: allegro:api:orders:read)
Query parameters
One or more customer return id's.
One or more order id's.
One or more buyer emails.
One or more buyer logins.
One or more returned item offer id's.
One or more item names.
One or more waybill id's.
Waybill ids as generated by carriers physically transporting the parcel. Will be null if there's only one carrier involved in a parcel shipment.
One or more carrier id's.
Carrier id of a carrier physically transporting the parcel. Will be null if there's only one carrier involved in a parcel shipment.
One or more phone numbers.
One or more reference numbers.
The ID of the last seen customer return. Customer returns created after the given customer return will be returned.
Date of the return in ISO 8601 format to search by greater or equal.
Date of the return in ISO 8601 format to search by lower or equal.
The marketplace ID where operation was made. When the parameter is omitted, searches for operations with all marketplaces.
Current return timeline statuses. The allowed values are:
- CREATED
- DISPATCHED
- IN_TRANSIT
- DELIVERED
- FINISHED
- FINISHED_APT
- REJECTED
- COMMISSION_REFUND_CLAIMED
- COMMISSION_REFUNDED
- WAREHOUSE_DELIVERED
- WAREHOUSE_VERIFICATION.
Limit of customer returns per page.
The offset of elements in the response.
Headers
Expected language of messages.
Response
Successfully retrieved customer returns.
Changes
No recorded changes to this operation across all 1 revision of this API.