Skip to content

Create Labels

ShipStation API

https://www.shipstation.com/docs/api/shipments/create-label/

Description

The Create Labels integration generates a shipping label for the specified order.

Update Mode

Only Insert

Generating a Label

To generate a shipping label you need to specify the following fields (at minimum):

  • carrierCode
  • serviceCode
  • fromName, fromStreet1, fromCity, fromPostalCode, fromCountry
  • toName, toStreet1, toCity, toPostalCode, toCountry
  • weight
  • weightUoM
  • dimensionLength
  • dimensionWidth
  • dimensionHeight
  • dimensionUoM

Map empty fields to the writeback fields.

Writeback Fields

A successful generation will return the following:

  • reply_shipment_id
    • The ShipStation assigned shipment id.
  • reply_shipment_cost
    • The cost of the shipment.
  • reply_insurance_cost
    • Any insurance cost associated with the shipment.
  • reply_tracking_number
    • The tracking number.
  • reply_labelData
    • The base64 encoded version of the carrier's label.
  • reply_labelDataBinary
    • The binary version of the label. This is useful for sending the generated label to a printer or saving it as a file.
    • The field being mapped must be set a binary type for this to succeed.