Medusa Orders API

openapi: 3.1.0
info:
  title: Medusa Store Auth Orders API
  version: '2'
  description: 'Medusa Store API - the public REST surface consumed by storefronts and

    end-customer clients of a Medusa commerce application. Provides carts,

    products, collections, categories, regions, customers, orders, payments,

    shipping, returns, and gift cards. Requests are scoped by sales channel

    using a publishable API key passed in the x-publishable-api-key header.

    Customer-scoped requests use a JWT bearer token or a cookie session.

    '
  contact:
    name: Medusa Docs - Store API
    url: https://docs.medusajs.com/api/store
servers:
- url: '{medusaApplicationUrl}'
  description: Your Medusa application
  variables:
    medusaApplicationUrl:
      default: http://localhost:9000
      description: Base URL of your Medusa server (no trailing slash)
security:
- publishableApiKey: []
  bearerAuth: []
- publishableApiKey: []
  cookieAuth: []
tags:
- name: Orders
paths:
  /store/orders:
    get:
      tags:
      - Orders
      summary: List the authenticated customer's orders
      security:
      - publishableApiKey: []
        bearerAuth: []
      responses:
        '200':
          description: Orders
          content:
            application/json:
              schema:
                type: object
                properties:
                  orders:
                    type: array
                    items:
                      $ref: '#/components/schemas/Order'
  /store/orders/{id}:
    get:
      tags:
      - Orders
      summary: Get an order
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Order
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    $ref: '#/components/schemas/Order'
components:
  schemas:
    Order:
      type: object
      properties:
        id:
          type: string
        display_id:
          type: integer
        status:
          type: string
        email:
          type: string
        total:
          type: number
        currency_code:
          type: string
  securitySchemes:
    publishableApiKey:
      type: apiKey
      in: header
      name: x-publishable-api-key
      description: Publishable API key that scopes requests to one or more sales channels.
    bearerAuth:
      type: http
      scheme: bearer
      description: JWT bearer token obtained via /auth/customer/{auth_provider}.
    cookieAuth:
      type: apiKey
      in: cookie
      name: connect.sid