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 possible batch status values
Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
The number of results to return per response.
Only return batches that were created on or after a specific date/time
Only return batches that were created on or before a specific date/time
Only return batches that were processed on or after a specific date/time
Only return batches that were processed on or before a specific date/time
curl -i -X GET \
'https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/batches?status=open&page=2&page_size=50&sort_dir=desc&batch_number=string&created_at_start=2019-03-12T19%3A24%3A13.657Z&created_at_end=2019-03-12T19%3A24%3A13.657Z&processed_at_start=2019-03-12T19%3A24%3A13.657Z&processed_at_end=2019-03-12T19%3A24%3A13.657Z&sort_by=ship_date' \
-H 'API-Key: YOUR_API_KEY_HERE'The request was a success.
Batch List
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.
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 |
A string that uniquely identifies the batch
A string that uniquely identifies the external batch
Custom notes you can add for each created batch
An ISO 8601 string that represents a date and time.
An ISO 8601 string that represents a date and time.
The number of errors that occurred while generating the batch
The errors associated with the failed API call
The source of the error, as indicated by the name this informs us if the API call failed because of the carrier, the order source, or the ShipEngine API itself.
The type of error
The error code specified for the failed API Call
An error message associated with the failed API call
A string that uniquely identifies the carrier that generated the error.
A shipping carrier, such as fedex, dhl_express, stamps_com, etc.
The number of warnings that occurred while generating the batch
The number of labels generated in the batch
The number of forms for customs that are available for download
The total of errors, warnings, and completed properties
The batch shipments endpoint
Link to batch labels query
Link to batch errors endpoint
The label download for the batch
The URL of the linked resource, if any
The URL for the pdf generated label
The URL for the png generated label
The form download for any customs that are needed
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 total number of batches the API call returned
The total number of batch pages the API call returned
Helpful links to other pages of results
The link to the first page of results. This object will always have an href field. If there are no results, then the first page will contain an empty array of items.
The link to the final page of results. This object will always have an href field. If there are no results, then the final page will contain an empty array of items.
The link to the previous page of results. The href field will only be set when the page is 2 or greater.
The link to the next page of results. The href field will only be set when the page is less than pages.
{ "batches": [ { … } ], "total": 10, "page": 1, "pages": 10, "links": { "first": { … }, "last": { … }, "prev": { … }, "next": { … } } }
A create batch request body
A string that uniquely identifies the external batch
curl -i -X POST \
https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/batches \
-H 'API-Key: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"external_batch_id": "se-28529731",
"batch_notes": "This is my batch",
"shipment_ids": [
"se-28529731"
],
"rate_ids": [
"se-28529731"
]
}'The requested object creation was a success.
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.
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 |
A string that uniquely identifies the batch
A string that uniquely identifies the external batch
Custom notes you can add for each created batch
An ISO 8601 string that represents a date and time.
An ISO 8601 string that represents a date and time.
The number of errors that occurred while generating the batch
The errors associated with the failed API call
The source of the error, as indicated by the name this informs us if the API call failed because of the carrier, the order source, or the ShipEngine API itself.
The type of error
The error code specified for the failed API Call
An error message associated with the failed API call
A string that uniquely identifies the carrier that generated the error.
A shipping carrier, such as fedex, dhl_express, stamps_com, etc.
The number of warnings that occurred while generating the batch
The number of forms for customs that are available for download
The total of errors, warnings, and completed properties
The batch shipments endpoint
Link to batch labels query
Link to batch errors endpoint
The label download for the batch
The URL of the linked resource, if any
The URL for the pdf generated label
The URL for the png generated label
The form download for any customs that are needed
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.
{ "label_layout": "4x6", "label_format": "pdf", "batch_id": "se-28529731", "batch_number": "string", "external_batch_id": "string", "batch_notes": "Batch for morning shipment", "created_at": "2018-09-23T15:00:00.000Z", "processed_at": "string", "errors": 2, "process_errors": [ { … } ], "warnings": 1, "completed": 1, "forms": 3, "count": 2, "batch_shipments_url": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "batch_labels_url": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "batch_errors_url": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "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" }, "paperless_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "instructions": null, "handoff_code": null }, "status": "open" }
curl -i -X GET \
https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/batches/external_batch_id/13553d7f-3c87-4771-bae1-c49bacef11cb \
-H 'API-Key: YOUR_API_KEY_HERE'The request was a success.
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.
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 |
A string that uniquely identifies the batch
A string that uniquely identifies the external batch
Custom notes you can add for each created batch
An ISO 8601 string that represents a date and time.
An ISO 8601 string that represents a date and time.
The number of errors that occurred while generating the batch
The errors associated with the failed API call
The source of the error, as indicated by the name this informs us if the API call failed because of the carrier, the order source, or the ShipEngine API itself.
The type of error
The error code specified for the failed API Call
An error message associated with the failed API call
A string that uniquely identifies the carrier that generated the error.
A shipping carrier, such as fedex, dhl_express, stamps_com, etc.
The number of warnings that occurred while generating the batch
The number of forms for customs that are available for download
The total of errors, warnings, and completed properties
The batch shipments endpoint
Link to batch labels query
Link to batch errors endpoint
The label download for the batch
The URL of the linked resource, if any
The URL for the pdf generated label
The URL for the png generated label
The form download for any customs that are needed
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.
{ "label_layout": "4x6", "label_format": "pdf", "batch_id": "se-28529731", "batch_number": "string", "external_batch_id": "string", "batch_notes": "Batch for morning shipment", "created_at": "2018-09-23T15:00:00.000Z", "processed_at": "string", "errors": 2, "process_errors": [ { … } ], "warnings": 1, "completed": 1, "forms": 3, "count": 2, "batch_shipments_url": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "batch_labels_url": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "batch_errors_url": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "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" }, "paperless_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "instructions": null, "handoff_code": null }, "status": "open" }
curl -i -X DELETE \
https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/batches/se-28529731 \
-H 'API-Key: YOUR_API_KEY_HERE'No response examplecurl -i -X GET \
https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/batches/se-28529731 \
-H 'API-Key: YOUR_API_KEY_HERE'The request was a success.
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.
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 |
A string that uniquely identifies the batch
A string that uniquely identifies the external batch
Custom notes you can add for each created batch
An ISO 8601 string that represents a date and time.
An ISO 8601 string that represents a date and time.
The number of errors that occurred while generating the batch
The errors associated with the failed API call
The source of the error, as indicated by the name this informs us if the API call failed because of the carrier, the order source, or the ShipEngine API itself.
The type of error
The error code specified for the failed API Call
An error message associated with the failed API call
A string that uniquely identifies the carrier that generated the error.
A shipping carrier, such as fedex, dhl_express, stamps_com, etc.
The number of warnings that occurred while generating the batch
The number of forms for customs that are available for download
The total of errors, warnings, and completed properties
The batch shipments endpoint
Link to batch labels query
Link to batch errors endpoint
The label download for the batch
The URL of the linked resource, if any
The URL for the pdf generated label
The URL for the png generated label
The form download for any customs that are needed
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.
{ "label_layout": "4x6", "label_format": "pdf", "batch_id": "se-28529731", "batch_number": "string", "external_batch_id": "string", "batch_notes": "Batch for morning shipment", "created_at": "2018-09-23T15:00:00.000Z", "processed_at": "string", "errors": 2, "process_errors": [ { … } ], "warnings": 1, "completed": 1, "forms": 3, "count": 2, "batch_shipments_url": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "batch_labels_url": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "batch_errors_url": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "type": "string" }, "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" }, "paperless_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731", "instructions": null, "handoff_code": null }, "status": "open" }
curl -i -X PUT \
https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/batches/se-28529731 \
-H 'API-Key: YOUR_API_KEY_HERE'No response examplecurl -i -X POST \
https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/batches/se-28529731/add \
-H 'API-Key: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"shipment_ids": [
"se-28529731"
],
"rate_ids": [
"se-28529731"
]
}'No response exampleError handling in batches are handled differently than in a single synchronous request. You must retrieve the status of your batch by getting a batch and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors.
curl -i -X GET \
'https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/batches/se-28529731/errors?page=2&pagesize=1' \
-H 'API-Key: YOUR_API_KEY_HERE'The request was a success.
The errors currently associated with the batch
Error message associated with the shipment.
A string that uniquely identifies the shipment
Helpful links to other pages of results
The link to the first page of results. This object will always have an href field. If there are no results, then the first page will contain an empty array of items.
The link to the final page of results. This object will always have an href field. If there are no results, then the final page will contain an empty array of items.
The link to the previous page of results. The href field will only be set when the page is 2 or greater.
The link to the next page of results. The href field will only be set when the page is less than pages.
{ "errors": [], "links": { "first": { … }, "last": { … }, "prev": { … }, "next": { … } } }
An ISO 8601 string that represents a date and time.
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.
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 |
curl -i -X POST \
https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/batches/se-28529731/process/labels \
-H 'API-Key: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"ship_date": "2018-09-23T15:00:00.000Z",
"label_layout": "4x6",
"label_format": "pdf",
"display_scheme": "label"
}'No response examplecurl -i -X POST \
https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/batches/se-28529731/remove \
-H 'API-Key: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"shipment_ids": [
"se-28529731"
],
"rate_ids": [
"se-28529731"
]
}'No response exampleWebhooks 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.