Skip to main content
PUT
/
parcels
Update a parcel
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"
    }
  ]
}
API v2 is entering maintenance mode. New users should start with API v3 to access our latest features and improved performance. Already using v2? Don’t worry, your current integration remains fully functional. Read more about maintenance mode, or check out the migration guide for API v3.
You’ll need to include the parcel_id of the parcel you wish to update, which you can retrieve via the Retrieve all parcels endpoint. Note that when updating a parcel with a quantity higher than 1 (e.g. a multicollo shipment), setting request_label=true is not allowed, since multiple parcels will be returned.
Once a parcel is announced and a label is created, it’s not possible to make further changes via this endpoint.

​
Change address or parcel details

If you need to make adjustments to details in the original parcel, such as customer address details, shipping method, etc., you can do so by adding any of the POST request parameters listed under the Create a parcel or parcels endpoint. These request parameters must be nested under a parcel object.

​
Create a shipping label for a parcel which is not yet announced

Use this endpoint to update the request_label: false parameter to truefor parcels which you chose not to announce at the time of parcel creation, and which now need a shipping label. 
  {
    "parcel": {
      "id": 1,
      "request_label": true
    }
  }
The shipping label will be announced and can be downloaded via an endpoint in the Labels API or Parcel documents API.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
parcel
Parcel Creation Object · object

Parcel object for a parcel creation

Response

OK

​
parcel
Parcel Object · object[]