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

# Lister tous les lots

> Retrieves a paginated list of batches.



## OpenAPI

````yaml GET /client/batch
openapi: 3.1.0
info:
  title: UniUni Platform Client API
  description: >-
    API for creating shipments, purchasing labels, managing batches, tracking
    deliveries, and receiving webhook notifications.
  version: 1.0.0
  contact:
    name: UniUni Retail Support
    email: retailsupport@uniuni.com
servers:
  - url: https://api.ship.uniuni.com/prod
    description: Production
  - url: https://api-sandbox.ship.uniuni.com
    description: Sandbox
security:
  - bearerAuth: []
tags:
  - name: Shipments
    description: Create, retrieve, list, purchase, refund, and delete shipments.
  - name: Batches
    description: Group purchased shipments into batches for drop-off or pickup.
  - name: Labels
    description: Retrieve shipping and batch labels as Base64-encoded PDFs.
  - name: Tracking
    description: Track shipment status and scan events.
  - name: Webhooks
    description: Receive real-time shipment status updates.
paths:
  /client/batch:
    get:
      tags:
        - Batches
      summary: List all batches
      description: Retrieves a paginated list of batches.
      operationId: listBatches
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/PageSize'
        - name: isNotInPickup
          in: query
          description: If true, only returns batches that are not in pickup status.
          schema:
            type: boolean
      responses:
        '200':
          description: Paginated list of batches
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Additional information about the request status.
                  code:
                    type: integer
                    description: Status code. 0 indicates success.
                  data:
                    $ref: '#/components/schemas/ListBatchesResponseData'
                required:
                  - message
                  - code
              example:
                message: Success
                code: 0
                data:
                  batches:
                    - batchNumber: URB0805000000000947
                      batchName: final-test
                      status: PENDING
                      printedLabel: true
                      createdAt: '2025-08-05T17:31:27.157Z'
                      updatedAt: '2025-08-05T17:34:32.262Z'
                      shipmentCount: 1
                  pagination:
                    page: 1
                    pageSize: 10
                    count: 25
components:
  parameters:
    Page:
      name: page
      in: query
      description: Page number.
      schema:
        type: integer
        default: 1
        minimum: 1
    PageSize:
      name: pageSize
      in: query
      description: Results per page.
      schema:
        type: integer
        default: 10
        maximum: 500
  schemas:
    ListBatchesResponseData:
      type: object
      properties:
        batches:
          type: array
          items:
            $ref: '#/components/schemas/Batch'
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - batches
        - pagination
    Batch:
      type: object
      properties:
        batchNumber:
          type: string
          description: Unique batch identifier.
        batchName:
          type: string
          description: Batch name.
        status:
          type: string
          enum:
            - PENDING
            - PICKUP_REQUESTED
            - PICKUP_CANCELLED
            - PARTNER_RECEIVED
            - PICKED_UP
            - RECEIVED
          description: Batch status.
        printedLabel:
          type: boolean
          description: Whether the batch label has been printed.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        shipmentCount:
          type: integer
          description: Number of shipments in the batch.
        shipments:
          type: array
          items:
            type: string
          description: List of shipment order numbers.
    Pagination:
      type: object
      properties:
        page:
          type: integer
        pageSize:
          type: integer
        count:
          type: integer
          description: Total number of records.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API access token generated from the UniUni Platform dashboard.

````