openapi: 3.2.0
info:
  title: Online Store Warehouses API
  version: '1.0'
  description: Online Store API
servers:
- url: https://www.yoursite.com/api/v1
  description: ''
security:
- X-AC-Auth-Token: []
tags:
- name: Warehouses
paths:
  /warehouses:
    get:
      summary: Get Warehouses
      tags:
      - Warehouses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  warehouses:
                    type: array
                    items:
                      $ref: '#/components/schemas/warehouses'
      operationId: get-warehouses
      description: Gets an array of warehouses.
    post:
      summary: Create a Warehouse
      operationId: post-warehouses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/warehouses'
      description: 'Creates a warehouse. '
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: Default Warehouse
                  city: Your City
                  state: Texas
                  country: United States
                  postal_code: '77702'
                  is_default: true
                  email: ''
                  address_line_1: ''
                  address_line_2: ''
                  account_number: ''
                  updated_at: '2019-03-28T11:42:10.227-05:00'
                  created_at: '2019-03-28T11:42:10.227-05:00'
              properties:
                name:
                  type: string
                city:
                  type: string
                state:
                  type: string
                country:
                  type: string
                postal_code:
                  type: string
                is_default:
                  type: boolean
                email:
                  type: string
                address_line_1:
                  type: string
                address_line_2:
                  type: string
                account_number:
                  type: string
              required:
              - name
            examples:
              Example:
                value:
                  name: The Warehouse
                  city: Beaumont
                  state: Texas
                  country: United States
                  postal_code: '77702'
                  is_default: true
                  email: ''
                  address_line_1: ''
                  address_line_2: ''
                  account_number: ''
      tags:
      - Warehouses
  /warehouses/{id}:
    parameters:
    - schema:
        type: integer
      name: id
      in: path
      required: true
      description: The ID of the `warehouse`
    put:
      summary: Update a Warehouse
      operationId: put-warehouses-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/warehouses'
      tags:
      - Warehouses
      description: Updates a warehouse.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/warehouses'
            examples:
              Example:
                value:
                  name: The Warehouse
                  city: Beaumont
                  state: Texas
                  country: United States
                  postal_code: '77702'
                  is_default: true
                  email: ''
                  address_line_1: ''
                  address_line_2: ''
                  account_number: ''
    delete:
      summary: Delete a Warehouse
      operationId: delete-warehouses-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
      - Warehouses
      description: Deletes a warehouse.
components:
  responses:
    '404':
      description: Resource Not Found
      content:
        application/json:
          schema:
            description: Not Found
            type: object
            x-examples:
              example-1:
                status_code: 404
                message: Not Found
                details: No resource found
            properties:
              status_code:
                type: number
              message:
                type: string
              details:
                type: string
          examples: {}
      headers: {}
  schemas:
    warehouses:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        city:
          type: string
        state:
          type: string
        country:
          type: string
        postal_code:
          type: string
        is_default:
          type: boolean
        email:
          type: string
        address_line_1:
          type: string
        address_line_2:
          type: string
        account_number:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
  securitySchemes:
    X-AC-Auth-Token:
      name: X-AC-Auth-Token
      type: apiKey
      in: header