labels

Purchase label with rate id

When retrieving rates for shipments using the /rates endpoint, the returned information contains a rate_id property that can be used to generate a label without having to refill in the shipment information repeatedly.

post/v2/labels/rates/{rate_id}

Request

  • Base URL: https://api.shipstation.com
  • URL: https://api.shipstation.com/v2/labels/rates/{rate_id}
  • Auth: API key in header api-key

Request body

validate_address'no_validation' | 'validate_only' | 'validate_and_clean'

The possible validate address values

label_layout'4x6' | 'letter'

The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. 4x6 is supported for all label formats, whereas letter (8.5" x 11") is only supported for pdf format.

label_format'pdf' | 'png' | 'zpl'

The possible file formats in which shipping labels can be downloaded. We recommend pdf format because it is supported by all carriers, whereas some carriers do not support the png or zpl formats.

Label FormatSupported Carriers
pdfAll carriers
pngfedex <br> stamps_com <br> ups <br> usps
zplaccess_worldwide <br> apc <br> asendia <br> dhl_global_mail <br> dhl_express <br> dhl_express_australia <br> dhl_express_canada <br> dhl_express_worldwide <br> dhl_express_uk <br> dpd <br> endicia <br> fedex <br> fedex_uk <br> firstmile <br> imex <br> newgistics <br> ontrac <br> rr_donnelley <br> stamps_com <br> ups <br> usps
label_download_type'url' | 'inline'

There are two different ways to [download a label]:

Label Download TypeDescription
urlYou will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days.<br><br>This is the default if label_download_type is unspecified.
inlineYou will receive the Base64-encoded label as part of the response. No need for a second request to download the label.
display_scheme'label' | 'qr_code' | 'label_and_qr_code' | 'paperless' | 'label_and_paperless'

The display format that the label should be shown in.

Response

The requested object creation was a success.

label_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

status'processing' | 'completed' | 'error' | 'voided'

The possible statuses that a [shipping label] can be in.

StatusDescription
processingWhen labels are created in a [batch], it may take a few minutes for all of the labels in the batch to be created. During this period, they will be in processing status.
completedThe label was successfully created
errorThe label could not be created due to an error, such as an invalid delivery address
voidedThe label has been [voided]
shipment_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

external_shipment_idstring

A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.

Warning: The external_shipment_id is limited to 50 characters. Any additional characters will be truncated.

external_order_idstring

ID that the Order Source assigned

ship_datestring date-time

An ISO 8601 string that represents a date, but not a specific time. The value may contain a time component, but it will be set to 00:00:00 UTC by ShipStation .

created_atstring date-time

An ISO 8601 string that represents a date and time.

tracking_numberstring

The tracking number for the package. Tracking number formats vary across carriers.

is_return_labelboolean

Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.

rma_numberstring

An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.

is_internationalboolean

Indicates whether this is an international shipment. That is, the originating country and destination country are different.

batch_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

carrier_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

charge_event'carrier_default' | 'on_creation' | 'on_carrier_acceptance'

Determines when the user's account will be charged for the label.

outbound_label_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

service_codestring

A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.

test_labelboolean

Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.

package_codestring

A [package type] , such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.

validate_address'no_validation' | 'validate_only' | 'validate_and_clean'

The possible validate address values

voidedboolean

Indicates whether the label has been [voided]

voided_atstring date-time

An ISO 8601 string that represents a date and time.

label_download_type'url' | 'inline'

There are two different ways to [download a label]:

Label Download TypeDescription
urlYou will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days.<br><br>This is the default if label_download_type is unspecified.
inlineYou will receive the Base64-encoded label as part of the response. No need for a second request to download the label.
label_format'pdf' | 'png' | 'zpl'

The possible file formats in which shipping labels can be downloaded. We recommend pdf format because it is supported by all carriers, whereas some carriers do not support the png or zpl formats.

Label FormatSupported Carriers
pdfAll carriers
pngfedex <br> stamps_com <br> ups <br> usps
zplaccess_worldwide <br> apc <br> asendia <br> dhl_global_mail <br> dhl_express <br> dhl_express_australia <br> dhl_express_canada <br> dhl_express_worldwide <br> dhl_express_uk <br> dpd <br> endicia <br> fedex <br> fedex_uk <br> firstmile <br> imex <br> newgistics <br> ontrac <br> rr_donnelley <br> stamps_com <br> ups <br> usps
display_scheme'label' | 'qr_code' | 'label_and_qr_code' | 'paperless' | 'label_and_paperless'

The display format that the label should be shown in.

label_layout'4x6' | 'letter'

