Retrieve a return

Retrieve a return

curl --request GET \
  --url https://panel.sendcloud.sc/api/v3/returns/{id} \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://panel.sendcloud.sc/api/v3/returns/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://panel.sendcloud.sc/api/v3/returns/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://panel.sendcloud.sc/api/v3/returns/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://panel.sendcloud.sc/api/v3/returns/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "from_address": {
    "name": "John Doe",
    "address_line_1": "Stadhuisplein",
    "postal_code": "1013 AB",
    "city": "Eindhoven",
    "country_code": "NL",
    "company_name": "Sendcloud",
    "house_number": "50",
    "address_line_2": "Apartment 17B",
    "po_box": "<string>",
    "state_province_code": "IT-RM",
    "email": "johndoe@gmail.com",
    "phone_number": "+319881729999"
  },
  "to_address": {
    "name": "John Doe",
    "address_line_1": "Stadhuisplein",
    "postal_code": "1013 AB",
    "city": "Eindhoven",
    "country_code": "NL",
    "company_name": "Sendcloud",
    "house_number": "50",
    "address_line_2": "Apartment 17B",
    "po_box": "<string>",
    "state_province_code": "IT-RM",
    "email": "johndoe@gmail.com",
    "phone_number": "+319881729999"
  },
  "shipping_product": {
    "code": "<string>"
  },
  "shipping_option": {
    "code": "postnl:standard/signature"
  },
  "weight": {
    "value": 14.5,
    "unit": "g"
  },
  "send_tracking_emails": false,
  "is_cancellable": true,
  "status_history": [
    {
      "carrier_update_timestamp": "2023-11-07T05:31:56Z",
      "parcel_status_history_id": "<string>",
      "parent_status": "<string>",
      "carrier_code": "<string>",
      "carrier_message": "<string>"
    }
  ],
  "created_at": "2022-08-09T14:32:21.463473+02:00",
  "dimensions": {
    "length": 15,
    "width": 20.5,
    "height": 37,
    "unit": "mm"
  },
  "collo_count": 1,
  "parcel_items": [
    {
      "item_id": "5552",
      "description": "T-Shirt XL",
      "quantity": 1,
      "weight": {
        "value": 14.5,
        "unit": "g"
      },
      "price": {
        "value": 123,
        "currency": "EUR"
      },
      "value": {
        "value": 123,
        "currency": "EUR"
      },
      "hs_code": "6205.20",
      "origin_country": "NL",
      "sku": "TS1234",
      "product_id": "19284",
      "return_reason_id": "1",
      "return_message": "Too big",
      "mid_code": "NLOZR92MEL",
      "material_content": "100% Cotton",
      "intended_use": "Personal use",
      "dangerous_goods": {
        "chemical_record_identifier": "<string>",
        "regulation_set": "IATA",
        "packaging_type_quantity": "<string>",
        "packaging_type": "<string>",
        "packaging_instruction_code": "<string>",
        "id_number": "<string>",
        "class_division_number": "<string>",
        "quantity": "<string>",
        "unit_of_measurement": "kg",
        "proper_shipping_name": "<string>",
        "commodity_regulated_level_code": "LQ",
        "transportation_mode": "Highway",
        "emergency_contact_name": "<string>",
        "emergency_contact_phone": "<string>",
        "adr_packing_group_letter": "I",
        "local_proper_shipping_name": "<string>",
        "transport_category": "<string>",
        "tunnel_restriction_code": "<string>",
        "weight_type": "net"
      },
      "dds_reference": "25FIYPEK0A7573",
      "taric_doc_code": "Y142",
      "manufacturer_product_id": "ABC-12345",
      "manufacturer_product_id_std": "01234567890128",
      "cpsc": {
        "product_id": "12345",
        "certifier_id": "67890",
        "version_id": "1"
      },
      "properties": {
        "size": "red",
        "color": "green"
      },
      "variant_id": "size-l",
      "return_reason": {
        "id": 1,
        "description": "Too big for me"
      }
    }
  ],
  "brand_id": 1,
  "label_url": "https://panel.sendcloud.sc/api/v3/parcels/8/documents/label",
  "label": {
    "normal_printer": [
      "https://panel.sendcloud.sc/api/v3/parcels/8/documents/label?paper_size=a4",
      "https://panel.sendcloud.sc/api/v3/parcels/8/documents/label?paper_size=a4",
      "https://panel.sendcloud.sc/api/v3/parcels/8/documents/label?paper_size=a4",
      "https://panel.sendcloud.sc/api/v3/parcels/8/documents/label?paper_size=a4"
    ],
    "label_printer": "https://panel.sendcloud.sc/api/v3/parcels/8/documents/label"
  },
  "label_cost": {
    "value": 123,
    "currency": "EUR"
  },
  "converted_label_cost": {
    "value": "8.39",
    "currency": "GBP",
    "rate": "0.86100000",
    "rate_date": "2026-10-28",
    "reference_rate": "0.84411765",
    "currency_conversion_fee": {
      "rate": "0.0200",
      "value": "0.16",
      "currency": "GBP"
    }
  },
  "insurance": true,
  "tracking_number": "3SSEND12345678",
  "tracking_numbers": [
    {
      "tracking_number": "3SSEND12345678"
    }
  ],
  "tracking_url": "https://tracking.eu-central-1-0.sendcloud.sc/forward?carrier=sendcloud&code=3SSEND12345678&destination=NL&lang=en-gb&source=NL&type=letter&verification=1001+VV&servicepoint_verification=&created_at=2022-07-27",
  "delivered_at": 1734946171662,
  "delivered_at_iso": "2022-08-09T14:32:21.463473+02:00",
  "reason": {
    "id": 1,
    "description": "Too big for me"
  },
  "refund": {
    "refund_type": "exchange",
    "message": "Exchange for size M"
  },
  "return_fee": {
    "value": 123,
    "currency": "EUR"
  },
  "order_number": "ORD12345",
  "contract": 123,
  "customs_invoice_nr": "<string>",
  "customs_shipment_type": 0,
  "delivery_option": "drop_off_point",
  "images": [
    {
      "product_id": "123456",
      "uploaded_image": "https://example.com/image.png",
      "thumbnail_image": "https://example.com/thumbnail.png",
      "description": "My broken camera, with a crack on the lens"
    }
  ],
  "status": "open",
  "customs_information": {
    "invoice_number": "INV-123",
    "export_reason": "commercial_goods",
    "export_type": "private",
    "invoice_date": "2023-08-24",
    "discount_granted": {
      "value": "14.99",
      "currency": "EUR"
    },
    "freight_costs": null,
    "insurance_costs": {
      "value": "3.60",
      "currency": "EUR"
    },
    "other_costs": {
      "value": "1.2",
      "currency": "EUR"
    },
    "general_notes": "Compliance: Goods comply with international safety standards (CE certified).",
    "additional_declaration_statements": [
      "With reference to the above shipment, I understate that the content is not made of leather parts of animal species protected by the Washington Convention.",
      "I solemnly declare that the contents of this document represent a true and accurate account of the events as they occurred. I acknowledge my responsibility for the information presented herein and understand that any misrepresentation or falsification may result in legal consequences or other penalties as applicable."
    ],
    "importer_of_record": {
      "name": "John Doe",
      "company_name": "ImporterCo",
      "address_line_1": "Maple Avenue",
      "house_number": "123",
      "postal_code": "90210",
      "city": "Springfield",
      "country_code": "US",
      "state_province_code": "US-MA",
      "telephone": "+15551234567",
      "email": "info@importer-of-record-example.com"
    },
    "tax_numbers": {
      "sender": [
        {
          "name": "VAT",
          "country_code": "NL",
          "value": "NL123456789B01"
        },
        {
          "name": "EORI",
          "country_code": "NL",
          "value": "NL123456789"
        }
      ],
      "receiver": [
        {
          "name": "EIN",
          "country_code": "US",
          "value": "123456789"
        }
      ],
      "importer_of_record": [
        {
          "name": "EIN",
          "country_code": "US",
          "value": "987654321"
        }
      ]
    },
    "return_data": {
      "return_postal_code": "1111 AA",
      "outbound_tracking_number": "JT1234567890",
      "outbound_shipment_date": "2023-08-14",
      "outbound_carrier_name": "UPS"
    },
    "mrn": "25NLQ8PF0V3DJ1MKX7"
  },
  "errors": [
    {
      "id": "<string>",
      "links": {
        "about": "<string>"
      },
      "status": "<string>",
      "code": "unknown_field",
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>",
        "header": "<string>"
      },
      "meta": {}
    }
  ]
}

