Retrieve a list of returns
GET {{baseUrl}}/returns?cursor=<string>
Retrieve a paginated list of all the returns belonging to the authenticated user, sorted by the creation date.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
cursor | string | The cursor query string will be used as the pivot value to filter results. If no value is provided, the service must return the first page. The value is Base64 encoded GET parameters. example: | |
| For a cursor string there are 3 possible parameters to encode: |
- o: Offset
- r: Reverse
- p: Position Combine into GET parameters. Example: r=1&p=300 Base 64 encoded it would become: cj0xJnA9MzAw GET parameter in url would be https://some.url.com/api/endpoint/?cursor=cj0xJnA9MzAw |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"next":null,"previous":null,"returns":[{"id":1,"created_at":"2022-06-07T16:36:49.419457+02:00","reason":1,"outgoing_parcel":1,"incoming_parcel":1,"message":"Not good enough for me","refund":{"total_refund":"\"10.00\"","refunded_at":1654683771746,"message":"Exchange for size M","refund_type":{"code":"money","label":"Money back","require_message":true}},"is_cancellable":true,"return_fee":3.5,"return_fee_currency":"EUR","label_cost":6.95,"label_currency":"EUR","items_cost":48.95,"delivered_at":"2022-06-07T16:36:49.419457+02:00","delivery_option":"drop_off_point","store_location":1,"outgoing_parcel_data":{"tracking_url":"https://tracking.sendcloud.sc/forward?carrier=dhl\u0026code=JVGL1234567800000049","tracking_number":"JVGL1234567800000049","parcel_status":11,"global_status_slug":"delivered","brand_name":"My Brand","order_number":"EU2548657452","from_email":"contact@sendcloud.com","deleted":true,"collo_count":1,"from_country":"NL","from_name":"Jane Doe","shipping_method":994,"extra_data":{},"rules":[{"modifications":[{"field":"string","value":null}]}]},"incoming_parcel_data":{"tracking_url":"https://tracking.sendcloud.sc/forward?carrier=dhl\u0026code=JVGL1234567800000049","tracking_number":"JVGL1234567800000049","parcel_status":11,"global_status_slug":"delivered","brand_name":"My Brand","order_number":"EU2548657452","from_email":"contact@sendcloud.com","deleted":true,"collo_count":1,"from_country":"NL","from_name":"Jane Doe","shipping_method":994,"extra_data":{},"rules":[{"modifications":[{"field":"string","value":null}]}]},"incoming_parcel_status":{"id":1,"message":"Delivered","global_status_slug":"delivered"}}]}