The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. 4x6 is supported for all label formats, whereas letter (8.5" x 11") is only supported for pdf format.

trackableboolean

Indicates whether the shipment is trackable, in which case the tracking_status field will reflect the current status and each package will have a tracking_number.

label_image_idstring

Used to identify an image resource.

carrier_codestring

A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.

confirmation'none' | 'delivery' | 'signature' | 'adult_signature' | 'direct_signature' | 'delivery_mailed' | 'verbal_confirmation'

The possible delivery confirmation values

tracking_status'unknown' | 'in_transit' | 'error' | 'delivered'

The different statuses that can apply to a shipment.

tracking_urlstring

The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.

Example response

{
  "label_id": "se-28529731",
  "shipment_id": "se-28529731",
  "external_shipment_id": "externalId-1234556",
  "external_order_id": "externalOrderId-1232434",
  "shipment": {
    "shipment_id": "se-28529731",
    "carrier_id": "se-28529731",
    "service_code": "usps_first_class_mail",
    "requested_shipment_service": "usps_priority_mail",
    "shipping_rule_id": "se-28529731",
    "external_order_id": "1232434",
    "hold_until_date": "2025-01-15T00:00:00.000Z",
    "ship_by_date": "2025-01-15T00:00:00.000Z",
    "retail_rate": {
      "amount": 12
    },
    "store_id": "se-28529731",
    "items": [
      {
        "name": "box",
        "sales_order_id": "12345",
        "sales_order_item_id": "1234556",
        "quantity": 1,
        "sku": "sku-1234",
        "bundle_sku": "bundle-123",
        "external_order_id": "123445",
        "external_order_item_id": "12",
        "asin": "B00005N5PF",
        "item_id": "1402291169813",
        "allocation_status": "allocated",
        "image_url": "https://example.com/image.jpg",
        "weight": {
          "value": 23
        },
        "unit_price": 88,
        "tax_amount": 5.5,
        "shipping_amount": 10,
        "inventory_location": "warehouse-a",
        "options": [
          {
            "name": "Color",
            "value": "Red"
          }
        ],
        "product_id": "10408926",
        "fullfilment_sku": "fulfill-123",
        "upc": "123456789012"
      }
    ],
    "notes_from_buyer": "Please handle with care",
    "notes_for_gift": "Happy Birthday!",
    "is_gift": true,
    "assigned_user": "user@example.com",
    "amount_paid": {
      "amount": 12
    },
    "shipping_paid": {
      "amount": 12
    },
    "tax_paid": {
      "amount": 12
    },
    "zone": 1,
    "display_scheme": "label",
    "tax_identifiers": [
      {
        "issuing_authority": "US",
        "value": "value"
      }
    ],
    "external_shipment_id": "1234556",
    "shipment_number": "10001",
    "ship_date": "2018-09-23",
    "created_at": "2018-09-23T15:00:00.000Z",
    "modified_at": "2018-09-23T15:00:00.000Z",
    "ship_to": {
      "name": "John Doe",
      "phone": "+1 204-253-9411 ext. 123",
      "email": "example@example.com",
      "company_name": "The Home Depot",
      "address_line1": "1999 Bishop Grandin Blvd.",
      "address_line2": "Unit 408",
      "address_line3": "Building #7",
      "city_locality": "Winnipeg",
      "state_province": "Manitoba",
      "postal_code": "78756-3717",
      "country_code": "CA",
      "instructions": "any instruction",
      "geolocation": [
        {
          "type": "what3words",
          "value": "cats.with.thumbs"
        }
      ]
    },
    "ship_from": {
      "name": "John Doe",
      "phone": "+1 204-253-9411 ext. 123",
      "email": "example@example.com",
      "company_name": "The Home Depot",
      "address_line1": "1999 Bishop Grandin Blvd.",
      "address_line2": "Unit 408",
      "address_line3": "Building #7",
      "city_locality": "Winnipeg",
      "state_province": "Manitoba",
      "postal_code": "78756-3717",
      "country_code": "CA",
      "instructions": "any instructions"
    },
    "warehouse_id": "se-28529731",
    "return_to": {
      "name": "John Doe",
      "phone": "+1 204-253-9411 ext. 123",
      "email": "example@example.com",
      "company_name": "The Home Depot",
      "address_line1": "1999 Bishop Grandin Blvd.",
      "address_line2": "Unit 408",
      "address_line3": "Building #7",
      "city_locality": "Winnipeg",
      "state_province": "Manitoba",
      "postal_code": "78756-3717",
      "country_code": "CA",
      "instructions": "any instructions"
    },
    "is_return": true,
    "customs": {
      "contents_explanation": "rubber duckies",
      "declaration": "I hereby certify that the information on this invoice is true and correct and that the contents and value of this shipment are as stated above",
      "invoice_additional_details": {
        "freight_charge": {
          "amount": 12
        },
        "insurance_charge": {
          "amount": 12
        },
        "discount": {
          "amount": 12
        },
        "estimated_import_charges": {
          "taxes": {
            "amount": 12
          },
          "duties": {
            "amount": 12
          }
        },
        "other_charge": {
          "amount": 12
        },
        "other_charge_description": "Other charges description"
      },
      "importer_of_record": {
        "name": "John Doe",
        "phone": "+1 204-253-9411 ext. 123",
        "email": "example@example.com",
        "company_name": "The Home Depot",
        "address_line1": "1999 Bishop Grandin Blvd.",
        "address_line2": "Unit 408",
        "address_line3": "Building #7",
        "city_locality": "Winnipeg",
        "state_province": "Manitoba",
        "postal_code": "78756-3717",
        "country_code": "CA"
      },
      "customs_items": [
        {
          "customs_item_id": "se-28529731",
          "description": "This is a description",
          "quantity": 1,
          "value": 12,
          "value_currency": "USD",
          "weight": {
            "value": 23
          },
          "harmonized_tariff_code": "3926.10",
          "country_of_origin": "CA",
          "unit_of_measure": "pound",
          "sku": "sku-1234",
          "sku_description": "this is a description"
        }
      ]
    },
    "advanced_options": {
      "bill_to_account": "123456789",
      "bill_to_country_code": "CA",
      "bill_to_postal_code": "28005",
      "contains_alcohol": true,
      "delivered_duty_paid": true,
      "dry_ice": true,
      "dry_ice_weight": {
        "value": 23
      },
      "non_machinable": true,
      "saturday_delivery": true,
      "fedex_freight": {
        "shipper_load_and_count": "shipper_load_and_count",
        "booking_confirmation": "today"
      },
      "use_ups_ground_freight_pricing": true,
      "freight_class": "77.5",
      "custom_field1": "custom field 1",
      "custom_field2": "custom field 2",
      "custom_field3": "custom field 3",
      "additional_handling": true,
      "shipper_release": true,
      "collect_on_delivery": {
        "payment_amount": {
          "amount": 12
        }
      },
      "third_party_consignee": true,
      "dangerous_goods": true,
      "dangerous_goods_contact": {
        "name": "Michael Robinson",
        "phone": "123456578789"
      },
      "windsor_framework_details": {
        "movement_indicator": "b2b",
        "not_at_risk": true
      },
      "ancillary_endorsements_option": "forward",
      "return_pickup_attempts": 3
    },
    "tags": [
      {
        "name": "Fragile"
      }
    ],
    "packages": [
      {
        "shipment_package_id": "se-28529731",
        "package_id": "se-28529731",
        "package_code": "small_flat_rate_box",
        "package_name": "Flat Rate Envelope",
        "weight": {
          "value": 23
        },
        "dimensions": {
          "length": 2,
          "width": 2,
          "height": 1
        },
        "insured_value": {
          "amount": 12
        },
        "label_messages": {
          "reference1": "Reference",
          "reference2": "Reference 2",
          "reference3": "Reference 3"
        },
        "external_package_id": "se-1234545",
        "tracking_number": "1Z932R800392060079",
        "content_description": "Hand knitted wool socks",
        "products": [
          {
            "description": "a minimum description",
            "quantity": 1,
            "value": {
              "amount": 12
            },
            "weight": {
              "value": 23
            },
            "harmonized_tariff_code": "3926.10",
            "country_of_origin": "CA",
            "unit_of_measure": "pound",
            "sku": "sku-1223344",
            "sku_description": "this is a description",
            "mid_code": "GBCOM15BRI",
            "product_url": "https://myproduct.com",
            "vat_rate": 0.2,
            "dangerous_goods": [
              {
                "id_number": "1234r1",
                "shipping_name": "things with dangerous goods",
                "technical_name": "chloric acid",
                "product_class": "1987",
                "product_class_subsidiary": "1987",
                "packaging_group": "ii",
                "dangerous_amount": {
                  "amount": 12,
                  "unit": "GBP"
                },
                "quantity": 1,
                "packaging_instruction": "Packaging materials and containers that are in contact with food products must comply with the provisions established by Regulation ",
                "packaging_instruction_section": "section_1",
                "packaging_type": "X",
                "transport_mean": "ground",
                "transport_category": "6.1",
                "regulation_authority": "AEAT",
                "regulation_level": "excepted_quantity",
                "tunnel_code": "all",
                "additional_description": "any description"
              }
            ]
          }
        ]
      }
    ],
    "total_weight": {
      "value": 3
    },
    "comparison_rate_type": "retail"
  },
  "ship_date": "2018-09-23",
  "created_at": "2018-09-23T15:00:00.000Z",
  "shipment_cost": {
    "amount": 12
  },
  "insurance_cost": {
    "amount": 12
  },
  "requested_comparison_amount": {
    "amount": 12
  },
  "tracking_number": "782758401696",
  "is_return_label": true,
  "rma_number": "asd12323",
  "is_international": true,
  "batch_id": "se-28529731",
  "carrier_id": "se-28529731",
  "outbound_label_id": "se-28529731",
  "service_code": "usps_first_class_mail",
  "test_label": true,
  "package_code": "small_flat_rate_box",
  "voided": true,
  "voided_at": "2018-09-23T15:00:00.000Z",
  "trackable": true,
  "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK",
  "carrier_code": "dhl_express",
  "label_download": {
    "href": "http://api.shipstation.com/v2/labels/se-28529731",
    "pdf": "http://api.shipstation.com/v2/labels/se-28529731",
    "png": "http://api.shipstation.com/v2/labels/se-28529731",
    "zpl": "http://api.shipstation.com/v2/labels/se-28529731"
  },
  "form_download": {
    "href": "http://api.shipstation.com/v2/labels/se-28529731",
    "type": "child"
  },
  "qr_code_download": {
    "href": "http://api.shipstation.com/v2/labels/se-28529731",
    "type": "child"
  },
  "paperless_download": {
    "href": "http://api.shipstation.com/v2/labels/se-28529731",
    "instructions": "any instructions",
    "handoff_code": "122334"
  },
  "insurance_claim": {
    "href": "http://api.shipstation.com/v2/labels/se-28529731",
    "type": "child"
  },
  "packages": [
    {
      "package_id": 1234545,
      "package_code": "small_flat_rate_box",
      "weight": {
        "value": 23
      },
      "dimensions": {
        "length": 2,
        "width": 2,
        "height": 1
      },
      "insured_value": {
        "amount": 12
      },
      "tracking_number": "1Z932R800392060079",
      "label_download": {
        "href": "http://api.shipstation.com/v2/labels/se-28529731",
        "pdf": "http://api.shipstation.com/v2/labels/se-28529731",
        "png": "http://api.shipstation.com/v2/labels/se-28529731",
        "zpl": "http://api.shipstation.com/v2/labels/se-28529731"
      },
      "form_download": {
        "href": "http://api.shipstation.com/v2/labels/se-28529731",
        "type": "child"
      },
      "qr_code_download": {
        "href": "http://api.shipstation.com/v2/labels/se-28529731",
        "type": "child"
      },
      "paperless_download": {
        "href": "http://api.shipstation.com/v2/labels/se-28529731",
        "instructions": "any instructions",
        "handoff_code": "122334"
      },
      "label_messages": {
        "reference1": "Reference",
        "reference2": "Reference 2",
        "reference3": "Reference 3"
      },
      "external_package_id": "se-1234567",
      "content_description": "Hand knitted wool socks",
      "sequence": 34,
      "has_label_documents": true,
      "has_form_documents": true,
      "has_qr_code_documents": true,
      "has_paperless_label_documents": true,
      "alternative_identifiers": [
        {
          "type": "last_mile_tracking_number",
          "value": "12345678912345678912"
        }
      ]
    }
  ],
  "alternative_identifiers": [
    {
      "type": "last_mile_tracking_number",
      "value": "12345678912345678912"
    }
  ],
  "rate_details": [
    {
      "rate_detail_type": "shipping",
      "carrier_description": "Shipping",
      "carrier_billing_code": "shipping",
      "amount": {
        "amount": 12
      },
      "billing_source": "carrier"
    }
  ],
  "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234",
  "ship_to": {
    "name": "John Doe",
    "phone": "+1 204-253-9411 ext. 123",
    "email": "example@example.com",
    "company_name": "The Home Depot",
    "address_line1": "1999 Bishop Grandin Blvd.",
    "address_line2": "Unit 408",
    "address_line3": "Building #7",
    "city_locality": "Winnipeg",
    "state_province": "Manitoba",
    "postal_code": "78756-3717",
    "country_code": "CA",
    "instructions": "any instruction",
    "geolocation": [
      {
        "type": "what3words",
        "value": "cats.with.thumbs"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.