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

# Get Order

> Get one order by its OmniCommerce UUID for the authenticated organization.

### Authentication

Requires `orders:read`.

### Response

The organization-scoped detail includes:

- Line items and normalized status
- Buyer and contact fields
- Shipping and billing addresses
- Return context
- Finance breakdown
- Settlement projection, when available

Orders outside the authenticated organization are not exposed and return `404 Not Found`.



## OpenAPI

````yaml /openapi.json get /api/v1/orders/{orderId}
openapi: 3.1.0
info:
  title: OmniCommerce API
  version: 1.0.0
  license:
    name: Proprietary
    url: https://omnicommerce.sg/terms
  description: >-
    OmniCommerce API surface for agents and developer integrations. Includes
    public endpoints (merchant discovery, product search, compare, catalog, ACO
    retrieval) and authenticated endpoints (product management via API key
    Bearer tokens).
servers:
  - url: https://omnicommerce.sg
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: agentic-checkout
    description: Merchant-fulfilled agentic checkout
    x-group: Agentic Checkout
  - name: commerce
    description: Root commerce discovery
    x-group: Commerce
  - name: developer-platform
    description: Authenticated developer platform APIs
    x-group: Developer Platform
  - name: looks
    description: AI-styled product looks
    x-group: Looks
  - name: oauth
    description: OAuth token endpoints
    x-group: OAuth
  - name: orders
    description: Workspace and agentic orders
    x-group: Orders
  - name: organizations
    description: Organization management
    x-group: Organizations
  - name: price-books
    description: Marketplace list-price markup rules
    x-group: Price Books
  - name: products
    description: Product CRUD, bulk import, and publish
    x-group: Products
  - name: promotions
    description: Central promotions and marketplace sync
    x-group: Promotions
  - name: public-agent
    description: Public agent discovery and catalog APIs
    x-group: Public Agent
  - name: returns
    description: returns
    x-group: Returns
  - name: settlements
    description: settlements
    x-group: Settlements
  - name: ucp
    description: Universal Commerce Protocol
    x-group: UCP
