Ship Date

Specifying a shipping date can help schedule a pickup, receive a more accurate rate request, or more importantly enable you to Create a manifest for USPS.

Setting Up Your Request

USPS Test Mode

Generating USPS labels is like printing cash and generated labels are billed immediately, it's important to include "test_label": true in your request.

/v1/labels

curl $apiUrl$/v1/labels -X POST \
  -H "Content-type: application/json" \
  -H $apiAuth$ \
  -d '
{
  "shipment": {
    "service_code": "usps_priority_mail",
    "ship_date": "#shipBasicDate#",
    "ship_to": {
      "name": "Mickey and Minnie Mouse",
      "phone": "+1 (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"
    },
    "ship_from": {
      "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"
    },
    "packages": [
      {
        "weight": {
          "value": 1.0,
          "unit": "ounce"
        }
      }
    ]
  }
}'

Ship Date Localization

ship_date is regarded strictly as a date and will be passed to the carrier as such, and should be the date when the warehouse plans to ship the package.

Notice that we added shipment.ship_date to the request.

"ship_date": "$shipBasicDate$",
{
  "label_id": "se-test-41860047",
  "status": "processing",
  "shipment_id": "se-41860047",
  "ship_date": "$shipDate$",
  "created_at": "$date$",
  "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": 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
}

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


Ship Date


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.