Generating Separate Labels for Each Parcel
This document provides technical guidance on generating separate shipping labels for each parcel using the separate_parcel_labels parameter. By enabling this feature, each requested parcel receives its own individual label, simplifying logistics and improving shipment tracking.
Last updated 4 months ago
Enabling Separate Parcel Labels
To generate individual labels for each parcel in a shipment, include the separate_parcel_labels parameter within the shipment object of your create-label request.
Request Example
Example{
"testing": false,
"auth_company": "company",
"shipment": {
"label_size": "6x4",
"label_format": "pdf",
"generate_commercial_invoice": false,
"generate_packing_slip": false,
"separate_parcel_labels" : true,
"courier" : {
"friendly_service_name": "DHL 24H Service",
"global_product_code" : "U",
"local_product_code" : "U"
},
"collection_date": "2019-11-18T16:30:49.054Z",
"reference": "my reference",
"delivery_instructions": "Leave on the porch",
"ship_from": {
"name": "MN",
"phone": "01377337164",
"email": "foo@foo.com",
"company_name": "Fake Company",
"address_1": "unit 76",
"address_2": "warfield road",
"address_3": "",
"city": "Driffield",
"postcode": "YO25 9DJ",
"county": "",
"country_iso": "GB",
"company_id": "911-70-1234",
"tax_id": "911-70-1234",
"eori_id": "911-70-1234-000"
},
"ship_to": {
"name": "Laura Maura",
"phone": "466546346546",
"email": "support@buyer.com",
"company_name": "",
"address_1": "Ekeredsvaegen 132",
"address_2": "",
"address_3": "",
"city": "Lerum",
"county": "",
"postcode": "443 50",
"country_iso": "SE"
},
"parcels": [
{
"dim_width": 20,
"dim_height": 40,
"dim_length": 40,
"dim_unit": "cm",
"items": [
{
"description": "Test Item One",
"origin_country": "GB",
"quantity": 2,
"value": 20,
"value_currency": "GBP",
"weight": 0.6,
"weight_unit": "kg",
"sku": "EXPICKLIST",
"hs_code": "12345"
}, {
"description": "Test Item Two",
"origin_country": "GB",
"quantity": 1,
"value": 5,
"value_currency": "GBP",
"weight": 0.4,
"weight_unit": "kg",
"sku": "TEST0002",
"hs_code": "12345"
}]
},
{
"dim_width": 20,
"dim_height": 40,
"dim_length": 40,
"dim_unit": "cm",
"items": [
{
"description": "Test Item One",
"origin_country": "GB",
"quantity": 2,
"value": 20,
"value_currency": "GBP",
"weight": 0.6,
"weight_unit": "kg",
"sku": "EXPICKLIST",
"hs_code": "12345"
}, {
"description": "Test Item Two",
"origin_country": "GB",
"quantity": 1,
"value": 5,
"value_currency": "GBP",
"weight": 0.4,
"weight_unit": "kg",
"sku": "TEST0002",
"hs_code": "12345"
}]
}
]
},
"format_address_default" : true,
"request_id": 123456789
}Response Example
When separate_parcel_labels is set to true, the response includes an array of parcel labels, where each parcel has a unique label.
Example{
"type": "PDF",
"request_id": "1637676622",
"tracking_codes": [
"ZT4523619HHHH", "ZT4523619HHHI"
],
"tracking_urls": [
"https://www.royalmail.com/track-your-item#/tracking-results/ZT4",
"https://www.royalmail.com/track-your-item#/tracking-results/ZT6"
],
"uri": "https://example.com/parcels.pdf",
"key": "rm_rZJaEb09JLfRjGLOk.pdf",
"dc_request_id": 48820754,
"tracking_request_id": 48820754,
"tracking_request_hash": 536556463,
"label_size": "6x4",
"courier": "RoyalMail",
"parcel_labels" : [
{
"uri": "https://example.com/parcel1.pdf",
"key": "parcelmerge_38MFmJO3EHS8IXuyzBkZ.pdf",
"parcel_number": 1,
"parcel_identifier": "48820754-1",
"parcel": {
"dim_length": 10,
"dim_width": 10,
"dim_height": 10,
"dim_unit": "CM",
"items": [
{
"sku": "SKU01",
"description": "garden tool kit",
"value": 8,
"value_currency": "GBP",
"quantity": 1,
"origin_country": null,
"weight": 0.65,
"weight_unit": null,
"_original_value": 8
}
],
"_summed_item_weights": 0.65,
"_summed_total_weight": 0.65
}
},
{
"uri": "https://example.com/parcel2.pdf",
"key": "parcelmerge_bQeiFfBmmyYdkGhiuoVs.pdf",
"parcel_number": 2,
"parcel_identifier": "48820754-2",
"parcel": {
"dim_length": 10,
"dim_width": 10,
"dim_height": 10,
"dim_unit": "CM",
"items": [
{
"sku": "SKU01",
"description": "2 tool kit",
"value": 8,
"value_currency": "GBP",
"quantity": 1,
"origin_country": null,
"weight": 0.65,
"weight_unit": null,
"_original_value": 8
}
],
"_summed_item_weights": 0.65,
"_summed_total_weight": 0.65
}
}
]
}Each parcel label can be downloaded via the provided uri link.
Summary
Include
separate_parcel_labels: truein theshipmentobject of your request.The response will contain a
parcel_labelsarray with individual label URLs.Each parcel in the shipment will have its own separate label, improving clarity and efficiency in logistics.
For further details, refer to the API documentation or contact technical support.
