Skip to main content
GET
/
returns
Retrieve a list of returns
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/returns \
  --header 'Authorization: Basic <encoded-value>'
{
  "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,
      "images": [],
      "rule_modifications": [
        {
          "rule_name": "my_ship_with_rule",
          "field": "ship_with",
          "value": "PostNL Return",
          "action": "ship_with",
          "friendly_name": "Return method",
          "priority": 1,
          "item_id": null
        }
      ],
      "outgoing_parcel_data": {
        "tracking_url": "https://tracking.sendcloud.sc/forward?carrier=dhl&code=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": {}
      },
      "incoming_parcel_data": {
        "tracking_url": "https://tracking.sendcloud.sc/forward?carrier=dhl&code=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": [
          {
            "name": "my_ship_with_rule",
            "priority": 1,
            "item_id": null,
            "modifications": [
              {
                "field": "ship_with",
                "value": "PostNL Return",
                "action": "ship_with",
                "friendly_name": "Return method"
              }
            ]
          }
        ]
      },
      "incoming_parcel_status": {
        "id": 1,
        "message": "Delivered",
        "global_status_slug": "delivered"
      }
    }
  ]
}
The Returns API v2 is deprecated. Please plan to update to the latest version of the Returns API (v3), which has more features and improvements.

Authorizations

Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Query Parameters

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:

Example:

"cj0xJnA9MzAw"

Response

200 - application/json

OK

next
string | null

cursor based pagination url to go forward

previous
string | null

A cursor based pagination url to go backwards

returns
Return Object · object[]