Sign in
labels

Purchase label with shipping rule

Purchase and print a shipping label using a Shipping Rule. The Shipping Rule automatically selects the optimal carrier and service based on the rule's configuration.

Dynamic Ordering: Service Group Rules can now use dynamic ordering (Cheapest or Fastest) to automatically rank eligible services in real time based on live rate or transit data. This feature is currently available for US sellers with USA domestic carrier services only. For more details, see the Configuring "Order Services By" guide.

The request body must NOT include carrier_id, service_code, or shipping_rule_id in the shipment object. If any of these fields are provided, the API will return a 400 Bad Request error.

post/v1/labels/shipping_rules/{shipping_rule_id}

Request body

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 nullable

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

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 ShipEngine resource, such as a carrier, label, shipment, 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.

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

The possible validate address values

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.
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' | 'paperless' | 'label_and_paperless'

The display format that the label should be shown in.

label_layout'4x6' | 'letter' | 'A4' | 'A6'

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_image_idstring

Used to identify an image resource.

Example request

{
  "shipment": {
    "external_order_id": "ext-order-123",
    "items": [
      {
        "asin": "B00005N5PF"
      }
    ],
    "external_shipment_id": "ext-ship-123",
    "shipment_number": "SHIP-001",
    "ship_date": "2018-09-23T00: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",
      "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",
      "geolocation": [
        {
          "type": "what3words",
          "value": "cats.with.thumbs"
        }
      ]
    },
    "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",
      "geolocation": [
        {
          "type": "what3words",
          "value": "cats.with.thumbs"
        }
      ]
    },
    "customs": {
      "terms_of_trade_code": "ddp",
      "contents": "gift",
      "non_delivery": "return_to_sender"
    },
    "advanced_options": {
      "bill_to_country_code": "CA",
      "freight_class": "77.5",
      "movement_indicator": "c2c",
      "license_number": "514785",
      "invoice_number": "IOC56888",
      "certificate_number": "784515",
      "fragile": true,
      "delivery_as_addressed": true,
      "return_after_first_attempt": true,
      "netstamps_options": {
        "row": 1,
        "column": 1
      }
    },
    "packages": [
      {
        "shipment_package_id": "se-28529731",
        "package_id": "se-28529731",
        "package_code": "small_flat_rate_box",
        "content_description": "Hand knitted wool socks",
        "products": [
          {
            "harmonized_tariff_code": "3926.1",
            "country_of_origin": "CA",
            "vat_rate": 0.2,
            "manufacturer_product_id": "012345678905",
            "manufacturer_ns_product_id": "MY-SKU-12345",
            "cpsc_certificates": [
              {
                "certifier_id": "CERT-12345",
                "certificate_version_id": "v1.0"
              }
            ],
            "cpsc_disclaim": {
              "disclaim_code": "B",
              "intended_use_code": "130.006"
            }
          }
        ]
      }
    ],
    "comparison_rate_type": "retail"
  },
  "rma_number": "RMA-12345",
  "outbound_label_id": "se-28529731",
  "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK"
}

Response

The requested object creation was a success.

label_idstring

A string that uniquely identifies a ShipEngine 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 ShipEngine resource, such as a carrier, label, shipment, etc.

external_shipment_idstring nullable

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

external_order_idstring nullable

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 ShipEngine.

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 nullable

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 ShipEngine resource, such as a carrier, label, shipment, etc.

carrier_idstring

A string that uniquely identifies a ShipEngine 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 ShipEngine 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.
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' | 'paperless' | 'label_and_paperless'

The display format that the label should be shown in.

label_layout'4x6' | 'letter' | 'A4' | 'A6'

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.

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

The different statuses that can apply to a shipment.

confirmation'none' | 'delivery' | 'signature' | 'adult_signature' | 'adult_signature_restricted_delivery' | 'direct_signature' | 'delivery_mailed' | 'verbal_confirmation' | 'delivery_code' | 'age_verification_16_plus'

The possible delivery confirmation values

tracking_urlstring nullable

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

void_type'refund_assist' | 'manual' nullable

Indicates how the label was voided. This field is null if the label has not been voided.

Example response

