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

> Retrieves a specific shipment by its order number.



## OpenAPI

````yaml GET /client/shipments/{orderNumber}
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/shipments/{orderNumber}:
    get:
      tags:
        - Shipments
      summary: Retrieve a shipment
      description: Retrieves a specific shipment by its order number.
      operationId: retrieveShipment
      parameters:
        - $ref: '#/components/parameters/OrderNumber'
      responses:
        '200':
          description: Shipment retrieved or error returned
          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/RetrieveShipmentResponseData'
                required:
                  - message
                  - code
              examples:
                success:
                  summary: Shipment retrieved successfully
                  value:
                    message: Shipment retrieved successfully
                    code: 0
                    data:
                      shipment:
                        orderNumber: UNI0199855FF
                        trackingId: UR05310000000001281
                        recipient:
                          name: Jane Doe
                          email: jane@example.com
                        address:
                          address1: 88 Harbour St
                          city: Toronto
                          province: 'ON'
                          postalCode: M7A 2S1
                          country: Canada
                        dimensions:
                          length: 1
                          width: 1
                          height: 1
                          dimensionUnit: INCH
                        weight:
                          value: 2
                          weightUnit: LB
                        status: PENDING
                        note: ''
                        createdAt: '2025-05-31T20:48:39.986Z'
                        updatedAt: '2025-07-25T17:29:30.772Z'
                        rates:
                          postageType: NEXT DAY
                          postageFee: 4.93
                          tax: 0.64
                          total: 5.57
                          currency: CAD
                        shipmentLineItems: []
                notFound:
                  summary: Shipment not found
                  value:
                    message: Shipment not found
                    code: 1009
                    data: null
