---
openapi: 3.0.1
info:
  title: The Open Food Network
  description: |-
    This spec is auto generated using the rswag gem. It is incomplete and not yet valid for openapi 3.0.1. Do not publish this. \
    Some endpoints are public and require no authorization; others require authorization. Talk to us to get your credentials set up. \
    Check out our repo! https://github.com/openfoodfoundation/openfoodnetwork
  version: '0.1'
components:
  securitySchemes:
    api_key:
      type: apiKey
      name: X-Spree-Token
      in: header
  schemas:
    Order_Concise:
      type: object
      properties:
        id:
          type: integer
        number:
          type: string
        full_name:
          type: string
        email:
          type: string
        phone:
          type: string
        completed_at:
          type: string
        display_total:
          type: string
        show_path:
          type: string
        edit_path:
          type: string
        state:
          type: string
        payment_state:
          type: string
        shipment_state:
          type: string
        payments_path:
          type: string
        shipments_path:
          type: string
        ship_path:
          type: string
        ready_to_ship:
          type: string
        created_at:
          type: string
        distributor_name:
          type: string
        special_instructions:
          type: string
        payment_capture_path:
          type: string
        distributor:
          type: object
          properties:
            id:
              type: integer
        order_cycle:
          type: object
          properties:
            id:
              type: integer
paths:
  "/api/orders":
    get:
      summary: list orders
      tags:
      - Orders
      parameters:
      - name: X-Spree-Token
        in: header
        type: string
      - name: q[distributor_id_eq]
        in: query
        type: string
        required: false
        description: Query orders for a specific distributor id.
      - name: q[completed_at_gt]
        in: query
        type: string
        required: false
        description: Query orders completed after a date.
      - name: q[completed_at_lt]
        in: query
        type: string
        required: false
        description: Query orders completed before a date.
      - name: q[state_eq]
        in: query
        type: string
        required: false
        description: Query orders by order state, eg 'cart', 'complete'.
      - name: q[payment_state_eq]
        in: query
        type: string
        required: false
        description: Query orders by order payment_state, eg 'balance_due', 'paid',
          'failed'.
      - name: q[email_cont]
        in: query
        type: string
        required: false
        description: Query orders where the order email contains a string.
      - name: q[order_cycle_id_eq]
        in: query
        type: string
        required: false
        description: Query orders for a specific order_cycle id.
      responses:
        '200':
          description: get orders
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/Order_Concise"
servers:
- url: https://staging.katuma.org/api