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.
Warehouse ID
ship date start range
Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)
Carrier ID
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.
curl -i -X GET \
'https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/manifests?warehouse_id=se-28529731&ship_date_start=2018-09-23T15%3A00%3A00.000Z&ship_date_end=2018-09-23T15%3A00%3A00.000Z&created_at_start=2019-03-12T19%3A24%3A13.657Z&created_at_end=2019-03-12T19%3A24%3A13.657Z&carrier_id=se-28529731&page=2&page_size=50&label_ids=se-28529731' \
-H 'API-Key: YOUR_API_KEY_HERE'The request was a success.
The list of available manifests
A string that uniquely identifies the manifest
A string that uniquely identifies the form
The date-time that the manifest was created
The date-time that the manifests shipments will be picked up
The number of shipments that are included in this manifest
A string that uniquely identifies the warehouse
A string that uniquely identifies the submission
A string that uniquely identifies the carrier
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.
{ "manifests": [], "total": 3, "page": 3, "pages": 4, "links": { "first": { … }, "last": { … }, "prev": { … }, "next": { … } } }
A create manifest request body
A string that uniquely identifies the carrier
A string that uniquely identifies the warehouse
curl -i -X POST \
https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/manifests \
-H 'API-Key: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"carrier_id": "se-28529731",
"excluded_label_ids": [
"se-28529731"
],
"label_ids": [
"se-28529731"
],
"warehouse_id": "se-28529731",
"ship_date": "2018-09-23T15:00:00.000Z"
}'The request was a success.
A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur
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.
A string that uniquely identifies the manifest
A string that uniquely identifies the form
The date-time that the manifest was created
The date-time that the manifests shipments will be picked up
The number of shipments that are included in this manifest
A string that uniquely identifies the warehouse
A string that uniquely identifies the submission
A string that uniquely identifies the carrier
Object containing the href link to download the manifest file
{ "manifests": [ { … } ], "manifest_requests": [ { … } ], "manifest_id": "se-28529731", "form_id": "se-28529731", "created_at": "2019-07-12T13:37:39.050Z", "ship_date": "2019-07-12T13:37:39.050Z", "shipments": 100, "warehouse_id": "se-28529731", "submission_id": "9475711899564878915476", "carrier_id": "se-28529731", "manifest_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731" }, "label_ids": [ "se-28529731" ], "request_id": "aa3d8e8e-462b-4476-9618-72db7f7b7009", "errors": [ { … } ] }
curl -i -X GET \
https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/manifests/se-28529731 \
-H 'API-Key: YOUR_API_KEY_HERE'The request was a success.
A string that uniquely identifies the manifest
A string that uniquely identifies the form
The date-time that the manifest was created
The date-time that the manifests shipments will be picked up
The number of shipments that are included in this manifest
A string that uniquely identifies the warehouse
A string that uniquely identifies the submission
A string that uniquely identifies the carrier
{ "manifest_id": "se-28529731", "form_id": "se-28529731", "created_at": "2019-07-12T13:37:39.050Z", "ship_date": "2019-07-12T13:37:39.050Z", "shipments": 100, "label_ids": [ "se-28529731" ], "warehouse_id": "se-28529731", "submission_id": "9475711899564878915476", "carrier_id": "se-28529731", "manifest_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731" } }
curl -i -X GET \
https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/manifests/requests/se-28529731 \
-H 'API-Key: YOUR_API_KEY_HERE'The request was a success.
A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur
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.
A string that uniquely identifies the manifest
A string that uniquely identifies the form
The date-time that the manifest was created
The date-time that the manifests shipments will be picked up
The number of shipments that are included in this manifest
A string that uniquely identifies the warehouse
A string that uniquely identifies the submission
A string that uniquely identifies the carrier
Object containing the href link to download the manifest file
{ "manifests": [ { … } ], "manifest_requests": [ { … } ], "manifest_id": "se-28529731", "form_id": "se-28529731", "created_at": "2019-07-12T13:37:39.050Z", "ship_date": "2019-07-12T13:37:39.050Z", "shipments": 100, "warehouse_id": "se-28529731", "submission_id": "9475711899564878915476", "carrier_id": "se-28529731", "manifest_download": { "href": "http://api.shipengine.com/v1/labels/se-28529731" }, "label_ids": [ "se-28529731" ], "request_id": "aa3d8e8e-462b-4476-9618-72db7f7b7009", "errors": [ { … } ] }
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.