SHshipstation
manifests

Get manifest request by ID

Changed on
<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan access__plan--off">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan access__plan--off">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>

Get Manifest Request By Id

get/v2/manifests/requests/{manifest_request_id}

Request

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": "https://example.com/resource"
      }
    }
  ],
  "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": "https://example.com/resource"
  },
  "label_ids": [
    "se-28529731"
  ],
  "request_id": "aa3d8e8e-462b-4476-9618-72db7f7b7009",
  "errors": [
    {
      "message": "Body of request cannot be null.",
      "label_id": "se-28529731"
    }
  ]
}

Changes

  • ded10df771dbRevision changes
    • warning

      added the new funding_source_missing_configuration enum value to the /// response property for the response status

    • warning

      added the new funding_source_missing_configuration enum value to the // response property for the response status

    • warning

      added the new funding_source_missing_configuration enum value to the // response property for the response status

    • warning

      added the new funding_sources enum value to the /// response property for the response status

    • warning

      added the new funding_sources enum value to the // response property for the response status

    • warning

      added the new funding_sources enum value to the // response property for the response status

  • 4e29670aa28dRevision changes
    • warning

      added the new bring_your_own_label_not_supported enum value to the /// response property for the response status

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the /// response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the /// response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status