{
  "label_id": "se-28529731",
  "shipment_id": "se-28529731",
  "shipment": {
    "shipment_id": "se-28529731",
    "carrier_id": "se-28529731",
    "service_code": "usps_first_class_mail",
    "shipping_rule_id": "se-28529731",
    "items": [
      {
        "asin": "B00005N5PF"
      }
    ],
    "ship_date": "2018-09-23T00:00:00.000Z",
    "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",
      "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",
      "geolocation": [
        {
          "type": "what3words",
          "value": "cats.with.thumbs"
        }
      ]
    },
    "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",
      "geolocation": [
        {
          "type": "what3words",
          "value": "cats.with.thumbs"
        }
      ]
    },
    "customs": {
      "terms_of_trade_code": "ddp",
      "contents": "gift",
      "non_delivery": "return_to_sender"
    },
    "advanced_options": {
      "bill_to_country_code": "CA",
      "freight_class": "77.5",
      "movement_indicator": "c2c",
      "license_number": "514785",
      "invoice_number": "IOC56888",
      "certificate_number": "784515",
      "fragile": true,
      "delivery_as_addressed": true,
      "return_after_first_attempt": true,
      "netstamps_options": {
        "row": 1,
        "column": 1
      }
    },
    "tags": [
      {
        "tag_id": 8712,
        "name": "Fragile",
        "color": "#FF0000"
      }
    ],
    "packages": [
      {
        "shipment_package_id": "se-28529731",
        "package_id": "se-28529731",
        "package_code": "small_flat_rate_box",
        "content_description": "Hand knitted wool socks",
        "products": [
          {
            "harmonized_tariff_code": "3926.1",
            "country_of_origin": "CA",
            "vat_rate": 0.2,
            "manufacturer_product_id": "012345678905",
            "manufacturer_ns_product_id": "MY-SKU-12345",
            "cpsc_certificates": [
              {
                "certifier_id": "CERT-12345",
                "certificate_version_id": "v1.0"
              }
            ],
            "cpsc_disclaim": {
              "disclaim_code": "B",
              "intended_use_code": "130.006"
            }
          }
        ]
      }
    ],
    "comparison_rate_type": "retail",
    "zone": 6
  },
  "ship_date": "2018-09-23T00:00:00.000Z",
  "created_at": "2018-09-23T15:00:00.000Z",
  "rate_details": [
    {
      "carrier_description": "Shipping",
      "carrier_billing_code": "BaseServiceCharge",
      "billing_source": "carrier"
    }
  ],
  "tracking_number": "782758401696",
  "batch_id": "se-28529731",
  "carrier_id": "se-28529731",
  "outbound_label_id": "se-28529731",
  "service_code": "usps_first_class_mail",
  "package_code": "small_flat_rate_box",
  "voided_at": "2018-09-23T15:00:00.000Z",
  "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK",
  "carrier_code": "dhl_express",
  "label_download": {
    "href": "https://example.com/resource",
    "pdf": "https://example.com/resource",
    "png": "https://example.com/resource",
    "zpl": "https://example.com/resource"
  },
  "form_download": {
    "href": "https://example.com/resource"
  },
  "qr_code_download": {
    "href": "https://example.com/resource"
  },
  "paperless_download": {
    "href": "https://example.com/resource"
  },
  "insurance_claim": {
    "href": "https://example.com/resource"
  },
  "packages": [
    {
      "package_code": "small_flat_rate_box",
      "tracking_number": "1Z932R800392060079",
      "label_download": {
        "href": "https://example.com/resource",
        "pdf": "https://example.com/resource",
        "png": "https://example.com/resource",
        "zpl": "https://example.com/resource"
      },
      "form_download": {
        "href": "https://example.com/resource"
      },
      "qr_code_download": {
        "href": "https://example.com/resource"
      },
      "paperless_download": {
        "href": "https://example.com/resource"
      },
      "content_description": "Hand knitted wool socks",
      "alternative_identifiers": [
        {
          "type": "last_mile_tracking_number",
          "value": "12345678912345678912"
        }
      ]
    }
  ],
  "alternative_identifiers": [
    {
      "type": "last_mile_tracking_number",
      "value": "12345678912345678912"
    }
  ],
  "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234",
  "pickup_windows": [
    {
      "start_at": "2018-09-23T15:00:00.000Z",
      "end_at": "2018-09-23T15:00:00.000Z",
      "use_time_zone_iana": "Australia/Sydney"
    }
  ],
  "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",
    "geolocation": [
      {
        "type": "what3words",
        "value": "cats.with.thumbs"
      }
    ]
  },
  "void_type": "manual",
  "refund_details": {
    "request_date": "2018-09-23T15:00:00.000Z"
  }
}

Changes

Changed in 4 of the 8 revisions of this API.205

  • af72189901592See the full diff
    • ○

      added the new optional request property ////

      new-optional-request-property

    • ○

      added the optional property ////// to the response with the status

      response-optional-property-added

  • 45d27f8700ae2See the full diff
    • ○

      added the new optional request property ///////

      new-optional-request-property

    • ○

      added the optional property ///////// to the response with the status

      response-optional-property-added

  • 3a3a81a22d2f21See the full diff
    • ●

      added the new adult_signature_restricted_delivery enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new adult_signature_restricted_delivery enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ○

      added the new adult_signature_restricted_delivery enum value to the request property ///

      request-property-enum-value-added

  • f3a66d20456518See the full diff
    • ●

      added the new freight_connection_inactive enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new freight_connection_inactive enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new freight_connection_inactive enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new freight_provider_id_required enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new freight_provider_id_required enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new freight_provider_id_required enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new freight_shipment_not_batchable enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new freight_shipment_not_batchable enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new freight_shipment_not_batchable enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new freight_shipment_not_found enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new freight_shipment_not_found enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new freight_shipment_not_found enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new freight_tracking_not_available enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new freight_tracking_not_available enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new freight_tracking_not_available enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new freight_tracking_not_found enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new freight_tracking_not_found enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new freight_tracking_not_found enum value to the //// response property for the response status

      response-property-enum-value-added

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog