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

# Get Shipments



## OpenAPI

````yaml https://app.amber.ai/api/public/v1/openapi.json get /brands/{brand}/shipments/{id}
openapi: 3.1.0
info:
  title: Amber Public API
  version: 1.3.0
  description: >-
    Read-only access to brand business data. Products are Parent Products;
    Product Options and SKUs are distinct resources. Follow reference IDs and
    collection cursors for complete graphs. API keys never impersonate their
    creator. New source monetary values are decimal strings; deployed summary
    numbers remain unchanged. JSON specifications retain all nested fields.
    Archived rows remain visible unless soft-deleted; supplier-private quote
    drafts are excluded.
servers:
  - url: https://app.amber.ai/api/public/v1
security: []
tags:
  - name: Brand
  - name: Parent Products
  - name: Product Options
  - name: SKUs
  - name: Product Versions
  - name: Boms
  - name: Bom Components
  - name: Bom Skus
  - name: Measurement Tables
  - name: Measurement Table Skus
  - name: Product Relations
  - name: Product Option Values
  - name: Product Option Dimension Values
  - name: Product Option Prices
  - name: Product Option Collections
  - name: Sku Dimension Values
  - name: Product Collections
  - name: Product Tags
  - name: Product Launch Windows
  - name: Suppliers
  - name: Quotes
  - name: Quote Revisions
  - name: Quote Items
  - name: Quote Price Bands
  - name: Quote Notes
  - name: Samples
  - name: Sample Rounds
  - name: Sample Checklist Results
  - name: Orders
  - name: Order Items
  - name: Order Amendments
  - name: Production Runs
  - name: Production Run Items
  - name: Production Run Item Revisions
  - name: Shipments
  - name: Shipment Items
  - name: Shipment Cartons
  - name: Shipment Carton Items
  - name: Shipment Charges
  - name: Order Shipments
  - name: Legs
  - name: Leg Items
  - name: Bookings
  - name: Booking Items
  - name: Shipment Bookings
  - name: Shipment Item Lineages
  - name: Packing Lists
  - name: Packing List Lines
  - name: Goods Receipts
  - name: Goods Receipt Lines
  - name: Inventory
  - name: Invoices
  - name: Invoice Lines
  - name: Payment Agreements
  - name: Payment Milestones
  - name: Payments
  - name: Payment Settlements
  - name: Payment Receipts
  - name: Partners
  - name: Contacts
  - name: Locations
  - name: Brand Locations
  - name: Partner Locations
  - name: Documents
  - name: Document Types
  - name: Images
  - name: Notes
  - name: Materials
  - name: Material Variants
  - name: Bom Sections
  - name: Categories
  - name: Collections
  - name: Launch Windows
  - name: Tags
  - name: Colors
  - name: Options
  - name: Option Values
  - name: Dimensions
  - name: Dimension Values
  - name: Dimension Groups
  - name: Dimension Group Dimensions
  - name: Dimension Curves
  - name: Dimension Curve Axes
  - name: Dimension Curve Axis Values
  - name: Dimension Curve Cells
  - name: Checklists
  - name: Packing Templates
  - name: Carton Sizes
  - name: Couriers
  - name: Payment Terms
  - name: Units Of Measure
  - name: Countries
  - name: Custom Field Definitions
