Process labels in bulk and receive a large number of labels and customs forms in bulk responses. Batching is ideal for workflows that need to process hundreds or thousands of labels quickly.
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/openapi/v2/manifests?carrier_id=se-28529731&created_at_end=2019-08-24T14%3A15%3A22Z&created_at_start=2019-08-24T14%3A15%3A22Z&label_ids=se-28529731&page=1&page_size=25&ship_date_end=2019-08-24T14%3A15%3A22Z&ship_date_start=2019-08-24T14%3A15%3A22Z&warehouse_id=se-28529731' \ -H 'api-key: YOUR_API_KEY_HERE'
The request was a success.
The list of available manifests
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
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
An array of the label ids used in this manifest.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A string that uniquely identifies the submission
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
Helpful links to other pages of results
A link to a related resource, or an empty object if there is no resource to link to
A link to a related resource, or an empty object if there is no resource to link to
A link to a related resource, or an empty object if there is no resource to link to
A link to a related resource, or an empty object if there is no resource to link to
{ "manifests": [], "total": 3, "page": 3, "pages": 4, "links": { "first": { … }, "last": { … }, "prev": { … }, "next": { … } } }
A create manifest request body
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
The list of label ids to exclude from the manifest
The list of label ids to include for the manifest
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
curl -i -X POST \ https://docs.shipstation.com/_mock/openapi/v2/manifests \ -H 'Content-Type: application/json' \ -H 'api-key: YOUR_API_KEY_HERE' \ -d '{ "carrier_id": "se-1234567", "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 string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
The possible statuses of a manifest request
A UUID (a.k.a. GUID) that uniquely identifies a resource
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 ShipStation 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 a ShipStation resource, such as a carrier, label, shipment, etc.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
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 a ShipStation resource, such as a carrier, label, shipment, etc.
A string that uniquely identifies the submission
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
Object containing the href link to download the manifest file
{ "manifests": [ { … } ], "manifest_request_id": "se-28529731", "status": "in_progress", "manifest_id": "se-28529731", "form_id": "se-28529731", "created_at": "2019-07-12T13:37:39.05Z", "ship_date": "2019-07-12T13:37:39.05Z", "shipments": 100, "warehouse_id": "se-28529731", "submission_id": "9475711899564878915476", "carrier_id": "se-1234567", "manifest_download": { "href": "http://api.shipstation.com/v2/labels/se-28529731" }, "label_ids": [ "se-28529731" ], "request_id": "aa3d8e8e-462b-4476-9618-72db7f7b7009", "errors": [ { … } ] }
curl -i -X GET \ 'https://docs.shipstation.com/_mock/openapi/v2/manifests/{manifest_id}' \ -H 'api-key: YOUR_API_KEY_HERE'
The request was a success.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
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
An array of the label ids used in this manifest.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A string that uniquely identifies the submission
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
{ "manifest_id": "se-28529731", "form_id": "se-28529731", "created_at": "2019-07-12T13:37:39.05Z", "ship_date": "2019-07-12T13:37:39.05Z", "shipments": 100, "label_ids": [ "se-28529731" ], "warehouse_id": "se-28529731", "submission_id": "9475711899564878915476", "carrier_id": "se-1234567", "manifest_download": { "href": "http://api.shipstation.com/v2/labels/se-28529731" } }
Webhooks are a powerful feature that can save you from sending repeated polling requests to check on the state of something. With webhooks, ShipStation will automatically contact your servers when the stage changes. This can include parcel tracking events, notification when a batch operation completes, and more.