Carrier Packaging

tip

Requirements

Package Basics

When you use a carrier package, this can affect things like your rate (e.g. USPS Flat Rat Boxes). Additionally, you cannot provide any dimensions for the package in the shipment. For this example, we're going to use USPS and send a medium_flat_rate_box.

Simply add the objects directly into the shipment object. This is the same format to use when getting shipping rates as well.

Example

POST /v1/labels/

Instead of Mickey using his own packaging, this time he's going to send us a stuffed version of himself in a USPS Medium Flat Rate Box, all we need to know to send that box is the weight, which is still 9.6 ounces.

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": "usps_priority_mail",
    "ship_to": {
      "name": "Dade Murphy",
      "phone": "512-485-4282",
      "company_name": "Zero Cool",
      "address_line1": "345 Chambers Street",
      "address_line2": "Suite 100",
      "city_locality": "New York City",
      "state_province": "NY",
      "postal_code": "10282",
      "country_code": "US",
      "address_residential_indicator": "no"
    },
    "ship_from": {
      "name": "Mickey and Minnie Mouse",
      "phone": "714-781-4565",
      "company_name": "The Walt Disney Company",
      "address_line1": "500 South Buena Vista Street",
      "city_locality": "Burbank",
      "state_province": "CA",
      "postal_code": "91521",
      "country_code": "US",
      "address_residential_indicator": "no"
    },
    "confirmation": "none",
    "insurance_provider": "none",
    "packages": [
      {
        "package_code": "medium_flat_rate_box",
        "weight": {
          "value": 9.6,
          "unit": "ounce"
        }
      }
    ]
  }
}'

We added the shipment_package[0].package_code and removed shipment_package[0].dimensions**:

"package_code": "medium_flat_rate_box",
{
  "label_id": "se-test-41844486",
  "status": "processing",
  "shipment_id": "se-41844486",
  "ship_date": "2019-07-25T05:00:00.000Z",
  "created_at": "2019-07-25T15:24:46.657Z",
  "shipment_cost": {
    "currency": "usd",
    "amount": 0.0
  },
  "insurance_cost": {
    "currency": "usd",
    "amount": 0.0
  },
  "tracking_number": "9999999999999",
  "is_return_label": false,
  "is_international": false,
  "batch_id": "",
  "carrier_id": "se-0",
  "service_code": "usps_priority_mail",
  "package_code": "medium_flat_rate_box",
  "voided": false,
  "voided_at": null,
  "label_format": "pdf",
  "label_layout": "4x6",
  "trackable": true,
  "carrier_code": "stamps_com",
  "tracking_status": "unknown",
  "label_download": {
    "pdf": "https://api.shipengine.com/v1/downloads/6/Q2OLdnGaqk-UzkN6pFH0lg/testlabel-202923521.pdf",
    "png": "https://api.shipengine.com/v1/downloads/6/Q2OLdnGaqk-UzkN6pFH0lg/testlabel-202923521.png",
    "zpl": "https://api.shipengine.com/v1/downloads/6/Q2OLdnGaqk-UzkN6pFH0lg/testlabel-202923521.zpl",
    "href": "https://api.shipengine.com/v1/downloads/6/Q2OLdnGaqk-UzkN6pFH0lg/testlabel-202923521.pdf"
  },
  "form_download": null,
  "insurance_claim": null
}

You can now print your label and ship it! Your label can be found by navigating to label_download.href.