paths:
  /brands/{brand}/shipments/{id}:
    get:
      tags:
        - Shipments
      summary: Get Shipments
      operationId: getShipments
      parameters:
        - name: brand
          in: path
          required: true
          description: Brand slug authorized by this API key.
          schema:
            type: string
            example: acme
        - name: id
          in: path
          required: true
          description: Stable resource identifier.
          schema:
            type: string
            pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
      responses:
        '200':
          description: Visible entity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shipments'
        '400':
          description: >-
            Invalid parameter, unsupported include, or cursor used with
            different filters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, invalid, expired, or out-of-scope API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Entity or related subject is not visible in this brand.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded. Retry after the indicated delay.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              description: Seconds before retrying.
              schema:
                type: integer
                minimum: 0
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    Shipments:
      type: object
      properties:
        id:
          type: string
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
        shipmentCode:
          type: string
        status:
          type: string
        trackingNumber:
          type:
            - string
            - 'null'
        carrier:
          type:
            - string
            - 'null'
        carrierSlug:
          type:
            - string
            - 'null'
        freightForwarder:
          type:
            - string
            - 'null'
        shipmentMode:
          type:
            - string
            - 'null'
        containerNumbers:
          type: array
          items:
            type: string
        totalPacks:
          type:
            - number
            - 'null'
        grossWeightValue:
          type:
            - string
            - 'null'
        grossWeightUom:
          type:
            - string
            - 'null'
        volumeValue:
          type:
            - string
            - 'null'
        volumeUom:
          type:
            - string
            - 'null'
        incoterm:
          type:
            - string
            - 'null'
        incotermLocation:
          type:
            - string
            - 'null'
        targetShipDate:
          type:
            - string
            - 'null'
        agreedShipDate:
          type:
            - string
            - 'null'
        revisedShipDate:
          type:
            - string
            - 'null'
        actualShipDate:
          type:
            - string
            - 'null'
        agreedPickupDate:
          type:
            - string
            - 'null'
        revisedPickupDate:
          type:
            - string
            - 'null'
        actualPickupDate:
          type:
            - string
            - 'null'
        estimatedPortArrivalDate:
          type:
            - string
            - 'null'
        actualPortArrivalDate:
          type:
            - string
            - 'null'
        targetArrivalDate:
          type:
            - string
            - 'null'
        estimatedArrivalDate:
          type:
            - string
            - 'null'
        customsClearedDate:
          type:
            - string
            - 'null'
        customsClearedDateSource:
          type:
            - string
            - 'null'
        actualArrivalDate:
          type:
            - string
            - 'null'
        actualArrivalDateSource:
          type:
            - string
            - 'null'
        cargoReadyDate:
          type:
            - string
            - 'null'
        bookingReceivedDate:
          type:
            - string
            - 'null'
        houseBillNumber:
          type:
            - string
            - 'null'
        masterBillNumber:
          type:
            - string
            - 'null'
        estimatedCost:
          type:
            - string
            - 'null'
        finalCost:
          type:
            - string
            - 'null'
        customsCost:
          type:
            - string
            - 'null'
        costCurrency:
          type:
            - string
            - 'null'
        conveyanceReference:
          type:
            - string
            - 'null'
        loadType:
          type:
            - string
            - 'null'
        loadUtilization:
          type:
            - string
            - 'null'
        originId:
          anyOf:
            - type: string
              pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
            - type: 'null'
        dischargeLocationId:
          anyOf:
            - type: string
              pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
            - type: 'null'
        destinationId:
          anyOf:
            - type: string
              pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
            - type: 'null'
        pickupLocationId:
          anyOf:
            - type: string
              pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
            - type: 'null'
        source:
          type:
            - string
            - 'null'
        externalShipmentId:
          type:
            - string
            - 'null'
        externalStatus:
          type:
            - string
            - 'null'
        externalBookingReference:
          type:
            - string
            - 'null'
        lastEventOccurredAt:
          type:
            - string
            - 'null'
        brandOwnerId:
          anyOf:
            - type: string
              pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
            - type: 'null'
        customFields:
          anyOf:
            - 511bca74-e4bd-4e54-8028-9e56f3c83753
            - type: 'null'
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
        - id
        - shipmentCode
        - status
        - trackingNumber
        - carrier
        - carrierSlug
        - freightForwarder
        - shipmentMode
        - containerNumbers
        - totalPacks
        - grossWeightValue
        - grossWeightUom
        - volumeValue
        - volumeUom
        - incoterm
        - incotermLocation
        - targetShipDate
        - agreedShipDate
        - revisedShipDate
        - actualShipDate
        - agreedPickupDate
        - revisedPickupDate
        - actualPickupDate
        - estimatedPortArrivalDate
        - actualPortArrivalDate
        - targetArrivalDate
        - estimatedArrivalDate
        - customsClearedDate
        - customsClearedDateSource
        - actualArrivalDate
        - actualArrivalDateSource
        - cargoReadyDate
        - bookingReceivedDate
        - houseBillNumber
        - masterBillNumber
        - estimatedCost
        - finalCost
        - customsCost
        - costCurrency
        - conveyanceReference
        - loadType
        - loadUtilization
        - originId
        - dischargeLocationId
        - destinationId
        - pickupLocationId
        - source
        - externalShipmentId
        - externalStatus
        - externalBookingReference
        - lastEventOccurredAt
        - brandOwnerId
        - customFields
        - createdAt
        - updatedAt
      additionalProperties: false
      $defs:
        __schema0:
          anyOf:
            - type: string
            - type: number
            - type: boolean
            - type: 'null'
            - type: array
              items:
                $ref: '#/components/schemas/Shipments/$defs/__schema0'
            - type: object
              propertyNames:
                type: string
              additionalProperties:
                $ref: '#/components/schemas/Shipments/$defs/__schema0'
    Error:
      type: object
      properties:
        error:
          type: string
        errorCode:
          type: string
        details:
          $ref: e288252a-1a5c-4f61-a45d-43bb0ec01ab5
          description: Parameter validation issues, when available.
      required:
        - error
        - errorCode
      additionalProperties: false
      $defs:
        __schema0:
          anyOf:
            - type: string
            - type: number
            - type: boolean
            - type: 'null'
            - type: array
              items:
                $ref: '#/components/schemas/Error/$defs/__schema0'
            - type: object
              propertyNames:
                type: string
              additionalProperties:
                $ref: '#/components/schemas/Error/$defs/__schema0'
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: A brand-scoped or global amb_sk_... API key.

````