Skip to main content
GET
/
returns
/
{id}
Retrieve a return
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/returns/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "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.

Path Parameters

​
id
integer
required

The unique identifier of this return object

Example:

1

Response

OK

An object representing a Return.

This includes details of the original outgoing parcel, the incoming parcel and the returned items.

​
id
integer

The unique identifier of this Return object

Required range: x >= 1
Example:

1

​
created_at
string<date-time>

The creation date of this Return, in ISO 8601 format

Example:

"2022-06-07T16:36:49.419457+02:00"

​
reason
integer

Identifier of the reason for this return

Required range: x >= 1
Example:

1

​
outgoing_parcel
integer

Identifier of the original outgoing Parcel object

Required range: x >= 1
Example:

1

​
incoming_parcel
integer

Identifier of the incoming return Parcel object

Required range: x >= 1
Example:

1

​
message
string

Return reason message as written by the customer

Example:

"Not good enough for me"

​
refund
object

The type of compensation the customer chose for the returned items

​
is_cancellable
boolean

Whether the incoming return parcel can still be cancelled

​
return_fee
number

The fee associated with this return

Required range: x >= 0
Example:

3.5

​
return_fee_currency
string

Currency of the return fee in three-letter ISO 4217 format

Example:

"EUR"

​
label_cost
number

Cost of the label for the incoming return parcel

Required range: x >= 0
Example:

6.95

​
label_currency
string

Currency of the label cost in three-letter ISO 4217 format

Example:

"EUR"

​
items_cost
number

Total cost of the returned items

Required range: x >= 0
Example:

48.95

​
delivered_at
string<date-time>

Delivery date of the incoming return parcel

Example:

"2022-06-07T16:36:49.419457+02:00"

​
delivery_option
enum<string>

The options the customer has for returning this parcel:

  • drop_off_point: At a drop-off point - Print at home
  • drop_off_labelless: At a drop-off point - No printer needed
  • in_store: Return in store
  • pickup: Arrange a pick-up
Available options:
drop_off_point,
drop_off_labelless,
in_store,
pickup
​
store_location
integer

The identifier of the in-store return address

Required range: x >= 1
Example:

1

​
outgoing_parcel_data
Return Parcel Object · object

An object representing the details of a Parcel

​
incoming_parcel_data
Return Parcel Object · object

An object representing the details of a Parcel

​
incoming_parcel_status
object

Object describing the status of the incoming return parcel

​
images
Return Image Object · object[]

A list of images attached to a return

​
rule_modifications
object[]

List of return rules applied to this Return