paths:
  /api/v1/orders/{orderId}:
    get:
      tags:
        - orders
      summary: Get Order
      description: >-
        Get one order by its OmniCommerce UUID for the authenticated
        organization.


        ### Authentication


        Requires `orders:read`.


        ### Response


        The organization-scoped detail includes:


        - Line items and normalized status

        - Buyer and contact fields

        - Shipping and billing addresses

        - Return context

        - Finance breakdown

        - Settlement projection, when available


        Orders outside the authenticated organization are not exposed and return
        `404 Not Found`.
      operationId: get_v1_orders_by_orderid
      parameters:
        - name: orderId
          in: path
          required: true
          description: OmniCommerce order UUID returned from create or list.
          schema:
            type: string
            format: uuid
        - name: organizationId
          in: query
          required: false
          description: >-
            Optional organization scope for session-authenticated calls. OAuth
            client credentials resolve the organization from the token.
          schema:
            type: string
            maxLength: 120
      responses:
        '200':
          description: Order detail returned.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                required:
                  - ok
                  - apiVersion
                  - operationId
                  - status
                  - data
                  - warnings
                  - recommendations
                  - links
                properties:
                  ok:
                    type: boolean
                    const: true
                  apiVersion:
                    type: string
                    const: developer_v1
                  operationId:
                    type: string
                    format: uuid
                  status:
                    type: string
                    const: completed
                  warnings:
                    type: array
                    items:
                      type: string
                  recommendations:
                    type: array
                    items:
                      type: string
                  links:
                    type: object
                    additionalProperties:
                      type: string
                  data:
                    type: object
                    additionalProperties: false
                    required:
                      - order
                    properties:
                      order:
                        type: object
                        additionalProperties: true
                        required:
                          - id
                          - externalOrderId
                          - externalOrderNumber
                          - marketplace
                          - status
                          - statusGroup
                          - country
                          - storeId
                          - currency
                          - totalAmount
                          - shippingFee
                          - discountAmount
                          - createdAt
                          - updatedAt
                          - lines
                        properties:
                          id:
                            type: string
                            format: uuid
                          externalOrderId:
                            type: string
                          externalOrderNumber:
                            type:
                              - string
                              - 'null'
                          marketplaceOrderUrl:
                            type:
                              - string
                              - 'null'
                            format: uri
                          marketplace:
                            type: string
                          marketplaceLabel:
                            type: string
                          status:
                            type: string
                            description: Normalized display status for the source order.
                          statusLabel:
                            type: string
                          statusGroup:
                            type: string
                            enum:
                              - to_ship
                              - shipped
                              - completed
                              - pending
                              - return
                              - canceled
                            description: Provider-neutral status for integration logic.
                          country:
                            type:
                              - string
                              - 'null'
                          storeId:
                            type:
                              - string
                              - 'null'
                            description: Exact connected marketplace account ID.
                          storeLabel:
                            type:
                              - string
                              - 'null'
                          buyerName:
                            type:
                              - string
                              - 'null'
                          buyerUserId:
                            type:
                              - string
                              - 'null'
                          buyerUsername:
                            type:
                              - string
                              - 'null'
                          buyerPhone:
                            type:
                              - string
                              - 'null'
                          shippingAddress:
                            type:
                              - object
                              - 'null'
                            additionalProperties: true
                          billingAddress:
                            type:
                              - object
                              - 'null'
                            additionalProperties: true
                          currency:
                            type: string
                          totalAmount:
                            type:
                              - number
                              - 'null'
                          shippingFee:
                            type:
                              - number
                              - 'null'
                          discountAmount:
                            type:
                              - number
                              - 'null'
                          createdAt:
                            type:
                              - string
                              - 'null'
                            format: date-time
                          updatedAt:
                            type:
                              - string
                              - 'null'
                            format: date-time
                          sellerNote:
                            type:
                              - object
                              - 'null'
                            additionalProperties: true
                          lines:
                            type: array
                            items:
                              type: object
                              additionalProperties: true
                              required:
                                - id
                                - externalOrderItemId
                                - name
                                - quantity
                                - status
                                - currency
                                - unitPrice
                                - paidPrice
                                - lineTotal
                                - costPrice
                                - costPriceCurrency
                                - productId
                                - variantId
                              properties:
                                id:
                                  type: string
                                externalOrderItemId:
                                  type:
                                    - string
                                    - 'null'
                                name:
                                  type: string
                                imageUrl:
                                  type:
                                    - string
                                    - 'null'
                                  format: uri
                                quantity:
                                  type: integer
                                  minimum: 0
                                status:
                                  type: string
                                statusLabel:
                                  type: string
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                sellerSku:
                                  type:
                                    - string
                                    - 'null'
                                shopSku:
                                  type:
                                    - string
                                    - 'null'
                                variation:
                                  type:
                                    - string
                                    - 'null'
                                currency:
                                  type: string
                                unitPrice:
                                  type:
                                    - number
                                    - 'null'
                                paidPrice:
                                  type:
                                    - number
                                    - 'null'
                                lineTotal:
                                  type:
                                    - number
                                    - 'null'
                                costPrice:
                                  type:
                                    - number
                                    - 'null'
                                  description: >-
                                    Historical order-line cost snapshot in
                                    costPriceCurrency when available.
                                costPriceCurrency:
                                  type:
                                    - string
                                    - 'null'
                                productId:
                                  type:
                                    - string
                                    - 'null'
                                variantId:
                                  type:
                                    - string
                                    - 'null'
                                productVersionId:
                                  type:
                                    - string
                                    - 'null'
                                productVersionNumber:
                                  type:
                                    - integer
                                    - 'null'
                          cancellationDetails:
                            type:
                              - object
                              - 'null'
                            additionalProperties: true
                          returnCompletion:
                            type:
                              - object
                              - 'null'
                            additionalProperties: true
                          statusHistory:
                            type: array
                            items:
                              type: object
                              additionalProperties: true
                          financeBreakdown:
                            type:
                              - object
                              - 'null'
                            additionalProperties: true
                          settlementProjection:
                            type:
                              - object
                              - 'null'
                            additionalProperties: true
        '400':
          description: Invalid order UUID or organization scope.
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden or missing `orders:read` scope.
        '404':
          description: Order not found for this organization.
        '429':
          description: Rate limit exceeded.
        '500':
          description: Internal server error.
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Bearer API key for server-to-server access. Session auth is also
        supported in first-party UI flows.

````