manifests

List manifests

Similar to querying shipments, we allow you to query manifests since there will likely be a large number over a long period of time.

get/v2/manifests

Request

  • Base URL: https://api.shipstation.com
  • URL: https://api.shipstation.com/v2/manifests
  • Auth: API key in header api-key

Query parameters

warehouse_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

Example:se-28529731

Warehouse ID

ship_date_startstring date-time

ship date start range

ship_date_endstring date-time

ship date end range

created_at_startstring date-time

Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)

created_at_endstring date-time

Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)

carrier_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

Example:se-28529731

Carrier ID

pageinteger

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.

page_sizeinteger

The number of results to return per response.

label_idsSeId[]

Array of label ids

[
  "se-28529731"
]

Response

The request was a success.

totalinteger required

The total number of manifests returned

pageinteger required

Current page of the list manifests results

pagesinteger required

Total number of pages for list manifests results

Example response

{
  "manifests": [
    {
      "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-28529731",
      "manifest_download": {
        "href": "http://api.shipstation.com/v2/labels/se-28529731"
      }
    }
  ],
  "total": 3,
  "page": 3,
  "pages": 4,
  "links": {
    "first": {
      "href": "http://api.shipstation.com/v2/labels/se-28529731",
      "type": "child"
    },
    "last": {
      "href": "http://api.shipstation.com/v2/labels/se-28529731",
      "type": "child"
    },
    "prev": {
      "href": "http://api.shipstation.com/v2/labels/se-28529731",
      "type": "child"
    },
    "next": {
      "href": "http://api.shipstation.com/v2/labels/se-28529731",
      "type": "child"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.