Multi-Package Shipments

Why use multi-package shipping?

When you use multi-package shipping, you’re able to group packages, get discounted rates, and retrieve a one to many “master” tracking number.

Carrier Support

Not all carriers, and not all services support multi-package shipping. To learn which services support multi-package check the is_multi_package_supported property when making a List Carriers or List Carrier Services call.

Current carriers that have Multi-Package services include: FedEx, UPS, DHL Express, DHL Express Canada, DHL Express UK, FirstMile, Purolator Canada.

Example

POST /v1/labels

info This example uses a FedEx account linked to generate a multi-package label. There is no FedEx account hooked up to the documentation account.

curl -iX POST https://api.shipengine.com/v1/labels \
-H 'Content-Type: application/json' \
-H 'API-Key: __YOUR_API_KEY_HERE__' \
-d '
{
  "shipment": {
    "service_code": "fedex_express_saver",
    "ship_to": {
      "name": "Amanda Miller",
      "phone": "555-555-5555",
      "address_line1": "525 S Winchester Blvd",
      "city_locality": "San Jose",
      "state_province": "CA",
      "postal_code": "95128",
      "country_code": "US",
      "address_residential_indicator": "yes"
    },
    "ship_from": {
      "company_name": "Example Corp.",
      "name": "John Doe",
      "phone": "111-111-1111",
      "address_line1": "4009 Marathon Blvd",
      "address_line2": "Suite 300",
      "city_locality": "Austin",
      "state_province": "TX",
      "postal_code": "78756",
      "country_code": "US",
      "address_residential_indicator": "no"
    },
    "insurance_provider": "carrier",
    "packages": [
      {
        "weight": {
          "value": 10.0,
          "unit": "ounce"
        },
        "insured_value": {
          "amount": 110.00,
          "currency": "USD"
        },
        "dimensions": {
          "length": 10,
          "height": 10,
          "width": 10,
          "unit": "inch"
        }
      },
      {
        "weight": {
          "value": 20.0,
          "unit": "ounce"
        },
        "insured_value": {
          "amount": 200.00,
          "currency": "USD"
        },
        "dimensions": {
          "length": 15,
          "height": 15,
          "width": 15,
          "unit": "inch"
        }
      }
    ]
  }
}'
  • curl

Note You can specify separate insurance values for each package.

{
  "label_id": "se-57037035",
  "status": "completed",
  "shipment_id": "se-150831840",
  "ship_date": "2017-10-03T00:00:00Z",
  "created_at": "2017-10-03T15:57:59.533Z",
  "shipment_cost": {
    "currency": "usd",
    "amount": 130.72
  },
  "insurance_cost": {
    "currency": "usd",
    "amount": 6.00
  },
  "tracking_number": "787942854130",
  "is_return_label": false,
  "is_international": false,
  "batch_id": "",
  "carrier_id": "se-118627",
  "service_code": "fedex_express_saver",
  "package_code": "package",
  "voided": false,
  "voided_at": null,
  "label_format": "pdf",
  "label_layout": "4x6",
  "trackable": true,
  "carrier_code": "fedex",
  "tracking_status": "in_transit",
  "label_download": {
    "pdf": "https://api.shipengine.com/v1/downloads/1/s_Tqsu9euEKub6Acc_9UIg/testlabel-2128732.pdf",
    "png": "https://api.shipengine.com/v1/downloads/1/s_Tqsu9euEKub6Acc_9UIg/testlabel-2128732.png",
    "zpl": "https://api.shipengine.com/v1/downloads/1/s_Tqsu9euEKub6Acc_9UIg/testlabel-2128732.zpl",
    "href": "https://api.shipengine.com/v1/downloads/1/s_Tqsu9euEKub6Acc_9UIg/testlabel-2128732.pdf"
  },
  "form_download": null,
  "insurance_claim": null
}

Label Downloads

We consolidate all of the labels for a multi-package shipment into a multi-page PDF. Currently, we don't support the PNG format for multi-package shipments.

Master Tracking Label

This is the master tracking label, the first label in the series.

Second Tracking Label

The second label also includes the Master Tracking number on it.