> ## 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. # List seller payout batches > Retrieves a paginated list of payout batches. Each entry is a `SellerPayoutBatch` summary without invoices or adjustments; retrieve a batch by `id` for the expanded `SellerPayoutBatchDetail`. ## OpenAPI ````yaml https://openapi.commercengine.io/ce-admin.json get /orders/payouts/invoices/batches 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/batches: parameters: [] get: tags: - Payouts summary: List seller payout batches description: >- Retrieves a paginated list of payout batches. Each entry is a `SellerPayoutBatch` summary without invoices or adjustments; retrieve a batch by `id` for the expanded `SellerPayoutBatchDetail`. operationId: list-seller-payout-batches parameters: - $ref: '#/components/parameters/pageNumber' - $ref: '#/components/parameters/pageLimit' responses: '200': description: OK content: application/json: schema: type: object properties: message: type: string success: type: boolean content: properties: payout_batches: type: array items: $ref: '#/components/schemas/SellerPayoutBatch' pagination: $ref: '#/components/schemas/Pagination' type: object '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' components: parameters: pageNumber: name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: page number of pagination list pageLimit: name: limit in: query required: false schema: type: integer default: 25 minimum: 1 description: no of rows per page schemas: SellerPayoutBatch: title: SellerPayoutBatch description: >- A settlement batch that groups a seller's payout-eligible invoices into a single transfer. type: object properties: batch_number: description: Human-readable batch reference, e.g. `PB-TNSFR9Q0HA7J`. type: string credit_adjustments: description: Total credits applied to the batch from its `adjustments`. type: number debit_adjustments: description: Total debits applied to the batch from its `adjustments`. type: number id: description: Payout batch ULID. type: string include_shipping_in_payout: description: >- Snapshot of the seller's payout config at batch creation. When `true`, shipping charges are part of the payable amount. type: boolean include_tax_in_payout: description: >- Snapshot of the seller's payout config at batch creation. When `true`, tax collected on the invoices is part of the payable amount. type: boolean initiated_by: description: >- `system` for scheduled batch runs, `admin` for manually created batches. type: string enum: - system - admin initiated_by_user_id: description: >- The admin user who created the batch. `null` when `initiated_by` is `system`. type: - string - 'null' invoice_count: description: Number of payout invoices settled by this batch. type: integer period_end: description: End of the invoice eligibility window covered by this batch. type: string format: date-time period_start: description: Start of the invoice eligibility window covered by this batch. type: string format: date-time remarks: type: - string - 'null' scheduled_at: description: When the batch is scheduled to be transferred to the seller. type: string format: date-time seller_id: type: string seller_name: type: string readOnly: true status: description: >- Batch lifecycle state. Batches move `pending` → `scheduled` → `processing` → `processed` → `transferred`; `on_hold`, `failed`, and `cancelled` are terminal until an admin acts. type: string enum: - pending - scheduled - processing - processed - transferred - failed - cancelled - on_hold to_be_paid: description: >- Net amount payable to the seller: `total_invoice_amount` - `total_charges` + `credit_adjustments` - `debit_adjustments`. type: number total_charges: description: >- Sum of marketplace charges deducted across all invoices in the batch. type: number total_invoice_amount: description: Sum of the batched invoice amounts, before charges and adjustments. type: number x-tags: - Payouts Pagination: title: Pagination description: pagination metadata structure type: object properties: total_records: type: integer total_pages: type: integer previous_page: description: Previous page number type: - integer - 'null' limit: type: integer default: 25 next_page: description: Next page number type: - integer - 'null' 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 ````