Update a parcel

PUT {{baseUrl}}/parcels

This endpoint allows you to 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. You'll need to include the parcel_id of the parcel you wish to update, which you can retrieve via the Get all parcels endpoint. Note that, when updating a parcel with a quantity higher than 1 (e.g. a multi-collo 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 Create a parcel. The post 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": 184063539,
    "request_label": true
  }
}

The shipping label will be announced and can be downloaded via the Get a PDF label endpoint.

Request Body

{"parcel"=>{"name"=>"<string>", "address"=>"<string>", "city"=>"<string>", "postal_code"=>"<string>", "country"=>"<string>", "id"=>"<integer>", "company_name"=>"<string>", "contract"=>"<integer>", "address_2"=>"<string>", "house_number"=>"<string>", "telephone"=>"<string>", "request_label"=>"<boolean>", "email"=>"<string>", "shipment"=>{"id"=>"<integer>", "name"=>"<string>"}, "weight"=>"<string>", "order_number"=>"<string>", "insured_value"=>"<integer>", "total_order_value_currency"=>"<string>", "total_order_value"=>"<string>", "quantity"=>"<integer>", "shipping_method_checkout_name"=>"<string>", "to_post_number"=>"<string>", "country_state"=>"<string>", "sender_address"=>"<integer>", "customs_invoice_nr"=>"<string>", "customs_shipment_type"=>2, "external_reference"=>"<string>", "reference"=>"0", "to_service_point"=>"<integer>", "total_insured_value"=>"<integer>", "shipment_uuid"=>"<string>", "parcel_items"=>[{"hs_code"=>"<string>", "weight"=>"<string>", "quantity"=>"<integer>", "description"=>"<string>", "value"=>"<number>", "origin_country"=>"<string>", "sku"=>"<string>", "product_id"=>"<string>", "item_id"=>"<string>", "return_reason"=>"<integer>", "return_message"=>"<string>", "mid_code"=>"<string>", "material_content"=>"<string>", "intended_use"=>"<string>"}, {"hs_code"=>"<string>", "weight"=>"<string>", "quantity"=>"<integer>", "description"=>"<string>", "value"=>"<number>", "origin_country"=>"<string>", "sku"=>"<string>", "product_id"=>"<string>", "item_id"=>"<string>", "return_reason"=>"<integer>", "return_message"=>"<string>", "mid_code"=>"<string>", "material_content"=>"<string>", "intended_use"=>"<string>"}], "is_return"=>"<boolean>", "length"=>"<string>", "width"=>"<string>", "height"=>"<string>", "request_label_async"=>"<boolean>", "apply_shipping_rules"=>"<boolean>", "from_name"=>"<string>", "from_company_name"=>"<string>", "from_address_1"=>"<string>", "from_address_2"=>"<string>", "from_house_number"=>"<string>", "from_city"=>"<string>", "from_postal_code"=>"<string>", "from_country"=>"<string>", "from_telephone"=>"<string>", "from_email"=>"<string>", "from_vat_number"=>"<string>", "from_eori_number"=>"<string>", "from_inbound_vat_number"=>"<string>", "from_inbound_eori_number"=>"<string>", "from_ioss_number"=>"<string>", "customs_information"=>{"customs_invoice_nr"=>"<string>", "customs_shipment_type"=>4, "export_type"=>"commercial_b2c", "invoice_date"=>"<date>", "discount_granted"=>"<string>", "freight_costs"=>"<string>", "insurance_costs"=>"<string>", "other_costs"=>"<string>", "general_notes"=>"<string>", "additional_declaration_statements"=>["<string>", "<string>"], "importer_of_record"=>{"name"=>"<string>", "address_1"=>"<string>", "city"=>"<string>", "postal_code"=>"<string>", "country_code"=>"<string>", "company_name"=>"<string>", "address_2"=>"<string>", "house_number"=>"<string>", "country_state"=>"<string>", "telephone"=>"<string>", "email"=>"<string>"}, "tax_numbers"=>{"sender"=>[{"name"=>"RGP", "country_code"=>"<string>", "value"=>"<string>"}, {"name"=>"NID", "country_code"=>"<string>", "value"=>"<string>"}], "receiver"=>[{"name"=>"KPP", "country_code"=>"<string>", "value"=>"<string>"}, {"name"=>"TAN", "country_code"=>"<string>", "value"=>"<string>"}], "importer_of_record"=>[{"name"=>"PAS", "country_code"=>"<string>", "value"=>"<string>"}, {"name"=>"INN", "country_code"=>"<string>", "value"=>"<string>"}]}, "return_data"=>{"return_postal_code"=>"<string>", "outbound_tracking_number"=>"<string>", "outbound_shipment_date"=>"<date>", "outbound_carrier_name"=>"<string>"}}}}

HEADERS

RESPONSES

status: OK

