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

# Put a lot on hold

> Withholds a lot's stock from fulfillment. The lot is identified by `<material_code>-<lot_code>`
(material code is the product SKU). The hold is applied asynchronously right after the call:
the lot moves to `HOLDED` and its sellable units stop being assigned to orders. Use
`POST /lots/unhold/store/{store_id}` to release it.
- The `status` in the response is the lot status at the moment of the request, in lowercase, so it still reads `active` on a successful hold request.




## OpenAPI

````yaml /openapi.yaml post /lots/hold/store/{store_id}
openapi: 3.1.0
info:
  title: Cubbo Clients API
  version: '1.0'
  summary: >-
    Orders, inventory, replenishments, returns, shipping and webhooks for Cubbo
    fulfillment.
  description: >
    The Cubbo Clients API connects your store, ERP or marketplace with Cubbo's
    fulfillment network.

    All endpoints except `POST /auth/token` require a bearer token; see the
    Authentication guide.

    Request and response bodies are JSON. Errors are JSON objects with an
    `error` key.
  contact:
    name: Cubbo integrations
    email: integraciones@cubbo.com
servers:
  - url: https://api.cubbo.com/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Exchange client credentials for a bearer token.
  - name: Orders
    description: Create, update, hold, cancel and read sales orders.
  - name: Shipping labels
    description: Read the shipping labels generated for an order.
  - name: Inventory
    description: Products and stock per store.
  - name: Lots
    description: Lot-level inventory for products with expiration or batch tracking.
  - name: Reports
    description: Bulk reports for reconciliation.
  - name: Replenishments
    description: Inbound shipments to the warehouse.
  - name: Returns
    description: Returns and exchanges.
  - name: Stores
    description: Store provisioning and settings.
  - name: Shipping methods
    description: Available shipping methods, coverage and quotes.
  - name: Click and collect
    description: Pickup points and in-store pickup orders.
paths:
  /lots/hold/store/{store_id}:
    post:
      tags:
        - Lots
      summary: Put a lot on hold
      description: >
        Withholds a lot's stock from fulfillment. The lot is identified by
        `<material_code>-<lot_code>`

        (material code is the product SKU). The hold is applied asynchronously
        right after the call:

        the lot moves to `HOLDED` and its sellable units stop being assigned to
        orders. Use

        `POST /lots/unhold/store/{store_id}` to release it.

        - The `status` in the response is the lot status at the moment of the
        request, in lowercase, so it still reads `active` on a successful hold
        request.
      operationId: holdLot
      parameters:
        - name: store_id
          in: path
          required: true
          description: Store the lot belongs to.
          schema:
            type: integer
          example: 1234
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LotHoldRequest'
            example:
              material_code: SKU-RED-M
              lot_code: L2026-04
      responses:
        '200':
          description: Hold requested.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LotHoldResponse'
              example:
                unique_code: SKU-RED-M-L2026-04
                status: active
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          description: Validation or business error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                missingParam:
                  value:
                    error: Parameter material_code is required
                lotNotFound:
                  value:
                    error: No lot found with unique_code SKU-RED-M-L2026-04
                ambiguous:
                  value:
                    error: >-
                      Mutiple lots with unique_code SKU-RED-M-L2026-04, this
                      identifier must be unique
                storeNotFound:
                  value:
                    error: Couldn't find Store with 'id'=1234
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    LotHoldRequest:
      type: object
      description: >-
        Body of `POST /lots/hold/store/{store_id}` and `POST
        /lots/unhold/store/{store_id}`.
      properties:
        material_code:
          type: string
          description: >-
            Product SKU (material code). Combined with `lot_code` as
            `<material_code>-<lot_code>` to find the lot.
          example: SKU-RED-M
        lot_code:
          type: string
          description: Lot code.
          example: L2026-04
      required:
        - material_code
        - lot_code
    LotHoldResponse:
      type: object
      description: Acknowledgement of a hold or release request.
      properties:
        unique_code:
          type: string
          description: The lot's unique code within the store.
          example: SKU-RED-M-L2026-04
        status:
          type: string
          description: >-
            Lot status at the moment of the request, in lowercase. The hold or
            release is applied right after.
          enum:
            - active
            - holded
            - damaged
            - expired
          example: active
      required:
        - unique_code
        - status
    Error:
      type: object
      description: Error body returned by every failed request.
      required:
        - error
      properties:
        error:
          type: string
          description: >-
            Human-readable description of the failure. For `401` responses it is
            always `Unauthorized`.
          example: Parameter store_id is required
        message:
          type: string
          description: >-
            Present on `401` responses only; the reason the request was
            rejected.
          example: invalid token
        code:
          type:
            - string
            - 'null'
          description: >-
            Stable machine-readable code, present on some order, return and
            replenishment errors.
          example: ORDER_ALREADY_EXISTS
        context:
          type:
            - object
            - 'null'
          description: >-
            Extra data about the failure when available, for example the id of
            the conflicting order.
          additionalProperties: true
          example:
            order_id: 987654
  responses:
    Unauthorized:
      description: >-
        Missing or invalid token, wrong credentials, or no access to the
        requested store.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            invalidToken:
              value:
                error: Unauthorized
                message: invalid token
            noHeader:
              value:
                error: Unauthorized
                message: no authorization header found
            storeNotAllowed:
              value:
                error: Unauthorized
                message: not allowed to show? this Store
    InternalServerError:
      description: >-
        Unexpected error. Retry with backoff; if it persists, send the timestamp
        to Cubbo support.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: 'unexpected error, timestamp: 1760000000'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Token returned by `POST /auth/token`, sent as `Authorization: Bearer
        <token>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.