manifests

Create manifest

Each ShipStation manifest is created for a specific warehouse, so you'll need to provide the warehouse_id rather than the ship_from address. You can create a warehouse for each location that you want to create manifests for.

post/v2/manifests

Request

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

Request body

OR

Example request

{
  "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"
}

Response

The request was a success.

manifest_request_idstring

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

status'in_progress' | 'completed'

The possible statuses of a manifest request

manifest_idstring required

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

form_idstring required

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

created_atstring date-time required

The date-time that the manifest was created

ship_datestring date-time required

The date-time that the manifests shipments will be picked up

shipmentsinteger required

The number of shipments that are included in this manifest

warehouse_idstring required

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

submission_idstring required

A string that uniquely identifies the submission

carrier_idstring required

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

label_idsSeId[]

An array of the label ids used in this manifest.

request_idstring uuid required

A UUID (a.k.a. GUID) that uniquely identifies a resource

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"
      }
    }
  ],
  "manifest_request_id": "se-28529731",
  "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-28529731",
  "manifest_download": {
    "href": "http://api.shipstation.com/v2/labels/se-28529731"
  },
  "label_ids": [
    "se-28529731"
  ],
  "request_id": "aa3d8e8e-462b-4476-9618-72db7f7b7009",
  "errors": [
    {
      "message": "Body of request cannot be null.",
      "label_id": "se-28529731"
    }
  ]
}

Changes

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