components:
  parameters:
    OrderNumber:
      name: orderNumber
      in: path
      required: true
      description: The unique order number (e.g. UNI031455E90).
      schema:
        type: string
  schemas:
    RetrieveShipmentResponseData:
      type: object
      properties:
        shipment:
          $ref: '#/components/schemas/ShipmentResponseData'
      required:
        - shipment
    ShipmentResponseData:
      type: object
      properties:
        orderNumber:
          type: string
          description: Unique order number.
        trackingId:
          type: string
          description: Shipment tracking ID.
        recipient:
          $ref: '#/components/schemas/Recipient'
        address:
          $ref: '#/components/schemas/Address'
        dimensions:
          $ref: '#/components/schemas/Dimensions'
        weight:
          $ref: '#/components/schemas/Weight'
        status:
          $ref: '#/components/schemas/ShipmentStatus'
        note:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        rates:
          $ref: '#/components/schemas/BillingSummary'
        shipmentLineItems:
          type: array
          items:
            $ref: '#/components/schemas/ShipmentLineItem'
        insuranceRequired:
          type: boolean
      required:
        - orderNumber
        - trackingId
        - status
        - createdAt
    Recipient:
      type: object
      properties:
        name:
          type: string
          description: Recipient name.
        phone:
          type: string
          description: Recipient phone number.
        email:
          type: string
          format: email
          description: Recipient email.
        signature:
          type: boolean
          default: false
          description: Whether signature is required on delivery.
      required:
        - name
    Address:
      type: object
      properties:
        address1:
          type: string
          description: Address line 1.
        address2:
          type: string
          description: Address line 2.
        address3:
          type: string
          description: Address line 3.
        city:
          type: string
          description: City.
        province:
          type: string
          description: Province or state code.
        postalCode:
          type: string
          description: Postal or ZIP code.
        country:
          type: string
          description: Country code (e.g. CA, US).
        latitude:
          type: number
          description: Latitude.
        longitude:
          type: number
          description: Longitude.
      required:
        - address1
        - city
        - province
        - postalCode
        - country
    Dimensions:
      type: object
      properties:
        length:
          type: number
          description: Length.
        width:
          type: number
          description: Width.
        height:
          type: number
          description: Height.
        dimensionUnit:
          type: string
          enum:
            - CM
            - INCH
            - M
            - FT
          description: Unit of dimension.
    Weight:
      type: object
      properties:
        value:
          type: number
          description: Weight value.
        weightUnit:
          type: string
          enum:
            - G
            - KG
            - LB
            - OZ
          description: Unit of weight.
      required:
        - value
        - weightUnit
    ShipmentStatus:
      type: string
      enum:
        - DRAFT
        - PENDING
        - PENDING_REVIEW
        - PICKUP_REQUESTED
        - PICKUP_CANCELLED
        - PARTNER_RECEIVED
        - PICKED_UP
        - RECEIVED
        - GATEWAY_TRANSIT
        - PARCEL_SCANNED
        - TRANSSHIPMENT_COMPLETE
        - IN_TRANSIT
        - OUT_FOR_DELIVERY
        - DELIVERED
        - SHIPMENT_EXCEPTION
        - AGED_OUT
        - RETURNED
        - CANCELLED
        - STORAGE
        - FAILED
        - FAILED_DELIVERY1
        - FAILED_DELIVERY2
        - GATEWAY_TO_GATEWAY_TRANSIT
        - GATEWAY_TRANSIT_OUT
      description: Shipment status.
    BillingSummary:
      type: object
      properties:
        postageType:
          $ref: '#/components/schemas/PostageType'
        postageFee:
          type: number
          description: Postage fee.
        signatureFee:
          type: number
          description: Signature fee.
        duty:
          type: number
          description: Duty amount (cross-border shipments only).
        tax:
          type: number
          description: Tax amount.
        total:
          type: number
          description: Total cost.
        currency:
          type: string
          enum:
            - CAD
            - USD
          description: Currency code.
    ShipmentLineItem:
      type: object
      properties:
        description:
          type: string
          description: Item description.
        quantity:
          type: integer
          description: Quantity (must be a positive integer).
        unit_value:
          type: number
          description: >-
            Value per unit. Accepted as unit_value (snake_case) or unitValue
            (camelCase).
        currency:
          type: string
          enum:
            - CAD
            - USD
          description: Currency code.
        hs_code:
          type: string
          description: >-
            HS tariff code for cross-border shipments. Accepted as hs_code or
            hsCode.
        country_of_origin:
          type: string
          description: >-
            ISO country code of manufacture. Accepted as country_of_origin or
            countryOfOrigin.
        sku:
          type: string
          description: Your internal SKU reference.
        manufacturer:
          type: object
          description: Manufacturer details. Required for some cross-border shipments.
          properties:
            name:
              type: string
              description: Manufacturer name (min 3 characters).
            address1:
              type: string
              description: Street address.
            address2:
              type: string
              description: Address line 2.
            city:
              type: string
              description: City.
            provinceCode:
              type: string
              description: Province or state code.
            postalCode:
              type: string
              description: Postal or ZIP code.
            countryCode:
              type: string
              description: ISO 3166-1 alpha-2 country code (e.g. CN, US, CA).
            phone:
              type: string
              description: Manufacturer phone number.
            email:
              type: string
              format: email
              description: Manufacturer email address.
          required:
            - name
            - address1
            - city
            - countryCode
      required:
        - description
        - quantity
        - unit_value
        - currency
    PostageType:
      type: string
      enum:
        - PUBLICATION
        - SAME DAY
        - NEXT DAY
        - STANDARD
        - USPS Ground Advantage
        - PostNL International Packet Tracked
        - OTHER
      description: >-
        Preferred postage type. Domestic shipments typically use SAME DAY, NEXT
        DAY, or STANDARD. Cross-border CA→US shipments use USPS Ground Advantage
        (DDP) or PostNL International Packet Tracked (DDU). If the requested
        type is unavailable, an available type is selected automatically.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API access token generated from the UniUni Platform dashboard.

````