---
title: "Hold a shipment"
method: PUT
path: "/v2/shipments/{shipment_id}/hold"
tags: ["shipments"]
---

# Hold a shipment

`PUT /v2/shipments/{shipment_id}/hold`

## Request

- Base URL: `https://api.shipstation.com`
- URL: `https://api.shipstation.com/v2/shipments/{shipment_id}/hold`
- Auth: API key in header `api-key`

<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">Standard</a>
              <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">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>

Holds a shipment until a given date. A shipment on hold has the `on_hold` status,
and you can't purchase a label for it while it's on hold. On the `hold_until_date`,
the shipment is released automatically and returns to the `pending` status. Holding
a shipment that is already on hold replaces the existing `hold_until_date`.

A cancelled shipment or a shipment with a purchased label cannot be held and returns
a `400` response.

`hold_until_date` is a date-only value: any time component you send is ignored, and
the date must be later than today.

To hold up to 500 shipments in one request, use [Hold shipments](#operation/hold_shipments).

## Request body

- HoldShipmentRequestBody: A request body for holding a shipment
  - `hold_until_date` string, date, required: The date to hold the shipment until. This is a date-only value — you can send a plain `YYYY-MM-DD` date, and any time component is ignored. The date must be later than today.

## Response `200`

The request was a success.

- HoldShipmentResponseBody: A response body for holding a shipment
  - `shipment_id` string: A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
  - `hold_until_date` string, date-time: The date the shipment is held until, returned at midnight

## Other responses

- `400`: The request contained errors.
- `404`: The specified resource does not exist.
- `500`: An error occurred on ShipStation API's side.

## Changes

- **2026-10-22** `4e29670aa28d`: 6 warning
  - added the new `bring_your_own_label_not_supported` enum value to the `errors/items/error_code` response property for the response status `400`
  - added the new `bring_your_own_label_not_supported` enum value to the `errors/items/error_code` response property for the response status `404`
  - added the new `multiple_sales_orders` enum value to the `errors/items/error_code` response property for the response status `400`
  - added the new `multiple_sales_orders` enum value to the `errors/items/error_code` response property for the response status `404`
  - …2 more
- **2026-10-09** `934f5935dbea`: 2 breaking, 14 info
  - the `errors/items/` response's property type changed from no type to `object` for status `400`
  - the `errors/items/` response's property type changed from no type to `object` for status `404`
  - added the optional property `errors/items/field_name` to the response with the `400` status
  - added the optional property `errors/items/field_name` to the response with the `404` status
  - …12 more
- **2026-10-02** `0cf052f808b4`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/shipstation/apis/shipstation-api-v2/changes/v2/shipments/:shipment_id/hold/put.md)

---

[API](https://skmtc.dev/shipstation/apis/shipstation-api-v2.md) - [All operations](https://skmtc.dev/shipstation/apis/shipstation-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/shipstation/apis/shipstation-api-v2/revisions/43d0f3c948ca?raw)