> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Release all active Holds on Lot

> Releases every active `stock_hold` row whose `lot_id` matches the path parameter, regardless
of reason. Useful for "lift quarantine on lot X" workflows.

**Cascaded lot release is not currently supported.** Sending `release_cascaded=true` returns
a 400 RequestNotValid. To free a cascaded hold tree, release each child via
`POST /v1/inventory/holds/{id}/release`.

For cascaded holds (placed via `holdLot` with `cascade_bom=true`), release per-id using
`origin.created_origin_hold_ids ∪ cascade.child_hold_ids` from the original `holdLot`
response.



## OpenAPI

````yaml POST /v1/inventory/holds/lot/{lot_id}/release
openapi: 3.0.3
info:
  title: ShipStream
  version: '1.0'
  license:
    name: Commercial (Copyright 2025 - All Rights Reserved)
    url: https://shipstream.io
  contact:
    name: ShipStream Support
    email: help@shipstream.io
  termsOfService: https://shipstream.io/legal/api-terms/
servers:
  - url: https://{base_url_domain}/api/global
    description: Direct API Url
    variables:
      base_url_domain:
        default: example.shipstream.app
        description: >-
          The fully qualified domain name for your ShipStream WMS instance. This
          is either a custom domain, or a subdomain of shipstream.app,

          and will be the same as the domain name for the page which you use to
          login to ShipStream WMS.
security:
  - ShipStream_bearerAuth: []
tags:
  - name: Warehouses
    x-displayName: Warehouses
  - name: Products
    x-displayName: Products
  - name: Locations
    x-displayName: Locations
  - name: Levels
    x-displayName: Levels
  - name: HoldReasons
    x-displayName: HoldReasons
  - name: Holds
    x-displayName: Holds
  - name: Deliveries
    description: Every thing about a Delivery Receiving
    x-displayName: Deliveries
  - name: Shipments
    x-displayName: Shipments
  - name: Orders
    x-displayName: Orders
  - name: Retailers
    x-displayName: Retailers
  - name: Users
    x-displayName: Users
  - name: User Roles
    x-displayName: User Roles
  - name: Merchants
    x-displayName: Merchants
  - name: Healthcheck
    x-displayName: Healthcheck
paths:
  /v1/inventory/holds/lot/{lot_id}/release:
    post:
      tags:
        - Holds
      summary: Release all active Holds on Lot
      description: >-
        Releases every active `stock_hold` row whose `lot_id` matches the path
        parameter, regardless

        of reason. Useful for "lift quarantine on lot X" workflows.


        **Cascaded lot release is not currently supported.** Sending
        `release_cascaded=true` returns

        a 400 RequestNotValid. To free a cascaded hold tree, release each child
        via

        `POST /v1/inventory/holds/{id}/release`.


        For cascaded holds (placed via `holdLot` with `cascade_bom=true`),
        release per-id using

        `origin.created_origin_hold_ids ∪ cascade.child_hold_ids` from the
        original `holdLot`

        response.
      operationId: releaseLot
      parameters:
        - name: lot_id
          in: path
          required: true
          schema:
            type: integer
            format: int64
          description: Lot whose holds to release.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                release_cascaded:
                  type: boolean
                  default: false
                  description: >
                    Only `false` is currently supported. Sending `true` returns
                    400 with a pointer

                    to the per-id release endpoint.
      responses:
        '200':
          description: Lot release outcome.
          content:
            application/json:
              schema:
                type: object
                properties:
                  lot_id:
                    type: integer
                    format: int64
                    description: Lot whose holds were targeted by this release call.
                  released_hold_ids:
                    type: array
                    description: >-
                      Hold IDs newly released by this call. Empty when the lot
                      had no active holds.
                    items:
                      type: integer
                      format: int64
                required:
                  - lot_id
                  - released_hold_ids
        '400':
          $ref: '#/components/responses/Inventory_API_v1_400-bad-request'
          description: >-
            Invalid request (e.g. release_cascaded=true is unsupported in this
            slice).
        '404':
          $ref: '#/components/responses/Inventory_API_v1_404-not-found'
        '500':
          $ref: '#/components/responses/Inventory_API_v1_500-internal-server-error'
components:
  responses:
    Inventory_API_v1_400-bad-request:
      description: >-
        The request was invalid. The client must change the request. See the
        response body for more details.
      content:
        application/json:
          schema:
            type: object
            properties:
              errors:
                type: array
                items:
                  type: object
                  properties:
                    type:
                      type: string
                      description: The error type code.
                      enum:
                        - parser
                        - parameters
                        - openapi
                    message:
                      type: string
                      description: An English sentence describing the error type.
                    details:
                      type: array
                      description: >-
                        An array of objects describing which keys are
                        responsible for the error and detailed messages
                        describing why they are not valid.
                      items:
                        type: object
                        properties:
                          key:
                            type: string
                            description: The path to the key which relates to the error.
                          message:
                            type: string
                            description: >-
                              An English sentence describing the details of the
                              error.
                        additionalProperties: false
                  additionalProperties: false
                minItems: 1
            additionalProperties: false
          example:
            errors:
              - type: parameters
                message: The supplied parameters are invalid.
                details:
                  - key: hold_until_date
                    message: The date must be in the future.
    Inventory_API_v1_404-not-found:
      description: >-
        The requested resource was not found. It may have been deleted, it may
        have never existed, or you may not have permission to view it.
      content:
        application/json:
          schema:
            type: object
            properties:
              errors:
                type: array
                items:
                  type: object
                  properties:
                    type:
                      type: string
                      description: The error type code.
                      enum:
                        - not_found
                    message:
                      type: string
                      description: An English sentence describing the error type.
                    details:
                      type: array
                      description: >-
                        An array of objects describing which keys are
                        responsible for the error and detailed messages
                        describing why they are not valid.
                      items:
                        type: object
                        properties:
                          key:
                            type: string
                            description: The path to the key which relates to the error.
                          message:
                            type: string
                            description: >-
                              An English sentence describing the details of the
                              error.
                        additionalProperties: false
                  additionalProperties: false
                minItems: 1
            additionalProperties: false
          example:
            errors:
              - type: not_found
                message: The server could not find the requested resource.
    Inventory_API_v1_500-internal-server-error:
      description: >-
        Internal Server Error - Something wrong happened at server side. Contact
        server administrator for more details.
  securitySchemes:
    ShipStream_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Generate a JWT access token through a Custom Global Integration and
        provide it with each request in the `Authorization` header prefixed with
        "Bearer" and then a single space.

````