curl --request GET \
--url https://panel.sendcloud.sc/api/v2/parcels/{id} \
--header 'Authorization: Basic <encoded-value>'{
"parcel": {
"id": 123,
"address": "<string>",
"address_2": "<string>",
"address_divided": {
"house_number": "<string>",
"street": "<string>"
},
"carrier": {
"code": "postnl"
},
"city": "<string>",
"company_name": "<string>",
"contract": 2,
"country": {
"iso_2": "<string>",
"iso_3": "<string>",
"name": "<string>"
},
"customs_invoice_nr": "<string>",
"data": {},
"date_created": "<string>",
"date_updated": "<string>",
"date_announced": "<string>",
"email": "<string>",
"insured_value": 123,
"label": {
"label_printer": "<string>",
"normal_printer": [
"<string>"
]
},
"name": "<string>",
"order_number": "<string>",
"shipment_uuid": "<string>",
"parcel_items": [
{
"hs_code": "<string>",
"weight": "<string>",
"quantity": 2,
"description": "<string>",
"value": 10.5,
"origin_country": "<string>",
"sku": "<string>",
"product_id": "<string>",
"properties": {},
"item_id": "<string>",
"return_reason": 2,
"return_message": "<string>",
"mid_code": "US1234567",
"material_content": "100% Cotton",
"intended_use": "Personal use",
"dangerous_goods": {
"chemical_record_identifier": "<string>",
"packaging_type_quantity": "<string>",
"packaging_type": "<string>",
"packaging_instruction_code": "<string>",
"id_number": "<string>",
"class_division_number": "<string>",
"quantity": "<string>",
"proper_shipping_name": "<string>",
"emergency_contact_name": "<string>",
"emergency_contact_phone": "<string>",
"local_proper_shipping_name": "<string>",
"transport_category": "<string>",
"tunnel_restriction_code": "<string>"
},
"dds_reference": "25FIYPEK0A7573",
"taric_doc_code": "Y142"
}
],
"postal_code": "<string>",
"external_reference": "<string>",
"reference": "0",
"shipment": {
"id": 123,
"name": "<string>"
},
"status": {
"id": 123,
"message": "<string>"
},
"documents": [
{
"size": "<string>",
"link": "<string>"
}
],
"telephone": "<string>",
"to_service_point": "<string>",
"to_state": "<string>",
"total_insured_value": 123,
"total_order_value_currency": "<string>",
"total_order_value": "<string>",
"tracking_number": "<string>",
"tracking_url": "<string>",
"weight": "<string>",
"colli_uuid": "<string>",
"collo_nr": 123,
"collo_count": 123,
"is_return": true,
"awb_tracking_number": "<string>",
"box_number": 123,
"length": "<string>",
"width": "<string>",
"height": "<string>",
"shipping_method_checkout_name": "<string>",
"customs_declaration": {},
"note": "<string>",
"errors": {
"non_field_errors": [
"<string>"
]
},
"customs_information": {
"customs_invoice_nr": "INV-123",
"customs_shipment_type": 2,
"export_type": "private",
"invoice_date": "2023-08-24",
"discount_granted": "14.99",
"freight_costs": "4.65",
"insurance_costs": "3.60",
"other_costs": "1.20",
"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_1": "Maple Avenue",
"house_number": "123",
"postal_code": "90210",
"city": "Springfield",
"country_code": "US",
"country_state": "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"
}
}
}
}Retrieve a specific parcel by its id.
curl --request GET \
--url https://panel.sendcloud.sc/api/v2/parcels/{id} \
--header 'Authorization: Basic <encoded-value>'{
"parcel": {
"id": 123,
"address": "<string>",
"address_2": "<string>",
"address_divided": {
"house_number": "<string>",
"street": "<string>"
},
"carrier": {
"code": "postnl"
},
"city": "<string>",
"company_name": "<string>",
"contract": 2,
"country": {
"iso_2": "<string>",
"iso_3": "<string>",
"name": "<string>"
},
"customs_invoice_nr": "<string>",
"data": {},
"date_created": "<string>",
"date_updated": "<string>",
"date_announced": "<string>",
"email": "<string>",
"insured_value": 123,
"label": {
"label_printer": "<string>",
"normal_printer": [
"<string>"
]
},
"name": "<string>",
"order_number": "<string>",
"shipment_uuid": "<string>",
"parcel_items": [
{
"hs_code": "<string>",
"weight": "<string>",
"quantity": 2,
"description": "<string>",
"value": 10.5,
"origin_country": "<string>",
"sku": "<string>",
"product_id": "<string>",
"properties": {},
"item_id": "<string>",
"return_reason": 2,
"return_message": "<string>",
"mid_code": "US1234567",
"material_content": "100% Cotton",
"intended_use": "Personal use",
"dangerous_goods": {
"chemical_record_identifier": "<string>",
"packaging_type_quantity": "<string>",
"packaging_type": "<string>",
"packaging_instruction_code": "<string>",
"id_number": "<string>",
"class_division_number": "<string>",
"quantity": "<string>",
"proper_shipping_name": "<string>",
"emergency_contact_name": "<string>",
"emergency_contact_phone": "<string>",
"local_proper_shipping_name": "<string>",
"transport_category": "<string>",
"tunnel_restriction_code": "<string>"
},
"dds_reference": "25FIYPEK0A7573",
"taric_doc_code": "Y142"
}
],
"postal_code": "<string>",
"external_reference": "<string>",
"reference": "0",
"shipment": {
"id": 123,
"name": "<string>"
},
"status": {
"id": 123,
"message": "<string>"
},
"documents": [
{
"size": "<string>",
"link": "<string>"
}
],
"telephone": "<string>",
"to_service_point": "<string>",
"to_state": "<string>",
"total_insured_value": 123,
"total_order_value_currency": "<string>",
"total_order_value": "<string>",
"tracking_number": "<string>",
"tracking_url": "<string>",
"weight": "<string>",
"colli_uuid": "<string>",
"collo_nr": 123,
"collo_count": 123,
"is_return": true,
"awb_tracking_number": "<string>",
"box_number": 123,
"length": "<string>",
"width": "<string>",
"height": "<string>",
"shipping_method_checkout_name": "<string>",
"customs_declaration": {},
"note": "<string>",
"errors": {
"non_field_errors": [
"<string>"
]
},
"customs_information": {
"customs_invoice_nr": "INV-123",
"customs_shipment_type": 2,
"export_type": "private",
"invoice_date": "2023-08-24",
"discount_granted": "14.99",
"freight_costs": "4.65",
"insurance_costs": "3.60",
"other_costs": "1.20",
"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_1": "Maple Avenue",
"house_number": "123",
"postal_code": "90210",
"city": "Springfield",
"country_code": "US",
"country_state": "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"
}
}
}
}Documentation Index
Fetch the complete documentation index at: https://sendcloud.dev/llms.txt
Use this file to discover all available pages before exploring further.
Basic Authentication using API key and secrets is currently the main authentication mechanism.
The id of the parcel you want to retrieve
OK
Parcel object model
Show child attributes