Get Manifests
Once you've created manifests, there are two GET calls you can make to the /v2/manifests
endpoint to retrieve manifest details.
- List Manifests: Similar to getting a list of shipments, you can get a list of the manifests you've created. You can use query parameters so the response includes only the manifests that meet your criteria.
- Get Manifest by ID: To get the details of a specific manifest, like its creation date, ship date, the labels included, and more. The response will include the
href
property with the link to download the manifest.
List Manifests
When listing your manifests, you can use any of the following query parameters.
Query Parameter | Type | Description |
---|---|---|
warehouse_id | string | |
carrier_id | string | |
label_ids | string | |
ship_date_start | date string | ISO 8601 Standard 2024-07-25T15:24:46.657Z |
ship_date_end | date string | ISO 8601 Standard 2024-07-25T15:24:46.657Z |
create_date_start | date string | ISO 8601 Standard 2024-07-25T15:24:46.657Z |
create_date_end | date string | ISO 8601 Standard 2024-07-25T15:24:46.657Z |
Example Request
GET /v2/manifests
GET /v2/manifests?warehouse_id=11921&carrier_id=se-123890 HTTP/1.1 Host: api.shipstation.com API-Key: __YOUR_API_KEY_HERE__
The response will return the following details:
- Manifest array, which includes the following properties:
manifest_id
form_id
created_at
ship_date
shipments
label_ids
warehouse_id
submission_id
carrier_id
manifest_download
object (which includes the URL to download the manifest)
total
The total number of manifests returnedpage
Current page of the list manifests resultspages
Total number of pages for list manifests resultslinks
object - the links to other pages of results (first
,last
,prev
,next
)
Get Manifest by ID
You will need a manifest_id
for this request. You can run a List Manifests call to return a list of manifests generated for a carrier within the date range you specify.
Example Request
GET /v2/manifests/:manifest_id
GET /v2/manifests/se-28529731 HTTP/1.1 Host: api.shipstation.com API-Key: __YOUR_API_KEY_HERE__
Response
{ "manifest_id": "se-28529731", "form_id": "se-28529731", "created_at": "2024-07-12T13:37:39.050Z", "ship_date": "2024-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.shipstation.com/v2/labels/se-28529731" } }