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

# Get order details

> Returns detailed order information including items, fulfillment status, and economics.



## OpenAPI

````yaml api-reference/v1/openapi.yaml get /v1/orders/{id}
openapi: 3.1.0
info:
  title: Goods API
  version: 1.0.0
  description: >-
    API for Goods grocery operations - scanner app, admin dashboard, and
    customer features
  contact:
    name: Goods Team
    url: https://goods.app
servers:
  - url: http://localhost:3000
    description: Local development
  - url: https://dev.api.switchyard.run
    description: Development
  - url: https://api.switchyard.run
    description: Production
security: []
tags:
  - name: v1
    description: API v1 - unified domain-based endpoints
  - name: Scanner
    description: Scanner app endpoints for drivers and pickers
  - name: Sweeps
    description: Sweep management - retail store pickup operations
  - name: RFC Picks
    description: Ready-for-checkout picking operations
  - name: Inventory
    description: Inventory management and barcode lookup
  - name: Admin
    description: Admin dashboard endpoints
  - name: Orders
    description: Order management
  - name: Products
    description: Product catalog management
  - name: Notifications
    description: Push, email, SMS, and Slack notification management
paths:
  /v1/orders/{id}:
    get:
      tags:
        - Orders
      summary: Get order details
      description: >-
        Returns detailed order information including items, fulfillment status,
        and economics.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: id
          in: path
      responses:
        '200':
          description: Order details
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      customer_id:
                        type: string
                        format: uuid
                      order_number:
                        type: string
                      display_id:
                        type: number
                      status:
                        type: string
                      total_amount:
                        type: number
                      payment_status:
                        type: string
                        nullable: true
                      payment_method:
                        type: string
                        nullable: true
                      order_cutoff_time:
                        type: string
                        nullable: true
                      estimated_pickup_time:
                        type: string
                        nullable: true
                      actual_pickup_time:
                        type: string
                        nullable: true
                      location_id:
                        type: string
                        nullable: true
                        format: uuid
                      notes:
                        type: string
                        nullable: true
                      source:
                        type: string
                        nullable: true
                      currency_code:
                        type: string
                        nullable: true
                      email:
                        type: string
                        nullable: true
                      fulfillment_status:
                        type: string
                        nullable: true
                      created_at:
                        type: string
                      updated_at:
                        type: string
                      deleted_at:
                        type: string
                        nullable: true
                      customer:
                        type: object
                        nullable: true
                        properties:
                          id:
                            type: string
                            format: uuid
                          full_name:
                            type: string
                            nullable: true
                          email:
                            type: string
                            nullable: true
                          phone:
                            type: string
                            nullable: true
                        required:
                          - id
                          - full_name
                          - email
                          - phone
                      location:
                        type: object
                        nullable: true
                        properties:
                          id:
                            type: string
                            format: uuid
                          name:
                            type: string
                            nullable: true
                          address_1:
                            type: string
                            nullable: true
                          city:
                            type: string
                            nullable: true
                          state:
                            type: string
                            nullable: true
                          postal_code:
                            type: string
                            nullable: true
                        required:
                          - id
                          - name
                          - address_1
                          - city
                          - state
                          - postal_code
                    required:
                      - id
                      - customer_id
                      - order_number
                      - status
                      - total_amount
                      - payment_status
                      - payment_method
                      - order_cutoff_time
                      - estimated_pickup_time
                      - actual_pickup_time
                      - location_id
                      - notes
                      - source
                      - currency_code
                      - email
                      - fulfillment_status
                      - created_at
                      - updated_at
                      - customer
                      - location
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        order_id:
                          type: string
                          format: uuid
                        sellable_product_id:
                          type: string
                          format: uuid
                        quantity:
                          type: number
                        unit_price:
                          type: number
                        fulfilled_quantity:
                          type: number
                        shipped_quantity:
                          type: number
                        fulfillment_source:
                          type: string
                          nullable: true
                        product:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                              format: uuid
                            name:
                              type: string
                            brand:
                              type: string
                              nullable: true
                            image_url:
                              type: string
                              nullable: true
                          required:
                            - id
                            - name
                            - brand
                            - image_url
                        source:
                          type: string
                          enum:
                            - sweep
                            - inventory
                        picked_quantity:
                          type: number
                        sweep_item:
                          type: object
                          nullable: true
                          properties:
                            sweep_item_id:
                              type: string
                              format: uuid
                            sweep_id:
                              type: string
                              format: uuid
                            picked_quantity:
                              type: number
                            status:
                              type: string
                            sweep:
                              type: object
                              nullable: true
                              properties:
                                id:
                                  type: string
                                  format: uuid
                                sweep_number:
                                  type: string
                                status:
                                  type: string
                                sweep_date:
                                  type: string
                                scheduled_start_time:
                                  type: string
                                  nullable: true
                                retailer_name:
                                  type: string
                                  nullable: true
                                location_name:
                                  type: string
                                  nullable: true
                                total_items:
                                  type: number
                                picked_items:
                                  type: number
                              required:
                                - id
                                - sweep_number
                                - status
                                - sweep_date
                                - scheduled_start_time
                                - retailer_name
                                - location_name
                                - total_items
                                - picked_items
                          required:
                            - sweep_item_id
                            - sweep_id
                            - picked_quantity
                            - status
                            - sweep
                        pick_list_item:
                          type: object
                          nullable: true
                          properties:
                            pick_list_item_id:
                              type: string
                              format: uuid
                            pick_list_id:
                              type: string
                              format: uuid
                            picked_quantity:
                              type: number
                            status:
                              type: string
                            location_code:
                              type: string
                              nullable: true
                            pick_list:
                              type: object
                              nullable: true
                              properties:
                                id:
                                  type: string
                                  format: uuid
                                status:
                                  type: string
                                picker_name:
                                  type: string
                                  nullable: true
                              required:
                                - id
                                - status
                                - picker_name
                          required:
                            - pick_list_item_id
                            - pick_list_id
                            - picked_quantity
                            - status
                            - location_code
                            - pick_list
                        location:
                          type: object
                          nullable: true
                          properties:
                            bag_code:
                              type: string
                            tote_code:
                              type: string
                            cart_label:
                              type: string
                            awaiting:
                              type: string
                      required:
                        - id
                        - order_id
                        - sellable_product_id
                        - quantity
                        - unit_price
                        - fulfilled_quantity
                        - shipped_quantity
                        - fulfillment_source
                        - product
                        - source
                        - picked_quantity
                        - sweep_item
                        - pick_list_item
                        - location
                  fulfillment:
                    type: object
                    properties:
                      bags:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              format: uuid
                            bag_code:
                              type: string
                            order_id:
                              type: string
                              nullable: true
                              format: uuid
                            tote_id:
                              type: string
                              nullable: true
                            status:
                              type: string
                              nullable: true
                          required:
                            - id
                            - bag_code
                            - order_id
                            - tote_id
                            - status
                      totes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            order_id:
                              type: string
                              nullable: true
                              format: uuid
                            status:
                              type: string
                              nullable: true
                          required:
                            - id
                            - order_id
                            - status
                    required:
                      - bags
                      - totes
                  sweeps:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        sweep_number:
                          type: string
                        status:
                          type: string
                        sweep_date:
                          type: string
                        scheduled_start_time:
                          type: string
                          nullable: true
                        retailer_name:
                          type: string
                          nullable: true
                        location_name:
                          type: string
                          nullable: true
                        total_items:
                          type: number
                        picked_items:
                          type: number
                        order_item_count:
                          type: number
                        order_subtotal:
                          type: number
                      required:
                        - id
                        - sweep_number
                        - status
                        - sweep_date
                        - scheduled_start_time
                        - retailer_name
                        - location_name
                        - total_items
                        - picked_items
                        - order_item_count
                        - order_subtotal
                  economics:
                    type: object
                    properties:
                      rfc_items:
                        type: number
                      sweep_items:
                        type: number
                      rfc_subtotal:
                        type: number
                      sweep_subtotal:
                        type: number
                      estimated_rfc_profit:
                        type: number
                      estimated_sweep_profit:
                        type: number
                      total_estimated_profit:
                        type: number
                    required:
                      - rfc_items
                      - sweep_items
                      - rfc_subtotal
                      - sweep_subtotal
                      - estimated_rfc_profit
                      - estimated_sweep_profit
                      - total_estimated_profit
                required:
                  - order
                  - items
                  - fulfillment
                  - sweeps
                  - economics

````