curl --request PUT \
--url https://panel.sendcloud.sc/api/v2/parcels \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"parcel": {
"id": 3,
"name": "Sendcloud Userß",
"address": "Stadhuisplein 10",
"postal_code": "5611 EM",
"city": "Eindhoven",
"country": "NL",
"company_name": "Summer Co"
}
}
'{
"parcel": [
{
"id": 3,
"name": "Anna Tester",
"company_name": "Summer Co",
"address": "Stadhuisplein 10",
"address_divided": {
"street": "Stadhuisplein",
"house_number": "10"
},
"city": "Eindhoven",
"postal_code": "5611 EM",
"telephone": "0612345678",
"email": "test@email.com",
"date_created": "01-01-2018 21:45:30",
"date_updated": "01-01-2018 21:45:31",
"date_announced": "01-01-2018 21:45:31",
"tracking_number": "S0M3TR4Ck1NgNumB3r",
"weight": "2.000",
"label": {
"normal_printer": [
"https://panel.sendcloud.sc/api/v2/label/normal_printer/3172?start_from=0&hash=bbfd669ee9ebb19408b85b33d181a50040fd9bc4",
"https://panel.sendcloud.sc/api/v2/label/normal_printer/3172?start_from=1&hash=bbfd669ee9ebb19408b85b33d181a50040fd9bc4",
"https://panel.sendcloud.sc/api/v2/label/normal_printer/3172?start_from=2&hash=bbfd669ee9ebb19408b85b33d181a50040fd9bc4",
"https://panel.sendcloud.sc/api/v2/label/normal_printer/3172?start_from=3&hash=bbfd669ee9ebb19408b85b33d181a50040fd9bc4"
],
"label_printer": "https://panel.sendcloud.sc/api/v2/label/label_printer/3172?hash=bbfd669ee9ebb19408b85b33d181a50040fd9bc4"
},
"customs_declaration": {},
"status": {
"id": 0,
"message": "Ready to send"
},
"data": {},
"country": {
"iso_2": "NL",
"iso_3": "NLD",
"name": "Netherlands"
},
"shipment": {
"id": 1,
"name": "PostNL Standard 0-23kg"
},
"carrier": {
"code": "postnl"
},
"colli_uuid": "ab3ecb5e-61b6-42b1-8034-7c6befdeaa63",
"collo_nr": 0,
"collo_count": 1,
"reference": "some_reference_123"
}
]
}Update a parcel which has not yet been announced, either to make changes to the original parcel data, or to request a shipping label if one hasn’t yet been created.
curl --request PUT \
--url https://panel.sendcloud.sc/api/v2/parcels \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"parcel": {
"id": 3,
"name": "Sendcloud Userß",
"address": "Stadhuisplein 10",
"postal_code": "5611 EM",
"city": "Eindhoven",
"country": "NL",
"company_name": "Summer Co"
}
}
'{
"parcel": [
{
"id": 3,
"name": "Anna Tester",
"company_name": "Summer Co",
"address": "Stadhuisplein 10",
"address_divided": {
"street": "Stadhuisplein",
"house_number": "10"
},
"city": "Eindhoven",
"postal_code": "5611 EM",
"telephone": "0612345678",
"email": "test@email.com",
"date_created": "01-01-2018 21:45:30",
"date_updated": "01-01-2018 21:45:31",
"date_announced": "01-01-2018 21:45:31",
"tracking_number": "S0M3TR4Ck1NgNumB3r",
"weight": "2.000",
"label": {
"normal_printer": [
"https://panel.sendcloud.sc/api/v2/label/normal_printer/3172?start_from=0&hash=bbfd669ee9ebb19408b85b33d181a50040fd9bc4",
"https://panel.sendcloud.sc/api/v2/label/normal_printer/3172?start_from=1&hash=bbfd669ee9ebb19408b85b33d181a50040fd9bc4",
"https://panel.sendcloud.sc/api/v2/label/normal_printer/3172?start_from=2&hash=bbfd669ee9ebb19408b85b33d181a50040fd9bc4",
"https://panel.sendcloud.sc/api/v2/label/normal_printer/3172?start_from=3&hash=bbfd669ee9ebb19408b85b33d181a50040fd9bc4"
],
"label_printer": "https://panel.sendcloud.sc/api/v2/label/label_printer/3172?hash=bbfd669ee9ebb19408b85b33d181a50040fd9bc4"
},
"customs_declaration": {},
"status": {
"id": 0,
"message": "Ready to send"
},
"data": {},
"country": {
"iso_2": "NL",
"iso_3": "NLD",
"name": "Netherlands"
},
"shipment": {
"id": 1,
"name": "PostNL Standard 0-23kg"
},
"carrier": {
"code": "postnl"
},
"colli_uuid": "ab3ecb5e-61b6-42b1-8034-7c6befdeaa63",
"collo_nr": 0,
"collo_count": 1,
"reference": "some_reference_123"
}
]
}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.
Parcel object for a parcel creation
Show child attributes
OK
Show child attributes