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

# Retrieve a batch

> Retrieves detailed information about a specific batch, including its list of shipment order numbers.



## OpenAPI

````yaml GET /client/batch/{batchNumber}
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/{batchNumber}:
    get:
      tags:
        - Batches
      summary: Retrieve a batch
      description: >-
        Retrieves detailed information about a specific batch, including its
        list of shipment order numbers.
      operationId: retrieveBatch
      parameters:
        - $ref: '#/components/parameters/BatchNumber'
      responses:
        '200':
          description: Batch details or error
          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/BatchResponseData'
                required:
                  - message
                  - code
              examples:
                success:
                  summary: Batch retrieved
                  value:
                    message: Success
                    code: 0
                    data:
                      batchNumber: URB0714000000000687
                      batchName: Test batch 1 7-14-2025
                      status: RECEIVED
                      printedLabel: false
                      createdAt: '2025-07-14T17:59:27.645Z'
                      updatedAt: '2025-07-14T18:53:57.669Z'
                      shipmentCount: 1
                      shipments:
                        - UNI07787536D
                notFound:
                  summary: Batch not found
                  value:
                    message: Batch not found
                    code: 1009
                    data: null
components:
  parameters:
    BatchNumber:
      name: batchNumber
      in: path
      required: true
      description: The unique batch number (e.g. URB0714000000000687).
      schema:
        type: string
  schemas:
    BatchResponseData:
      type: object
      properties:
        batchNumber:
          type: string
          description: Unique batch identifier.
        batchName:
          type: string
          description: Batch name.
          nullable: true
        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.
      required:
        - batchNumber
        - status
        - printedLabel
        - shipmentCount
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API access token generated from the UniUni Platform dashboard.

````