GET

returns

{id}

Retrieve a return

curl --request GET \
  --url https://panel.sendcloud.sc/api/v3/returns/{id} \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://panel.sendcloud.sc/api/v3/returns/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://panel.sendcloud.sc/api/v3/returns/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://panel.sendcloud.sc/api/v3/returns/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://panel.sendcloud.sc/api/v3/returns/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "from_address": {
    "name": "John Doe",
    "address_line_1": "Stadhuisplein",
    "postal_code": "1013 AB",
    "city": "Eindhoven",
    "country_code": "NL",
    "company_name": "Sendcloud",
    "house_number": "50",
    "address_line_2": "Apartment 17B",
    "po_box": "<string>",
    "state_province_code": "IT-RM",
    "email": "johndoe@gmail.com",
    "phone_number": "+319881729999"
  },
  "to_address": {
    "name": "John Doe",
    "address_line_1": "Stadhuisplein",
    "postal_code": "1013 AB",
    "city": "Eindhoven",
    "country_code": "NL",
    "company_name": "Sendcloud",
    "house_number": "50",
    "address_line_2": "Apartment 17B",
    "po_box": "<string>",
    "state_province_code": "IT-RM",
    "email": "johndoe@gmail.com",
    "phone_number": "+319881729999"
  },
  "shipping_product": {
    "code": "<string>"
  },
  "shipping_option": {
    "code": "postnl:standard/signature"
  },
  "weight": {
    "value": 14.5,
    "unit": "g"
  },
  "send_tracking_emails": false,
  "is_cancellable": true,
  "status_history": [
    {
      "carrier_update_timestamp": "2023-11-07T05:31:56Z",
      "parcel_status_history_id": "<string>",
      "parent_status": "<string>",
      "carrier_code": "<string>",
      "carrier_message": "<string>"
    }
  ],
  "created_at": "2022-08-09T14:32:21.463473+02:00",
  "dimensions": {
    "length": 15,
    "width": 20.5,
    "height": 37,
    "unit": "mm"
  },
  "collo_count": 1,
  "parcel_items": [
    {
      "item_id": "5552",
      "description": "T-Shirt XL",
      "quantity": 1,
      "weight": {
        "value": 14.5,
        "unit": "g"
      },
      "price": {
        "value": 123,
        "currency": "EUR"
      },
      "value": {
        "value": 123,
        "currency": "EUR"
      },
      "hs_code": "6205.20",
      "origin_country": "NL",
      "sku": "TS1234",
      "product_id": "19284",
      "return_reason_id": "1",
      "return_message": "Too big",
      "mid_code": "NLOZR92MEL",
      "material_content": "100% Cotton",
      "intended_use": "Personal use",
      "dangerous_goods": {
        "chemical_record_identifier": "<string>",
        "regulation_set": "IATA",
        "packaging_type_quantity": "<string>",
        "packaging_type": "<string>",
        "packaging_instruction_code": "<string>",
        "id_number": "<string>",
        "class_division_number": "<string>",
        "quantity": "<string>",
        "unit_of_measurement": "kg",
        "proper_shipping_name": "<string>",
        "commodity_regulated_level_code": "LQ",
        "transportation_mode": "Highway",
        "emergency_contact_name": "<string>",
        "emergency_contact_phone": "<string>",
        "adr_packing_group_letter": "I",
        "local_proper_shipping_name": "<string>",
        "transport_category": "<string>",
        "tunnel_restriction_code": "<string>",
        "weight_type": "net"
      },
      "dds_reference": "25FIYPEK0A7573",
      "taric_doc_code": "Y142",
      "manufacturer_product_id": "ABC-12345",
      "manufacturer_product_id_std": "01234567890128",
      "cpsc": {
        "product_id": "12345",
        "certifier_id": "67890",
        "version_id": "1"
      },
      "properties": {
        "size": "red",
        "color": "green"
      },
      "variant_id": "size-l",
      "return_reason": {
        "id": 1,
        "description": "Too big for me"
      }
    }
  ],
  "brand_id": 1,
  "label_url": "https://panel.sendcloud.sc/api/v3/parcels/8/documents/label",
  "label": {
    "normal_printer": [
      "https://panel.sendcloud.sc/api/v3/parcels/8/documents/label?paper_size=a4",
      "https://panel.sendcloud.sc/api/v3/parcels/8/documents/label?paper_size=a4",
      "https://panel.sendcloud.sc/api/v3/parcels/8/documents/label?paper_size=a4",
      "https://panel.sendcloud.sc/api/v3/parcels/8/documents/label?paper_size=a4"
    ],
    "label_printer": "https://panel.sendcloud.sc/api/v3/parcels/8/documents/label"
  },
  "label_cost": {
    "value": 123,
    "currency": "EUR"
  },
  "converted_label_cost": {
    "value": "8.39",
    "currency": "GBP",
    "rate": "0.86100000",
    "rate_date": "2026-10-28",
    "reference_rate": "0.84411765",
    "currency_conversion_fee": {
      "rate": "0.0200",
      "value": "0.16",
      "currency": "GBP"
    }
  },
  "insurance": true,
  "tracking_number": "3SSEND12345678",
  "tracking_numbers": [
    {
      "tracking_number": "3SSEND12345678"
    }
  ],
  "tracking_url": "https://tracking.eu-central-1-0.sendcloud.sc/forward?carrier=sendcloud&code=3SSEND12345678&destination=NL&lang=en-gb&source=NL&type=letter&verification=1001+VV&servicepoint_verification=&created_at=2022-07-27",
  "delivered_at": 1734946171662,
  "delivered_at_iso": "2022-08-09T14:32:21.463473+02:00",
  "reason": {
    "id": 1,
    "description": "Too big for me"
  },
  "refund": {
    "refund_type": "exchange",
    "message": "Exchange for size M"
  },
  "return_fee": {
    "value": 123,
    "currency": "EUR"
  },
  "order_number": "ORD12345",
  "contract": 123,
  "customs_invoice_nr": "<string>",
  "customs_shipment_type": 0,
  "delivery_option": "drop_off_point",
  "images": [
    {
      "product_id": "123456",
      "uploaded_image": "https://example.com/image.png",
      "thumbnail_image": "https://example.com/thumbnail.png",
      "description": "My broken camera, with a crack on the lens"
    }
  ],
  "status": "open",
  "customs_information": {
    "invoice_number": "INV-123",
    "export_reason": "commercial_goods",
    "export_type": "private",
    "invoice_date": "2023-08-24",
    "discount_granted": {
      "value": "14.99",
      "currency": "EUR"
    },
    "freight_costs": null,
    "insurance_costs": {
      "value": "3.60",
      "currency": "EUR"
    },
    "other_costs": {
      "value": "1.2",
      "currency": "EUR"
    },
    "general_notes": "Compliance: Goods comply with international safety standards (CE certified).",
    "additional_declaration_statements": [
      "With reference to the above shipment, I understate that the content is not made of leather parts of animal species protected by the Washington Convention.",
      "I solemnly declare that the contents of this document represent a true and accurate account of the events as they occurred. I acknowledge my responsibility for the information presented herein and understand that any misrepresentation or falsification may result in legal consequences or other penalties as applicable."
    ],
    "importer_of_record": {
      "name": "John Doe",
      "company_name": "ImporterCo",
      "address_line_1": "Maple Avenue",
      "house_number": "123",
      "postal_code": "90210",
      "city": "Springfield",
      "country_code": "US",
      "state_province_code": "US-MA",
      "telephone": "+15551234567",
      "email": "info@importer-of-record-example.com"
    },
    "tax_numbers": {
      "sender": [
        {
          "name": "VAT",
          "country_code": "NL",
          "value": "NL123456789B01"
        },
        {
          "name": "EORI",
          "country_code": "NL",
          "value": "NL123456789"
        }
      ],
      "receiver": [
        {
          "name": "EIN",
          "country_code": "US",
          "value": "123456789"
        }
      ],
      "importer_of_record": [
        {
          "name": "EIN",
          "country_code": "US",
          "value": "987654321"
        }
      ]
    },
    "return_data": {
      "return_postal_code": "1111 AA",
      "outbound_tracking_number": "JT1234567890",
      "outbound_shipment_date": "2023-08-14",
      "outbound_carrier_name": "UPS"
    },
    "mrn": "25NLQ8PF0V3DJ1MKX7"
  },
  "errors": [
    {
      "id": "<string>",
      "links": {
        "about": "<string>"
      },
      "status": "<string>",
      "code": "unknown_field",
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>",
        "header": "<string>"
      },
      "meta": {}
    }
  ]
}