{"parcel":[{"id":"\u003cinteger\u003e","address":"\u003cstring\u003e","address_2":"\u003cstring\u003e","address_divided":{"house_number":"\u003cstring\u003e","street":"\u003cstring\u003e"},"carrier":{"code":"postnl_fulfilment"},"city":"\u003cstring\u003e","company_name":"\u003cstring\u003e","contract":"\u003cinteger\u003e","country":{"iso_2":"\u003cstring\u003e","iso_3":"\u003cstring\u003e","name":"\u003cstring\u003e"},"customs_invoice_nr":"\u003cstring\u003e","customs_shipment_type":1,"data":{},"date_created":"\u003cstring\u003e","date_updated":"\u003cstring\u003e","date_announced":"\u003cstring\u003e","email":"\u003cstring\u003e","insured_value":"\u003cinteger\u003e","label":{"label_printer":"\u003cstring\u003e","normal_printer":["\u003cstring\u003e","\u003cstring\u003e"]},"name":"\u003cstring\u003e","order_number":"\u003cstring\u003e","shipment_uuid":"\u003cstring\u003e","parcel_items":[{"hs_code":"\u003cstring\u003e","weight":"\u003cstring\u003e","quantity":"\u003cinteger\u003e","description":"\u003cstring\u003e","value":"\u003cnumber\u003e","origin_country":"\u003cstring\u003e","sku":"\u003cstring\u003e","product_id":"\u003cstring\u003e","properties":{},"item_id":"\u003cstring\u003e","return_reason":"\u003cinteger\u003e","return_message":"\u003cstring\u003e","mid_code":"\u003cstring\u003e","material_content":"\u003cstring\u003e","intended_use":"\u003cstring\u003e"},{"hs_code":"\u003cstring\u003e","weight":"\u003cstring\u003e","quantity":"\u003cinteger\u003e","description":"\u003cstring\u003e","value":"\u003cnumber\u003e","origin_country":"\u003cstring\u003e","sku":"\u003cstring\u003e","product_id":"\u003cstring\u003e","properties":{},"item_id":"\u003cstring\u003e","return_reason":"\u003cinteger\u003e","return_message":"\u003cstring\u003e","mid_code":"\u003cstring\u003e","material_content":"\u003cstring\u003e","intended_use":"\u003cstring\u003e"}],"postal_code":"\u003cstring\u003e","external_reference":"\u003cstring\u003e","reference":"0","shipment":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"},"status":{"id":"\u003cinteger\u003e","message":"\u003cstring\u003e"},"documents":[{"type":"cp71","size":"\u003cstring\u003e","link":"\u003cstring\u003e"},{"type":"commercial-invoice","size":"\u003cstring\u003e","link":"\u003cstring\u003e"}],"telephone":"\u003cstring\u003e","to_service_point":"\u003cstring\u003e","to_state":"\u003cstring\u003e","total_insured_value":"\u003cinteger\u003e","total_order_value_currency":"\u003cstring\u003e","total_order_value":"\u003cstring\u003e","tracking_number":"\u003cstring\u003e","tracking_url":"\u003cstring\u003e","weight":"\u003cstring\u003e","type":"parcel","colli_uuid":"\u003cstring\u003e","collo_nr":"\u003cinteger\u003e","collo_count":"\u003cinteger\u003e","is_return":"\u003cboolean\u003e","awb_tracking_number":"\u003cstring\u003e","box_number":"\u003cinteger\u003e","length":"\u003cstring\u003e","width":"\u003cstring\u003e","height":"\u003cstring\u003e","shipping_method_checkout_name":"\u003cstring\u003e","customs_declaration":{},"errors":{"non_field_errors":["\u003cstring\u003e","\u003cstring\u003e"]},"customs_information":{"customs_invoice_nr":"\u003cstring\u003e","customs_shipment_type":4,"export_type":"commercial_b2c","invoice_date":"\u003cdate\u003e","discount_granted":"\u003cstring\u003e","freight_costs":"\u003cstring\u003e","insurance_costs":"\u003cstring\u003e","other_costs":"\u003cstring\u003e","general_notes":"\u003cstring\u003e","additional_declaration_statements":["\u003cstring\u003e","\u003cstring\u003e"],"importer_of_record":{"name":"\u003cstring\u003e","address_1":"\u003cstring\u003e","city":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","country_code":"\u003cstring\u003e","company_name":"\u003cstring\u003e","address_2":"\u003cstring\u003e","house_number":"\u003cstring\u003e","country_state":"\u003cstring\u003e","telephone":"\u003cstring\u003e","email":"\u003cstring\u003e"},"tax_numbers":{"sender":[{"name":"DUN","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"KPP","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"receiver":[{"name":"TAN","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"IOSS","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"importer_of_record":[{"name":"IE","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"FTZ","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"}]},"return_data":{"return_postal_code":"\u003cstring\u003e","outbound_tracking_number":"\u003cstring\u003e","outbound_shipment_date":"\u003cdate\u003e","outbound_carrier_name":"\u003cstring\u003e"}}},{"id":"\u003cinteger\u003e","address":"\u003cstring\u003e","address_2":"\u003cstring\u003e","address_divided":{"house_number":"\u003cstring\u003e","street":"\u003cstring\u003e"},"carrier":{"code":"gls_de"},"city":"\u003cstring\u003e","company_name":"\u003cstring\u003e","contract":"\u003cinteger\u003e","country":{"iso_2":"\u003cstring\u003e","iso_3":"\u003cstring\u003e","name":"\u003cstring\u003e"},"customs_invoice_nr":"\u003cstring\u003e","customs_shipment_type":4,"data":{},"date_created":"\u003cstring\u003e","date_updated":"\u003cstring\u003e","date_announced":"\u003cstring\u003e","email":"\u003cstring\u003e","insured_value":"\u003cinteger\u003e","label":{"label_printer":"\u003cstring\u003e","normal_printer":["\u003cstring\u003e","\u003cstring\u003e"]},"name":"\u003cstring\u003e","order_number":"\u003cstring\u003e","shipment_uuid":"\u003cstring\u003e","parcel_items":[{"hs_code":"\u003cstring\u003e","weight":"\u003cstring\u003e","quantity":"\u003cinteger\u003e","description":"\u003cstring\u003e","value":"\u003cnumber\u003e","origin_country":"\u003cstring\u003e","sku":"\u003cstring\u003e","product_id":"\u003cstring\u003e","properties":{},"item_id":"\u003cstring\u003e","return_reason":"\u003cinteger\u003e","return_message":"\u003cstring\u003e","mid_code":"\u003cstring\u003e","material_content":"\u003cstring\u003e","intended_use":"\u003cstring\u003e"},{"hs_code":"\u003cstring\u003e","weight":"\u003cstring\u003e","quantity":"\u003cinteger\u003e","description":"\u003cstring\u003e","value":"\u003cnumber\u003e","origin_country":"\u003cstring\u003e","sku":"\u003cstring\u003e","product_id":"\u003cstring\u003e","properties":{},"item_id":"\u003cstring\u003e","return_reason":"\u003cinteger\u003e","return_message":"\u003cstring\u003e","mid_code":"\u003cstring\u003e","material_content":"\u003cstring\u003e","intended_use":"\u003cstring\u003e"}],"postal_code":"\u003cstring\u003e","external_reference":"\u003cstring\u003e","reference":"0","shipment":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"},"status":{"id":"\u003cinteger\u003e","message":"\u003cstring\u003e"},"documents":[{"type":"cn23","size":"\u003cstring\u003e","link":"\u003cstring\u003e"},{"type":"cp71","size":"\u003cstring\u003e","link":"\u003cstring\u003e"}],"telephone":"\u003cstring\u003e","to_service_point":"\u003cstring\u003e","to_state":"\u003cstring\u003e","total_insured_value":"\u003cinteger\u003e","total_order_value_currency":"\u003cstring\u003e","total_order_value":"\u003cstring\u003e","tracking_number":"\u003cstring\u003e","tracking_url":"\u003cstring\u003e","weight":"\u003cstring\u003e","type":"letter","colli_uuid":"\u003cstring\u003e","collo_nr":"\u003cinteger\u003e","collo_count":"\u003cinteger\u003e","is_return":"\u003cboolean\u003e","awb_tracking_number":"\u003cstring\u003e","box_number":"\u003cinteger\u003e","length":"\u003cstring\u003e","width":"\u003cstring\u003e","height":"\u003cstring\u003e","shipping_method_checkout_name":"\u003cstring\u003e","customs_declaration":{},"errors":{"non_field_errors":["\u003cstring\u003e","\u003cstring\u003e"]},"customs_information":{"customs_invoice_nr":"\u003cstring\u003e","customs_shipment_type":4,"export_type":"commercial_b2c","invoice_date":"\u003cdate\u003e","discount_granted":"\u003cstring\u003e","freight_costs":"\u003cstring\u003e","insurance_costs":"\u003cstring\u003e","other_costs":"\u003cstring\u003e","general_notes":"\u003cstring\u003e","additional_declaration_statements":["\u003cstring\u003e","\u003cstring\u003e"],"importer_of_record":{"name":"\u003cstring\u003e","address_1":"\u003cstring\u003e","city":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","country_code":"\u003cstring\u003e","company_name":"\u003cstring\u003e","address_2":"\u003cstring\u003e","house_number":"\u003cstring\u003e","country_state":"\u003cstring\u003e","telephone":"\u003cstring\u003e","email":"\u003cstring\u003e"},"tax_numbers":{"sender":[{"name":"KPP","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"IE","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"receiver":[{"name":"OGR","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"DLI","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"importer_of_record":[{"name":"SSN","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"TAN","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"}]},"return_data":{"return_postal_code":"\u003cstring\u003e","outbound_tracking_number":"\u003cstring\u003e","outbound_shipment_date":"\u003cdate\u003e","outbound_carrier_name":"\u003cstring\u003e"}}}]}