Use a Rate to Print a Label

tip

Requirements

  • This lesson assumes you know how to Get Shipping Rates.
  • You will need to use the rate_response[i].rate_id from the Get Shipping Rates request above.

Similar to our example in Quickstart: Create a Label, we're going to request a label using USPS with the Stamps.com carrier that's included with your account.

When you use a rate_id to create a label you have already done the hard part. We persist all of the rate information, just pass us the rate_id. Update the cURL command below to use a rate_id you gathered from a previous command.

Example

POST v1/labels/rates/:rate_id

curl -iX POST https://api.shipengine.com/v1/labels/rates/se-2128728 \
-H 'Content-Type: application/json' \
-H 'API-Key: __YOUR_API_KEY_HERE__' \
-d '
{
  "label_format":"pdf",
  "label_layout": "4x6",
}'
{
  "label_id": "se-test-2128728",
  "status": "completed",
  "shipment_id": "se-2128728",
  "ship_date": "2019-07-25T05:00:00.000Z",
  "created_at": "2019-07-25T18:43:15.038Z",
  "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": "package",
  "voided": false,
  "voided_at": null,
  "label_format": "pdf",
  "label_layout": "4x6",
  "trackable": false,
  "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
}

That's it, your label is available for download using the label_download.href URL provided in the response.