OAuth2 scopes required: read:return. See Scopes for OAuth apps.

This endpoint allows you to retrieve information about a specific return parcel based on the return id. A return id is assigned to every return you create in Sendcloud, and can be retrieved for all return parcels via the Retrieve a list of returns endpoint. The returned object contains all relevant information about the return parcel, including up-to-date tracking information.

Authorizations

Authorization

string

header

required

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

Scopes

read:return

View your returns

Path Parameters

integer

required

The internal Sendcloud id of this return

Example:

1751075

Response

A Sendcloud return object

from_address

Address Object · object

required

Sendcloud Address object

Show child attributes

to_address

Address Object · object

required

Sendcloud Address object

Show child attributes

shipping_product

Shipping Product Code · object

required

Sendcloud shipping product code

Show child attributes

shipping_option

Shipping Option Code · object

required

Sendcloud shipping option code

Show child attributes

weight

Weight · object

required

Weight in the specified unit

Show child attributes

send_tracking_emails

boolean

default:false

required

When true, Sendcloud will send out the default track and trace emails

is_cancellable

boolean

required

Whether the incoming parcel of this return can be canceled

status_history

Detailed Tracking status · object[]

required

List with the timeline of your return status

Minimum array length: 1

Show child attributes

created_at

string<date-time>

