> ## 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.

# Release an order from hold

> Releases an order that is on `hold`. The order goes back to `initial` and Cubbo re-validates and
processes it again; any "hold order" business rule configured for your store is skipped on this
re-processing, and a potential-fraud flag on the order is cleared.
- The order must be in `hold`; any other status is refused.
- Requires an API user with the "orders update" permission and access to the store.
- No request body.




## OpenAPI

````yaml /openapi.yaml patch /orders/{id}/unhold
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:
  /orders/{id}/unhold:
    patch:
      tags:
        - Orders
      summary: Release an order from hold
      description: >
        Releases an order that is on `hold`. The order goes back to `initial`
        and Cubbo re-validates and

        processes it again; any "hold order" business rule configured for your
        store is skipped on this

        re-processing, and a potential-fraud flag on the order is cleared.

        - The order must be in `hold`; any other status is refused.

        - Requires an API user with the "orders update" permission and access to
        the store.

        - No request body.
      operationId: unholdOrder
      parameters:
        - name: id
          in: path
          required: true
          description: Cubbo order id.
          schema:
            type: integer
          example: 123456
      responses:
        '200':
          description: The order was released and queued for processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderHoldResult'
              example:
                id: 123456
                status: initial
                order_number: ORD-0001
                store_id: 1234
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: Another request is modifying this order right now. Retry shortly.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: >-
                  Order is being processed by another request. Please try again
                  in a moment.
        '422':
          description: The order is not on hold, or it was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                notOnHold:
                  value:
                    error: An order in pending status cannot be changed on unhold
                orderNotFound:
                  value:
                    error: Couldn't find Order with 'id'=123456
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    OrderHoldResult:
      type: object
      description: Minimal order representation returned by the hold and unhold endpoints.
      required:
        - id
        - status
        - order_number
        - store_id
      properties:
        id:
          type: integer
          description: Cubbo order id.
          example: 123456
        status:
          type: string
          description: >-
            Order status after the action (`hold` after holding, `initial` after
            releasing).
          example: hold
        order_number:
          type: string
          description: Your order number.
          example: ORD-0001
        store_id:
          type: integer
          description: Id of the store the order belongs to.
          example: 1234
    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.