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



## OpenAPI

````yaml https://app.amber.ai/api/public/v1/openapi.json get /brands/{brand}/orders/{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}/orders/{id}:
    get:
      tags:
        - Orders
      summary: Get Orders
      operationId: getOrders
      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
      responses:
        '200':
          description: Visible entity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderDetail'
        '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:
    OrderDetail:
      type: object
      properties:
        details:
          type: object
          properties:
            id:
              type: string
            code:
              type: string
            externalOrderCode:
              type:
                - string
                - 'null'
            supplierId:
              type: string
            status:
              type: string
            orderPlacedDate:
              type:
                - string
                - 'null'
            targetExFactoryDate:
              type:
                - string
                - 'null'
            agreedExFactoryDate:
              type:
                - string
                - 'null'
            revisedExFactoryDate:
              type:
                - string
                - 'null'
            actualExFactoryDate:
              type:
                - string
                - 'null'
            targetDeliveryDate:
              type:
                - string
                - 'null'
            agreedDeliveryDate:
              type:
                - string
                - 'null'
            needByDate:
              type:
                - string
                - 'null'
            currency:
              type:
                - string
                - 'null'
            orderType:
              type: string
            priority:
              type: string
            deliveryTerms:
              type:
                - string
                - 'null'
            countryOfOriginCode:
              type:
                - string
                - 'null'
            brandOwnerId:
              type:
                - string
                - 'null'
            paymentTermsId:
              type:
                - string
                - 'null'
            notes:
              anyOf:
                - 974b438f-cde3-4773-b09d-3150bc93c604
                - type: 'null'
            memo:
              type:
                - string
                - 'null'
            customFields:
              anyOf:
                - fee74ff2-e7b8-4356-b0d3-a762be92520e
                - type: 'null'
            lastActivityAt:
              type:
                - string
                - 'null'
            subtotalAmount:
              type:
                - string
                - 'null'
            dutyAmount:
              type:
                - string
                - 'null'
            dutySource:
              type:
                - string
                - 'null'
            freightCharges:
              type:
                - string
                - 'null'
            otherCosts:
              type:
                - string
                - 'null'
            totalAmount:
              type:
                - string
                - 'null'
            exchangeRate:
              type:
                - string
                - 'null'
            subtotalAmountBase:
              type:
                - string
                - 'null'
            dutyAmountBase:
              type:
                - string
                - 'null'
            freightChargesBase:
              type:
                - string
                - 'null'
            otherCostsBase:
              type:
                - string
                - 'null'
            totalAmountBase:
              type:
                - string
                - 'null'
            quoteId:
              type:
                - string
                - 'null'
            locationId:
              type:
                - string
                - 'null'
            createdAt:
              type: string
            updatedAt:
              type: string
            deletedAt:
              type:
                - string
                - 'null'
          required:
            - id
            - code
            - externalOrderCode
            - supplierId
            - status
            - orderPlacedDate
            - targetExFactoryDate
            - agreedExFactoryDate
            - revisedExFactoryDate
            - actualExFactoryDate
            - targetDeliveryDate
            - agreedDeliveryDate
            - needByDate
            - currency
            - orderType
            - priority
            - deliveryTerms
            - countryOfOriginCode
            - brandOwnerId
            - paymentTermsId
            - notes
            - memo
            - customFields
            - lastActivityAt
            - subtotalAmount
            - dutyAmount
            - dutySource
            - freightCharges
            - otherCosts
            - totalAmount
            - exchangeRate
            - subtotalAmountBase
            - dutyAmountBase
            - freightChargesBase
            - otherCostsBase
            - totalAmountBase
            - quoteId
            - locationId
            - createdAt
            - updatedAt
            - deletedAt
          additionalProperties: false
        id:
          type: string
        orderNumber:
          type: string
        status:
          type: string
        supplier:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
          required:
            - id
            - name
          additionalProperties: false
        lineItems:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              skuId:
                type:
                  - string
                  - 'null'
              productVersionId:
                type:
                  - string
                  - 'null'
              productCode:
                type: string
              productName:
                type: string
              quantity:
                type:
                  - number
                  - 'null'
              unitPrice:
                type:
                  - number
                  - 'null'
            required:
              - productCode
              - productName
              - quantity
              - unitPrice
            additionalProperties: false
        totalAmount:
          type:
            - number
            - 'null'
        currency:
          type: string
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
        - id
        - orderNumber
        - status
        - supplier
        - lineItems
        - totalAmount
        - currency
        - createdAt
        - updatedAt
      additionalProperties: false
      $defs:
        __schema0:
          anyOf:
            - type: string
            - type: number
            - type: boolean
            - type: 'null'
            - type: array
              items:
                $ref: '#/components/schemas/OrderDetail/$defs/__schema0'
            - type: object
              propertyNames:
                type: string
              additionalProperties:
                $ref: '#/components/schemas/OrderDetail/$defs/__schema0'
        __schema1:
          anyOf:
            - type: string
            - type: number
            - type: boolean
            - type: 'null'
            - type: array
              items:
                $ref: '#/components/schemas/OrderDetail/$defs/__schema1'
            - type: object
              propertyNames:
                type: string
              additionalProperties:
                $ref: '#/components/schemas/OrderDetail/$defs/__schema1'
    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.

````