required

Date and time of creation of this return

Example:

"2022-08-09T14:32:21.463473+02:00"

dimensions

Dimension · object

Dimension in the specified unit

Show child attributes

collo_count

integer

default:1

The number of collos this return consists of

Required range: x >= 1

parcel_items

Parcel Item Object · object[]

List of items contained in this return. Required outside the EU.

Show child attributes

brand_id

integer

The ID of the brand this Return belongs to.

Required range: x >= 1

Example:

1

label_url

string | null

deprecated

URL to download the label. This can be null because it might not be announced yet. Deprecated in favor of the label field.

Example:

"https://panel.sendcloud.sc/api/v3/parcels/8/documents/label"

label

object

URLs to download the label, if the parcel has been announced.

Show child attributes

label_cost

Price Object · object

Cost of the return label, in the currency of the shipping option. It can differ from your account currency.

Show child attributes

converted_label_cost

Converted Price Object · object | null

The price in your account currency, which is the currency Sendcloud invoices you in. null when there is no price, when the price is already in your account currency, when no exchange rate is available, or when Sendcloud does not invoice the price (for example, a direct contract price).

Show child attributes

insurance

boolean

Whether the return parcel is insured

tracking_number

string | null

This can be null because it might not be announced yet.

Example:

"3SSEND12345678"

