ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices.
Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service.
No matter your shipping volume, failed deliveries and address change surcharges cut into your bottom line and damage perception with customers. Our address validation services ensure your packages make it to the right place the first time. Learn how to leverage our address validation services here.
ShipEngine supports address validation for virtually every country on Earth, including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
The shipments to create NetStamps labels for. All shipments must use the same carrier_id.
Each shipment must include advanced_options.netstamps_options with row and column to control stamp placement. Row/column combinations must be unique across shipments.
The carrier account that is billed for the shipping charges
A carrier service, such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
Describe the packages included in this shipment as related to potential metadata that was imported from external order sources
A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.
Warning: The
external_shipment_idis limited to 50 characters. Any additional characters will be truncated.
A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment.
Warning: The
shipment_numberis limited to 50 characters. Any additional characters will be truncated.
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.
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
Email for the address owner.
If this is a business address, then the company name should be specified here.
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
The second line of the street address. For some addresses, this line may not be needed.
The third line of the street address. For some addresses, this line may not be needed.
The name of the city or locality
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
postal code
A two-letter ISO 3166-1 country code
Indicates whether this is a residential address.
Additional text about how to handle the shipment at this address.
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
The warehouse that the shipment is being shipped from. Either warehouse_id or ship_from must be specified.
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.
The type of delivery confirmation that is required for this shipment.
Customs information. This is usually only needed for international shipments.
Advanced shipment options. These are entirely optional.
The insurance provider to use for any insured packages in the shipment.
The order sources that are supported by ShipEngine
The packages in the shipment.
Note: Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.
A string that uniquely identifies this package type
A package type, such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
The package weight
The insured value of the package. Requires the insurance_provider field of the shipment to be set.
Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier.
| Carrier | Max lines | Max line length |
|---|---|---|
| USPS (Stamps.com) | 3 | 60 |
| FedEx | 3 | 35 for the first line. 30 for additional lines. |
| UPS | 2 | 35 |
| OnTrac | 2 | 25 |
A short description of the package content. Required for shipments moving to, from, and through Mexico.
The NetStamps layout to use.
The display format that the label should be shown in.
Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.
There are two different ways to download a label:
| Label Download Type | Description |
|---|---|
url | You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days. |
inline | You will receive the Base64-encoded label as part of the response. No need for a second request to download the label. |
An optional Return Merchandise Authorization number for return labels.
The label charge event.
The label_id of the original label that the return label is for.
The possible validate address values
The label image resource that was used to create a custom label image.
A unique identifier for a carrier service point where the shipment will be delivered.
curl -i -X POST \
https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/mailing/netstamps \
-H 'API-Key: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"shipments": [
{
"carrier_id": "se-28529731",
"service_code": "usps_first_class_mail",
"external_order_id": "string",
"items": [],
"tax_identifiers": [
{
"taxable_entity_type": "shipper",
"identifier_type": "vat",
"issuing_authority": "string",
"value": "string"
}
],
"external_shipment_id": "string",
"shipment_number": "string",
"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",
"address_residential_indicator": "no",
"instructions": "string",
"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",
"address_residential_indicator": "no",
"instructions": "string"
},
"warehouse_id": null,
"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",
"address_residential_indicator": "no",
"instructions": "string"
},
"is_return": false,
"confirmation": "none",
"customs": null,
"advanced_options": {
"bill_to_account": null,
"bill_to_country_code": null,
"bill_to_party": null,
"bill_to_postal_code": null,
"contains_alcohol": false,
"delivered_duty_paid": false,
"dry_ice": false,
"dry_ice_weight": {
"value": 0,
"unit": "pound"
},
"non_machinable": false,
"saturday_delivery": false,
"fedex_freight": {
"shipper_load_and_count": "string",
"booking_confirmation": "string"
},
"use_ups_ground_freight_pricing": null,
"freight_class": "77.5",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"origin_type": null,
"additional_handling": null,
"shipper_release": null,
"collect_on_delivery": {
"payment_type": "any",
"payment_amount": {
"currency": "string",
"amount": 0
}
},
"third_party_consignee": false,
"dangerous_goods": false,
"dangerous_goods_contact": {
"name": "string",
"phone": "string"
},
"windsor_framework_details": {
"movement_indicator": "c2c",
"not_at_risk": true
},
"license_number": "514785",
"invoice_number": "IOC56888",
"certificate_number": "784515",
"fragile": true,
"delivery_as_addressed": true,
"return_after_first_attempt": true,
"regulated_content_type": null,
"netstamps_options": {
"row": 1,
"column": 1
}
},
"insurance_provider": "none",
"order_source_code": "amazon_ca",
"packages": [
{
"package_id": "se-28529731",
"package_code": "small_flat_rate_box",
"package_name": "string",
"weight": {
"value": 0,
"unit": "pound"
},
"dimensions": {
"unit": "inch",
"length": 0,
"width": 0,
"height": 0
},
"insured_value": {
"currency": "USD",
"amount": 0
},
"label_messages": {
"reference1": null,
"reference2": null,
"reference3": null
},
"external_package_id": "string",
"content_description": "Hand knitted wool socks",
"products": []
}
],
"comparison_rate_type": "retail"
}
],
"label_layout": "netstamps_traditional",
"label_format": "pdf",
"display_scheme": "label",
"test_label": true,
"label_download_type": "url",
"is_return_label": true,
"rma_number": "asd12323",
"charge_event": "carrier_default",
"outbound_label_id": "se-28529731",
"validate_address": "no_validation",
"label_image_id": "img_DtBXupDBxREpHnwEXhTfgK",
"ship_to_service_point_id": "614940",
"ship_from_service_point_id": "614940"
}'The labels were created successfully.
A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.
The possible statuses that a shipping label can be in.
| Status | Description |
|---|---|
processing | When 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. |
completed | The label was successfully created |
error | The label could not be created due to an error, such as an invalid delivery address |
voided | The label has been voided |
The shipment that this label is for. ShipEngine can create a shipment for you automatically when you create a label, or you can create your own shipment and then use it to print a label
A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.
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.
An ISO 8601 string that represents a date and time.
The cost of shipping, delivery confirmation, and other carrier charges. This amount does not include insurance costs.
The insurance cost for this package. Add this to the shipment_cost field to get the total cost.
The total shipping cost for the specified comparison_rate_type.
A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user.
The tracking number for the package. Tracking number formats vary across carriers.
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Indicates whether this is an international shipment. That is, the originating country and destination country are different.
If this label was created as part of a batch, then this is the unique ID of that batch.
The unique ID of the carrier account that was used to create this label
The label charge event.
A carrier service, such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
A package type, such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
An ISO 8601 string that represents a date and time.
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 Format | Supported Carriers |
|---|---|
pdf | All carriers |
png | fedex stamps_com ups usps |
zpl | access_worldwide apc asendia dhl_global_mail dhl_express dhl_express_australia dhl_express_canada dhl_express_worldwide dhl_express_uk dpd endicia fedex fedex_uk firstmile imex newgistics ontrac rr_donnelley stamps_com ups usps |
The display format that the label should be shown in.
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.
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.
The label image resource that was used to create a custom label image.
A shipping carrier, such as fedex, dhl_express, stamps_com, etc.
The current status of the package, such as in_transit or delivered
The type of delivery confirmation that is required for this shipment.
Reference to the various downloadable file formats for the generated label
The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.
The paperless details which may contain elements like href, instructions and handoff_code.
The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.
The label's package(s).
Note: Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.
Additional information some carriers may provide by which to identify a given label in their system.
The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.
An array of pickup windows provided by the carrier during label creation. Contains time ranges when the carrier will pick up the package. This is particularly useful when the carrier does not support the Schedule Pickup method but still provides pickup date information during label purchase.
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
Indicates how a label was voided. refund_assist means the label was voided through the Refund Assist program, while manual means it was voided manually by the user.
Information about the Refund Assist request for this label. This field is null if the label is not eligible for Refund Assist.
{ "label_id": "se-28529731", "status": "processing", "shipment_id": "se-28529731", "external_shipment_id": "string", "external_order_id": "string", "ship_date": "2018-09-23T00:00:00.000Z", "created_at": "2018-09-23T15:00:00.000Z", "shipment_cost": { "currency": "string", "amount": 0 }, "insurance_cost": { "currency": "string", "amount": 0 }, "requested_comparison_amount": { "currency": "string", "amount": 0 }, "rate_details": [ { … } ], "tracking_number": "782758401696", "is_return_label": true, "rma_number": "string", "is_international": true, "batch_id": "se-28529731", "carrier_id": "se-28529731", "charge_event": "carrier_default", "service_code": "usps_first_class_mail", "package_code": "small_flat_rate_box", "voided": true, "voided_at": "2018-09-23T15:00:00.000Z", "label_format": "pdf", "display_scheme": "label", "label_layout": "4x6", "trackable": true, "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK", "carrier_code": "dhl_express", "tracking_status": "unknown", "confirmation": "none", "label_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "pdf": "http://api.shipengine.com/v1/labels/se-28529731", "png": "http://api.shipengine.com/v1/labels/se-28529731", "zpl": "http://api.shipengine.com/v1/labels/se-28529731" }, "form_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "qr_code_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "paperless_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "instructions": null, "handoff_code": null }, "insurance_claim": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "packages": [ { … } ], "alternative_identifiers": [ { … } ], "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", "pickup_windows": [ { … } ], "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", "address_residential_indicator": "no", "instructions": "string", "geolocation": [ … ] }, "void_type": "manual", "refund_details": { "refund_status": "request_scheduled", "request_date": "2018-09-23T15:00:00.000Z", "amount_paid": { … }, "amount_requested": { … }, "amount_approved": { … }, "amount_credited": { … } }, "total_cost": { "currency": "string", "amount": 0 }, "associated_labels": [ { … } ] }
The shipments to create mail labels for. All shipments must use the same carrier_id.
The carrier account that is billed for the shipping charges
A carrier service, such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
Describe the packages included in this shipment as related to potential metadata that was imported from external order sources
A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.
Warning: The
external_shipment_idis limited to 50 characters. Any additional characters will be truncated.
A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment.
Warning: The
shipment_numberis limited to 50 characters. Any additional characters will be truncated.
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.
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
Email for the address owner.
If this is a business address, then the company name should be specified here.
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
The second line of the street address. For some addresses, this line may not be needed.
The third line of the street address. For some addresses, this line may not be needed.
The name of the city or locality
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
postal code
A two-letter ISO 3166-1 country code
Indicates whether this is a residential address.
Additional text about how to handle the shipment at this address.
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
The warehouse that the shipment is being shipped from. Either warehouse_id or ship_from must be specified.
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.
The type of delivery confirmation that is required for this shipment.
Customs information. This is usually only needed for international shipments.
Advanced shipment options. These are entirely optional.
The insurance provider to use for any insured packages in the shipment.
The order sources that are supported by ShipEngine
The packages in the shipment.
Note: Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.
A string that uniquely identifies this package type
A package type, such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
The package weight
The insured value of the package. Requires the insurance_provider field of the shipment to be set.
Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier.
| Carrier | Max lines | Max line length |
|---|---|---|
| USPS (Stamps.com) | 3 | 60 |
| FedEx | 3 | 35 for the first line. 30 for additional lines. |
| UPS | 2 | 35 |
| OnTrac | 2 | 25 |
A short description of the package content. Required for shipments moving to, from, and through Mexico.
Layout options for printing mail labels on a single sheet. Controls the starting position on the label sheet.
The mail label layout to use.
The display format that the label should be shown in.
Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.
There are two different ways to download a label:
| Label Download Type | Description |
|---|---|
url | You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days. |
inline | You will receive the Base64-encoded label as part of the response. No need for a second request to download the label. |
An optional Return Merchandise Authorization number for return labels.
The label charge event.
The label_id of the original label that the return label is for.
The possible validate address values
The label image resource that was used to create a custom label image.
A unique identifier for a carrier service point where the shipment will be delivered.
curl -i -X POST \
https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/mailing/mail_labels \
-H 'API-Key: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"shipments": [
{
"carrier_id": "se-28529731",
"service_code": "usps_first_class_mail",
"external_order_id": "string",
"items": [],
"tax_identifiers": [
{
"taxable_entity_type": "shipper",
"identifier_type": "vat",
"issuing_authority": "string",
"value": "string"
}
],
"external_shipment_id": "string",
"shipment_number": "string",
"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",
"address_residential_indicator": "no",
"instructions": "string",
"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",
"address_residential_indicator": "no",
"instructions": "string"
},
"warehouse_id": null,
"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",
"address_residential_indicator": "no",
"instructions": "string"
},
"is_return": false,
"confirmation": "none",
"customs": null,
"advanced_options": {
"bill_to_account": null,
"bill_to_country_code": null,
"bill_to_party": null,
"bill_to_postal_code": null,
"contains_alcohol": false,
"delivered_duty_paid": false,
"dry_ice": false,
"dry_ice_weight": {
"value": 0,
"unit": "pound"
},
"non_machinable": false,
"saturday_delivery": false,
"fedex_freight": {
"shipper_load_and_count": "string",
"booking_confirmation": "string"
},
"use_ups_ground_freight_pricing": null,
"freight_class": "77.5",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"origin_type": null,
"additional_handling": null,
"shipper_release": null,
"collect_on_delivery": {
"payment_type": "any",
"payment_amount": {
"currency": "string",
"amount": 0
}
},
"third_party_consignee": false,
"dangerous_goods": false,
"dangerous_goods_contact": {
"name": "string",
"phone": "string"
},
"windsor_framework_details": {
"movement_indicator": "c2c",
"not_at_risk": true
},
"license_number": "514785",
"invoice_number": "IOC56888",
"certificate_number": "784515",
"fragile": true,
"delivery_as_addressed": true,
"return_after_first_attempt": true,
"regulated_content_type": null,
"netstamps_options": {
"row": 1,
"column": 1
}
},
"insurance_provider": "none",
"order_source_code": "amazon_ca",
"packages": [
{
"package_id": "se-28529731",
"package_code": "small_flat_rate_box",
"package_name": "string",
"weight": {
"value": 0,
"unit": "pound"
},
"dimensions": {
"unit": "inch",
"length": 0,
"width": 0,
"height": 0
},
"insured_value": {
"currency": "USD",
"amount": 0
},
"label_messages": {
"reference1": null,
"reference2": null,
"reference3": null
},
"external_package_id": "string",
"content_description": "Hand knitted wool socks",
"products": []
}
],
"comparison_rate_type": "retail"
}
],
"mailing_options": {
"start_row": 0,
"start_column": 0
},
"label_layout": "mail_label_sdc3110",
"label_format": "pdf",
"display_scheme": "label",
"test_label": true,
"label_download_type": "url",
"is_return_label": true,
"rma_number": "asd12323",
"charge_event": "carrier_default",
"outbound_label_id": "se-28529731",
"validate_address": "no_validation",
"label_image_id": "img_DtBXupDBxREpHnwEXhTfgK",
"ship_to_service_point_id": "614940",
"ship_from_service_point_id": "614940"
}'The labels were created successfully.
A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.
The possible statuses that a shipping label can be in.
| Status | Description |
|---|---|
processing | When 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. |
completed | The label was successfully created |
error | The label could not be created due to an error, such as an invalid delivery address |
voided | The label has been voided |
The shipment that this label is for. ShipEngine can create a shipment for you automatically when you create a label, or you can create your own shipment and then use it to print a label
A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.
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.
An ISO 8601 string that represents a date and time.
The cost of shipping, delivery confirmation, and other carrier charges. This amount does not include insurance costs.
The insurance cost for this package. Add this to the shipment_cost field to get the total cost.
The total shipping cost for the specified comparison_rate_type.
A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user.
The tracking number for the package. Tracking number formats vary across carriers.
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Indicates whether this is an international shipment. That is, the originating country and destination country are different.
If this label was created as part of a batch, then this is the unique ID of that batch.
The unique ID of the carrier account that was used to create this label
The label charge event.
A carrier service, such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
A package type, such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
An ISO 8601 string that represents a date and time.
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 Format | Supported Carriers |
|---|---|
pdf | All carriers |
png | fedex stamps_com ups usps |
zpl | access_worldwide apc asendia dhl_global_mail dhl_express dhl_express_australia dhl_express_canada dhl_express_worldwide dhl_express_uk dpd endicia fedex fedex_uk firstmile imex newgistics ontrac rr_donnelley stamps_com ups usps |
The display format that the label should be shown in.
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.
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.
The label image resource that was used to create a custom label image.
A shipping carrier, such as fedex, dhl_express, stamps_com, etc.
The current status of the package, such as in_transit or delivered
The type of delivery confirmation that is required for this shipment.
Reference to the various downloadable file formats for the generated label
The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.
The paperless details which may contain elements like href, instructions and handoff_code.
The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.
The label's package(s).
Note: Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.
Additional information some carriers may provide by which to identify a given label in their system.
The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.
An array of pickup windows provided by the carrier during label creation. Contains time ranges when the carrier will pick up the package. This is particularly useful when the carrier does not support the Schedule Pickup method but still provides pickup date information during label purchase.
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
Indicates how a label was voided. refund_assist means the label was voided through the Refund Assist program, while manual means it was voided manually by the user.
Information about the Refund Assist request for this label. This field is null if the label is not eligible for Refund Assist.
{ "label_id": "se-28529731", "status": "processing", "shipment_id": "se-28529731", "external_shipment_id": "string", "external_order_id": "string", "ship_date": "2018-09-23T00:00:00.000Z", "created_at": "2018-09-23T15:00:00.000Z", "shipment_cost": { "currency": "string", "amount": 0 }, "insurance_cost": { "currency": "string", "amount": 0 }, "requested_comparison_amount": { "currency": "string", "amount": 0 }, "rate_details": [ { … } ], "tracking_number": "782758401696", "is_return_label": true, "rma_number": "string", "is_international": true, "batch_id": "se-28529731", "carrier_id": "se-28529731", "charge_event": "carrier_default", "service_code": "usps_first_class_mail", "package_code": "small_flat_rate_box", "voided": true, "voided_at": "2018-09-23T15:00:00.000Z", "label_format": "pdf", "display_scheme": "label", "label_layout": "4x6", "trackable": true, "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK", "carrier_code": "dhl_express", "tracking_status": "unknown", "confirmation": "none", "label_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "pdf": "http://api.shipengine.com/v1/labels/se-28529731", "png": "http://api.shipengine.com/v1/labels/se-28529731", "zpl": "http://api.shipengine.com/v1/labels/se-28529731" }, "form_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "qr_code_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "paperless_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "instructions": null, "handoff_code": null }, "insurance_claim": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "packages": [ { … } ], "alternative_identifiers": [ { … } ], "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", "pickup_windows": [ { … } ], "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", "address_residential_indicator": "no", "instructions": "string", "geolocation": [ … ] }, "void_type": "manual", "refund_details": { "refund_status": "request_scheduled", "request_date": "2018-09-23T15:00:00.000Z", "amount_paid": { … }, "amount_requested": { … }, "amount_approved": { … }, "amount_credited": { … } }, "total_cost": { "currency": "string", "amount": 0 }, "associated_labels": [ { … } ] }
The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.
Note: Either
ship_fromorwarehouse_idmust be set.
The carrier account that is billed for the shipping charges
A carrier service, such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
Describe the packages included in this shipment as related to potential metadata that was imported from external order sources
A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.
Warning: The
external_shipment_idis limited to 50 characters. Any additional characters will be truncated.
A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment.
Warning: The
shipment_numberis limited to 50 characters. Any additional characters will be truncated.
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.
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
If this is a business address, then the company name should be specified here.
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
The second line of the street address. For some addresses, this line may not be needed.
The third line of the street address. For some addresses, this line may not be needed.
The name of the city or locality
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
A two-letter ISO 3166-1 country code
Indicates whether this is a residential address.
Additional text about how to handle the shipment at this address.
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
The warehouse that the shipment is being shipped from. Either warehouse_id or ship_from must be specified.
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.
The type of delivery confirmation that is required for this shipment.
Customs information. This is usually only needed for international shipments.
Advanced shipment options. These are entirely optional.
The insurance provider to use for any insured packages in the shipment.
The order sources that are supported by ShipEngine
The packages in the shipment.
Note: Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.
A string that uniquely identifies this package type
A package type, such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
The package weight
The insured value of the package. Requires the insurance_provider field of the shipment to be set.
Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier.
| Carrier | Max lines | Max line length |
|---|---|---|
| USPS (Stamps.com) | 3 | 60 |
| FedEx | 3 | 35 for the first line. 30 for additional lines. |
| UPS | 2 | 35 |
| OnTrac | 2 | 25 |
A short description of the package content. Required for shipments moving to, from, and through Mexico.
The envelope layout to use.
The display format that the label should be shown in.
Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.
There are two different ways to download a label:
| Label Download Type | Description |
|---|---|
url | You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days. |
inline | You will receive the Base64-encoded label as part of the response. No need for a second request to download the label. |
An optional Return Merchandise Authorization number for return labels.
The label charge event.
The label_id of the original label that the return label is for.
The possible validate address values
The label image resource that was used to create a custom label image.
A unique identifier for a carrier service point where the shipment will be delivered.
curl -i -X POST \
https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/mailing/envelopes \
-H 'API-Key: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"shipment": {
"carrier_id": "se-28529731",
"service_code": "usps_first_class_mail",
"external_order_id": "string",
"items": [],
"tax_identifiers": [
{
"taxable_entity_type": "shipper",
"identifier_type": "vat",
"issuing_authority": "string",
"value": "string"
}
],
"external_shipment_id": "string",
"shipment_number": "string",
"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",
"address_residential_indicator": "no",
"instructions": "string",
"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",
"address_residential_indicator": "no",
"instructions": "string"
},
"warehouse_id": null,
"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",
"address_residential_indicator": "no",
"instructions": "string"
},
"is_return": false,
"confirmation": "none",
"customs": null,
"advanced_options": {
"bill_to_account": null,
"bill_to_country_code": null,
"bill_to_party": null,
"bill_to_postal_code": null,
"contains_alcohol": false,
"delivered_duty_paid": false,
"dry_ice": false,
"dry_ice_weight": {
"value": 0,
"unit": "pound"
},
"non_machinable": false,
"saturday_delivery": false,
"fedex_freight": {
"shipper_load_and_count": "string",
"booking_confirmation": "string"
},
"use_ups_ground_freight_pricing": null,
"freight_class": "77.5",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"origin_type": null,
"additional_handling": null,
"shipper_release": null,
"collect_on_delivery": {
"payment_type": "any",
"payment_amount": {
"currency": "string",
"amount": 0
}
},
"third_party_consignee": false,
"dangerous_goods": false,
"dangerous_goods_contact": {
"name": "string",
"phone": "string"
},
"windsor_framework_details": {
"movement_indicator": "c2c",
"not_at_risk": true
},
"license_number": "514785",
"invoice_number": "IOC56888",
"certificate_number": "784515",
"fragile": true,
"delivery_as_addressed": true,
"return_after_first_attempt": true,
"regulated_content_type": null,
"netstamps_options": {
"row": 1,
"column": 1
}
},
"insurance_provider": "none",
"order_source_code": "amazon_ca",
"packages": [
{
"package_id": "se-28529731",
"package_code": "small_flat_rate_box",
"package_name": "string",
"weight": {
"value": 0,
"unit": "pound"
},
"dimensions": {
"unit": "inch",
"length": 0,
"width": 0,
"height": 0
},
"insured_value": {
"currency": "USD",
"amount": 0
},
"label_messages": {
"reference1": null,
"reference2": null,
"reference3": null
},
"external_package_id": "string",
"content_description": "Hand knitted wool socks",
"products": []
}
],
"comparison_rate_type": "retail"
},
"label_layout": "envelope_9",
"label_format": "pdf",
"display_scheme": "label",
"test_label": true,
"label_download_type": "url",
"is_return_label": true,
"rma_number": "asd12323",
"charge_event": "carrier_default",
"outbound_label_id": "se-28529731",
"validate_address": "no_validation",
"label_image_id": "img_DtBXupDBxREpHnwEXhTfgK",
"ship_to_service_point_id": "614940",
"ship_from_service_point_id": "614940"
}'The label was created successfully.
A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.
The possible statuses that a shipping label can be in.
| Status | Description |
|---|---|
processing | When 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. |
completed | The label was successfully created |
error | The label could not be created due to an error, such as an invalid delivery address |
voided | The label has been voided |
The shipment that this label is for. ShipEngine can create a shipment for you automatically when you create a label, or you can create your own shipment and then use it to print a label
A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.
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.
An ISO 8601 string that represents a date and time.
The cost of shipping, delivery confirmation, and other carrier charges. This amount does not include insurance costs.
The insurance cost for this package. Add this to the shipment_cost field to get the total cost.
The total shipping cost for the specified comparison_rate_type.
A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user.
The tracking number for the package. Tracking number formats vary across carriers.
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Indicates whether this is an international shipment. That is, the originating country and destination country are different.
If this label was created as part of a batch, then this is the unique ID of that batch.
The unique ID of the carrier account that was used to create this label
The label charge event.
A carrier service, such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
A package type, such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
An ISO 8601 string that represents a date and time.
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 Format | Supported Carriers |
|---|---|
pdf | All carriers |
png | fedex stamps_com ups usps |
zpl | access_worldwide apc asendia dhl_global_mail dhl_express dhl_express_australia dhl_express_canada dhl_express_worldwide dhl_express_uk dpd endicia fedex fedex_uk firstmile imex newgistics ontrac rr_donnelley stamps_com ups usps |
The display format that the label should be shown in.
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.
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.
The label image resource that was used to create a custom label image.
A shipping carrier, such as fedex, dhl_express, stamps_com, etc.
The current status of the package, such as in_transit or delivered
The type of delivery confirmation that is required for this shipment.
Reference to the various downloadable file formats for the generated label
The URL of the linked resource, if any
The URL for the pdf generated label
The URL for the png generated label
The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.
The QR code download for the package
The paperless details which may contain elements like href, instructions and handoff_code.
The URL of the linked resource, if any
The instructions for the paperless download.
The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.
The label's package(s).
Note: Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.
A package type, such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
The package weight
The insured value of the package. Requires the insurance_provider field of the shipment to be set.
The tracking number for the package. The format depends on the carrier.
The form download for any customs that are needed
The paperless details which may contain elements like href, instructions and handoff_code.
Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier.
| Carrier | Max lines | Max line length |
|---|---|---|
| USPS (Stamps.com) | 3 | 60 |
| FedEx | 3 | 35 for the first line. 30 for additional lines. |
| UPS | 2 | 35 |
| OnTrac | 2 | 25 |
A short description of the package content. Required for shipments moving to, from, and through Mexico.
Whether the package has label documents available for download
Whether the package has QR code documents available for download
Whether the package has paperless documents available for download
Additional information some carriers may provide by which to identify a given label in their system.
The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.
An array of pickup windows provided by the carrier during label creation. Contains time ranges when the carrier will pick up the package. This is particularly useful when the carrier does not support the Schedule Pickup method but still provides pickup date information during label purchase.
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
If this is a business address, then the company name should be specified here.
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
The second line of the street address. For some addresses, this line may not be needed.
The third line of the street address. For some addresses, this line may not be needed.
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
A two-letter ISO 3166-1 country code
Indicates whether this is a residential address.
Additional text about how to handle the shipment at this address.
Indicates how a label was voided. refund_assist means the label was voided through the Refund Assist program, while manual means it was voided manually by the user.
{ "label_id": "se-28529731", "status": "processing", "shipment_id": "se-28529731", "external_shipment_id": "string", "external_order_id": "string", "ship_date": "2018-09-23T00:00:00.000Z", "created_at": "2018-09-23T15:00:00.000Z", "shipment_cost": { "currency": "string", "amount": 0 }, "insurance_cost": { "currency": "string", "amount": 0 }, "requested_comparison_amount": { "currency": "string", "amount": 0 }, "rate_details": [ { … } ], "tracking_number": "782758401696", "is_return_label": true, "rma_number": "string", "is_international": true, "batch_id": "se-28529731", "carrier_id": "se-28529731", "charge_event": "carrier_default", "service_code": "usps_first_class_mail", "package_code": "small_flat_rate_box", "voided": true, "voided_at": "2018-09-23T15:00:00.000Z", "label_format": "pdf", "display_scheme": "label", "label_layout": "4x6", "trackable": true, "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK", "carrier_code": "dhl_express", "tracking_status": "unknown", "confirmation": "none", "label_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "pdf": "http://api.shipengine.com/v1/labels/se-28529731", "png": "http://api.shipengine.com/v1/labels/se-28529731", "zpl": "http://api.shipengine.com/v1/labels/se-28529731" }, "form_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "qr_code_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "paperless_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "instructions": null, "handoff_code": null }, "insurance_claim": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "packages": [ { … } ], "alternative_identifiers": [ { … } ], "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", "pickup_windows": [ { … } ], "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", "address_residential_indicator": "no", "instructions": "string", "geolocation": [ … ] }, "void_type": "manual", "refund_details": { "refund_status": "request_scheduled", "request_date": "2018-09-23T15:00:00.000Z", "amount_paid": { … }, "amount_requested": { … }, "amount_approved": { … }, "amount_credited": { … } } }
Webhooks are a powerful feature of ShipEngine that can save you from sending repeated polling requests to check on the state of something. With webhooks, ShipEngine will automatically contact your servers when the state changes. This can include parcel tracking events, notification of the completion of a batch operation, or new sales orders.