Retrieve a Return

GET {{baseUrl}}/returns/:id

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 Get all returns endpoint.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"from_address":{"name":"\u003cstring\u003e","company_name":"\u003cstring\u003e","address_line_1":"\u003cstring\u003e","house_number":"\u003cstring\u003e","address_line_2":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","city":"\u003cstring\u003e","po_box":"\u003cstring,null\u003e","state_province_code":"\u003cstring\u003e","country_code":"\u003cstring\u003e","email":"\u003cemail\u003e","phone_number":"\u003cstring\u003e"},"to_address":{"name":"\u003cstring\u003e","company_name":"\u003cstring\u003e","address_line_1":"\u003cstring\u003e","house_number":"\u003cstring\u003e","address_line_2":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","city":"\u003cstring\u003e","po_box":"\u003cstring,null\u003e","state_province_code":"\u003cstring\u003e","country_code":"\u003cstring\u003e","email":"\u003cemail\u003e","phone_number":"\u003cstring\u003e"},"shipping_product":{"code":"\u003cstring\u003e"},"weight":{"value":"\u003cnumber\u003e","unit":"lbs"},"send_tracking_emails":false,"is_cancellable":"\u003cboolean\u003e","status_history":[{"carrier_update_timestamp":"\u003cdateTime\u003e","parcel_status_history_id":"\u003cstring\u003e","parent_status":"\u003cstring\u003e","carrier_code":"\u003cstring\u003e","carrier_message":"\u003cstring\u003e"}],"created_at":"\u003cdateTime\u003e","dimensions":{"length":"\u003cnumber\u003e","width":"\u003cnumber\u003e","height":"\u003cnumber\u003e","unit":"cm"},"collo_count":1,"parcel_items":[{"description":"\u003cstring\u003e","quantity":"\u003cinteger\u003e","weight":{"value":"\u003cnumber\u003e","unit":"g"},"value":{"value":"\u003cnumber\u003e","currency":"USD"},"hs_code":"\u003cstring\u003e","origin_country":"\u003cstring\u003e","sku":"\u003cstring\u003e","product_id":"\u003cstring\u003e","return_reason_id":"\u003cstring,null\u003e","return_message":"\u003cstring,null\u003e"},{"description":"\u003cstring\u003e","quantity":"\u003cinteger\u003e","weight":{"value":"\u003cnumber\u003e","unit":"kg"},"value":{"value":"\u003cnumber\u003e","currency":"USD"},"hs_code":"\u003cstring\u003e","origin_country":"\u003cstring\u003e","sku":"\u003cstring\u003e","product_id":"\u003cstring\u003e","return_reason_id":"\u003cstring,null\u003e","return_message":"\u003cstring,null\u003e"}],"brand_id":"\u003cinteger\u003e","label_url":"\u003cstring,null\u003e","label":{"normal_printer":["\u003cstring\u003e","\u003cstring\u003e"],"label_printer":"\u003cstring\u003e"},"label_cost":{"value":"\u003cnumber\u003e","currency":"GBP"},"insurance":"\u003cboolean\u003e","tracking_number":"\u003cstring,null\u003e","tracking_url":"\u003cstring,null\u003e","delivered_at":"\u003cdateTime\u003e","reason":{"id":"\u003clong\u003e","description":"\u003cstring\u003e"},"order_number":"\u003cstring\u003e","contract":"\u003cinteger\u003e","customs_invoice_nr":"\u003cstring,null\u003e","customs_shipment_type":1,"delivery_option":null,"images":[{"filename":"\u003cstring\u003e","product_id":"\u003cstring,null\u003e","uploaded_image":"\u003curi\u003e","thumbnail_image":"\u003cstring,null-uri\u003e"},{"filename":"\u003cstring\u003e","product_id":"\u003cstring,null\u003e","uploaded_image":"\u003curi\u003e","thumbnail_image":"\u003cstring,null-uri\u003e"}],"status":"awaiting_payment","customs_information":null}