> ## 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 one Hold by ID > Releases a single active `stock_hold` row by its `id`. ## OpenAPI ````yaml POST /v1/inventory/holds/{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/{id}/release: post: tags: - Holds summary: Release one Hold by ID description: Releases a single active `stock_hold` row by its `id`. operationId: releaseHold parameters: - name: id in: path required: true schema: type: integer format: int64 description: hold_id to release. requestBody: required: false description: >- Empty object `{}`. The engine's `Hold::release()` does not currently accept release-time notes — the `notes` set when the hold was placed is preserved in the audit history. content: application/json: schema: type: object additionalProperties: false responses: '200': description: Hold released. content: application/json: schema: type: object properties: resource: $ref: '#/components/schemas/Inventory_API_v1_Hold' '404': $ref: '#/components/responses/Inventory_API_v1_404-not-found' '422': $ref: '#/components/responses/Inventory_API_v1_422-unprocessable' description: Hold is not active (already released) — see error body for details. '500': $ref: '#/components/responses/Inventory_API_v1_500-internal-server-error' components: schemas: Inventory_API_v1_Hold: title: Hold type: object description: >- An inventory hold record. Cross-merchant view (Global API surface). **Releasing cascaded holds:** when `holdLot` is called with `cascade_bom=true`, free the cascade tree by releasing each child via `POST /holds/{id}/release`, using `origin.created_origin_hold_ids ∪ cascade.child_hold_ids` from the original `holdLot` response. **Do not** include `origin.root_hold_ids` blindly in the release set — those may include pre-existing roots from a prior `cascadeLotHold` call that this call attached children to, and releasing them would also release siblings the current caller did not place. properties: type: type: string enum: - Hold readOnly: true id: type: integer format: int64 description: Internal `hold_id` primary key. readOnly: true example: 142 merchant: description: Merchant that owns the held product. allOf: - $ref: '#/components/schemas/Inventory_API_v1_MerchantRef' warehouse: description: Warehouse where the held inventory lives. allOf: - $ref: '#/components/schemas/Inventory_API_v1_WarehouseRef' product: description: Product whose inventory is on hold. allOf: - $ref: '#/components/schemas/Inventory_API_v1_StockableProductRef' location: description: Specific location holding the inventory (label included). allOf: - $ref: '#/components/schemas/Inventory_API_v1_LocationRef' lot: description: >- Lot whose inventory is on hold (NULL when the hold is location-scope without a lot). nullable: true allOf: - $ref: '#/components/schemas/Inventory_API_v1_LotRef' reason: type: object description: Hold reason — emitted inline with parent_code resolved. properties: code: type: string description: Reason code (system or user-defined). example: damaged label: type: string description: Human-readable reason label. example: Damaged parent_code: type: string nullable: true description: >- Parent (system) reason code; NULL when this reason is itself a system parent. example: damaged required: - code - label qty: type: number format: float description: Held quantity. example: 12 held_at: type: string format: date-time description: When the hold was placed. example: '2026-04-28T14:32:00Z' held_by: nullable: true description: >- Requester who placed the hold (admin user, client user, API key, integration, etc.). allOf: - $ref: '#/components/schemas/Inventory_API_v1_RequesterRef' released_at: type: string format: date-time nullable: true description: When the hold was released (NULL while still active). example: null released_by: nullable: true description: Requester who released the hold. allOf: - $ref: '#/components/schemas/Inventory_API_v1_RequesterRef' notes: type: string nullable: true description: Free-form notes attached at place / release time. example: Damaged in receiving status: type: string enum: - active - released description: Computed from released_at; 'active' when released_at IS NULL. example: active updated_at: type: string format: date-time nullable: true description: >- Last meaningful timestamp (released_at when present, otherwise held_at). example: '2026-04-28T14:32:00Z' required: - type - id - qty - held_at - status Inventory_API_v1_MerchantRef: title: MerchantRef type: object description: Reference a `Merchant` by `id`. properties: type: type: string enum: - Merchant id: type: integer format: int32 example: 4 description: >- The internal `id` property used as a path parameter in a resource lookup. required: - type - id additionalProperties: false Inventory_API_v1_WarehouseRef: title: WarehouseRef type: object description: A reference to a `Warehouse` by `id`. properties: type: type: string enum: - Warehouse description: This property describes the type of object in the response body. id: type: integer format: int32 description: >- The internal `id` property used as a path parameter in a resource lookup. required: - type - id nullable: true additionalProperties: false Inventory_API_v1_StockableProductRef: title: StockableProductRef type: object description: A reference to a `Product` or stockable packaging type object by `id`. properties: type: type: string description: >- This is a read-only property that describes the type of object in the response body. enum: - Product - PackagingContainer - PackagingInfill - PackagingSupplies id: type: integer description: >- The internal, read-only, `id` property used as a path parameter in a resource lookup. format: int32 required: - type - id nullable: true additionalProperties: false Inventory_API_v1_LocationRef: title: LocationRef type: object description: A reference to a `Location` by `id`. properties: type: type: string description: This property describes the type of object in the response body. enum: - Location id: type: integer format: int32 example: 42 description: >- The internal `id` property used as a path parameter in a resource lookup. required: - type - id nullable: true additionalProperties: false Inventory_API_v1_LotRef: title: LotRef type: object description: >- A reference to a `Lot` object. The Lot records the time some inventory was originated (first received or otherwise created) and optionally a lot number and expiration date and may affect the order in which inventory is "burned" depending on the `LotType`. properties: type: type: string enum: - Lot description: This property describes the type of object in the response body. id: type: integer example: 54 description: >- The internal `id` property used as a path parameter in a resource lookup. required: - type - id nullable: true additionalProperties: false Inventory_API_v1_RequesterRef: title: RequesterRef type: object description: Reference a requester (who/what performed an action) by `type` and `id`. properties: type: type: string enum: - Requester example: Requester description: The resource type (always "Requester"). id: type: integer format: int32 example: 3 description: The internal requester ID (`requester_id`). required: - type - id additionalProperties: false responses: 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_422-unprocessable: description: >- There was an error processing 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: - application - unable_to_process 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: unable_to_process message: The supplied parameters are invalid. details: - key: hold_until_date message: The date must be in the future. 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. ````