tracking_numbers

Tracking Number Object · object[]

All tracking numbers known for this return.

Show child attributes

tracking_url

string | null

URL to track your return. This can be null because it might not be announced yet.

Example:

"https://tracking.eu-central-1-0.sendcloud.sc/forward?carrier=sendcloud&code=3SSEND12345678&destination=NL&lang=en-gb&source=NL&type=letter&verification=1001+VV&servicepoint_verification=&created_at=2022-07-27"

delivered_at

number | null

deprecated

A unix timestamp indicating the delivery time of this return. Deprecated in favor of the delivered_at_iso field.

Example:

1734946171662

delivered_at_iso

string<date-time> | null

Date and time of delivery of this return

Example:

"2022-08-09T14:32:21.463473+02:00"

reason

Return reason Object · object

The reason this Return was created. This could be on the item level or the whole Return.

Show child attributes

refund

Return refund Object · object | null

Information about the compensation chosen by the customer for the returned items

Show child attributes

return_fee

Price With Any Currency · object | null

The fee associated with this return

Show child attributes

order_number

string

Order number filled by the user

Example:

"ORD12345"

contract

integer

ID of the contract used to ship this return

customs_invoice_nr

string | null

Customs invoice number

customs_shipment_type

enum<integer>

Customs shipment type

