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

# Hold seller payout invoices

> Put one or more seller payout invoices on hold and rebalance any affected scheduled payout batch.



## OpenAPI

````yaml https://openapi.commercengine.io/ce-admin.json post /orders/payouts/invoices/hold
openapi: 3.1.0
info:
  title: CE Admin APIs
  version: '1.0'
  summary: Comprehensive admin interface for managing your e-commerce platform
  description: >-
    Complete administrative API suite for Commerce Engine, providing powerful
    tools to manage products, orders, customers, inventory, analytics, and
    system configuration. Designed for administrators and backend integrations
    requiring full platform control.
  license:
    name: All Rights Reserved
    url: https://www.commercengine.io/contact-us
  contact:
    email: support@commercengine.io
    url: https://www.commercengine.io/contact-us
    name: Support
servers:
  - url: https://staging.api.commercengine.io/api/v1/{store_id}/admin
    description: Staging Server
    variables:
      store_id:
        default: store_id
        description: Store ID
  - url: https://prod.api.commercengine.io/api/v1/{store_id}/admin
    description: Prod Server
    variables:
      store_id:
        default: store_id
        description: Store ID
security:
  - Authorization: []
tags:
  - name: Analytics
    description: Analytics
  - name: Catalog
    description: Catalog
  - name: Coupons & promotions
    description: Coupons & promotions
  - name: Customers
    description: Customers
  - name: Filter Options
    description: Filter Options
  - name: Inventories
    description: Inventories
  - name: Marketplace
    description: Marketplace
  - name: Marketplace Catalog
    description: Marketplace Catalog
  - name: Media Gallery
    description: Media Gallery
  - name: Metrics
    description: Metrics
  - name: Orders
    description: Orders
  - name: Payments
    description: Payments
  - name: Payouts
    description: Payouts
  - name: POS
    description: POS
  - name: POSAdmin
    description: Admin endpoints to be used as proxy in pos
  - name: Segments
    description: Segments
  - name: Shipping
    description: Shipping
  - name: SSE
    description: SSE
  - name: Store
    description: Store
  - name: Webhooks
    description: Webhooks
paths:
  /orders/payouts/invoices/hold:
    parameters: []
    post:
      tags:
        - Payouts
      summary: Hold seller payout invoices
      description: >-
        Put one or more seller payout invoices on hold and rebalance any
        affected scheduled payout batch.
      operationId: hold-seller-payout-invoices
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SellerPayoutInvoiceHoldRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                  content:
                    $ref: '#/components/schemas/SellerPayoutInvoiceHoldSummary'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    SellerPayoutInvoiceHoldRequest:
      title: SellerPayoutInvoiceHoldRequest
      type: object
      required:
        - invoice_numbers
        - seller_id
      properties:
        invoice_numbers:
          type: array
          items:
            type: string
          minItems: 1
        seller_id:
          description: >-
            Seller ID must exist in the marketplace seller cache. Every invoice
            in invoice_numbers must belong to this seller.
          type: string
      x-tags:
        - Payouts
    SellerPayoutInvoiceHoldSummary:
      title: SellerPayoutInvoiceHoldSummary
      type: object
      properties:
        already_on_hold_invoice_numbers:
          type: array
          items:
            type: string
        batches_deleted:
          description: Batch numbers deleted after rebalancing.
          type: array
          items:
            type: string
        batches_updated:
          description: Batch numbers updated after rebalancing.
          type: array
          items:
            type: string
        held_invoice_numbers:
          type: array
          items:
            type: string
      x-tags:
        - Payouts
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              error:
                type: object
                properties:
                  fieldname:
                    type: array
                    items:
                      type: string
    Unauthorized:
      description: Not authorized for given operation on the Resource
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Not authorized for given operation on the Resource.
              success:
                type: boolean
                default: false
              code:
                type: string
                example: unauthorized
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````