0 - Gift
1 - Documents
2 - Commercial Goods
3 - Commercial Sample
4 - Returned Goods

Available options:

0,

1,

2,

3,

4

delivery_option

enum<string> | null

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,

pickup,

in_store,

null

Minimum string length: 1

Example:

"drop_off_point"

images

object[]

Images uploaded when creating a return via the Return Portal

Maximum array length: 10

Show child attributes

status

enum<string>

The current status of the return

Available options:

open,

requested,

request_rejected,

awaiting_payment,

payment_failed

Example:

"open"

customs_information

ParcelCustomsInformation · object | null

Customs information used to generate customs documents. Required for returns that need customs documents, unless you provide customs_invoice_nr.

Show child attributes

Example:

{
  "invoice_number": "INV-123",
  "export_reason": "commercial_goods",
  "export_type": "private",
  "invoice_date": "2023-08-24",
  "discount_granted": { "value": "14.99", "currency": "EUR" },
  "freight_costs": null,
  "insurance_costs": { "value": "3.60", "currency": "EUR" },
  "other_costs": { "value": "1.2", "currency": "EUR" },
  "general_notes": "Compliance: Goods comply with international safety standards (CE certified).",
  "additional_declaration_statements": [
    "With reference to the above shipment, I understate that the content is not made of leather parts of animal species protected by the Washington Convention.",
    "I solemnly declare that the contents of this document represent a true and accurate account of the events as they occurred. I acknowledge my responsibility for the information presented herein and understand that any misrepresentation or falsification may result in legal consequences or other penalties as applicable."
  ],
  "importer_of_record": {
    "name": "John Doe",
    "company_name": "ImporterCo",
    "address_line_1": "Maple Avenue",
    "house_number": "123",
    "postal_code": "90210",
    "city": "Springfield",
    "country_code": "US",
    "state_province_code": "US-MA",
    "telephone": "+15551234567",
    "email": "info@importer-of-record-example.com"
  },
  "tax_numbers": {
    "sender": [
      {
        "name": "VAT",
        "country_code": "NL",
        "value": "NL123456789B01"
      },
      {
        "name": "EORI",
        "country_code": "NL",
        "value": "NL123456789"
      }
    ],
    "receiver": [
      {
        "name": "EIN",
        "country_code": "US",
        "value": "123456789"
      }
    ],
    "importer_of_record": [
      {
        "name": "EIN",
        "country_code": "US",
        "value": "987654321"
      }
    ]
  },
  "return_data": {
    "return_postal_code": "1111 AA",
    "outbound_tracking_number": "JT1234567890",
    "outbound_shipment_date": "2023-08-14",
    "outbound_carrier_name": "UPS"
  },
  "mrn": "25NLQ8PF0V3DJ1MKX7"
}

errors

Error · object[]

read-only

This array will contain errors such as carrier announcement errors.

Show child attributes

General

Authentication & account

Shipping

Checkout & delivery options

Tracking & post-purchase

Events & notifications

Carriers & pickups

Financial

Data & insights

Integrations

Authorizations

Scopes

Path Parameters

Response