openapi: 3.0.3
info:
  title: 'Flamix: Bitrix24 Inventory API'
  description: 'Flamix: Bitrix24 Inventory API'
  version: 1.0.0
servers:
  -
    url: 'https://inventory-pay.app.flamix.solutions'
paths:
  /api/v1/recalculate:
    get:
      summary: Recalculate
      description: 'Start recalculating. The process can take a very long time. The more income and sales - the longer it will be processed.'
      parameters:
        -
          in: query
          name: 'DOMAIN and api_token'
          description: 'Authentication key.'
          example: '{YOUR_AUTH_KEY}'
          required: true
          schema:
            type: string
            description: 'Authentication key.'
            example: '{YOUR_AUTH_KEY}'
        -
          in: header
          name: Content-Type
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                properties:
                  status:
                    type: string
                    example: success
      tags:
        - Inventory
  '/api/v1/product/{product_id}/{warehouse_id}':
    get:
      summary: 'Product rests'
      description: 'Return general product quantity and warehouse quantity. If you need fresh inventory data, you must first run a forced recalculation.'
      parameters:
        -
          in: query
          name: 'DOMAIN and api_token'
          description: 'Authentication key.'
          example: '{YOUR_AUTH_KEY}'
          required: true
          schema:
            type: string
            description: 'Authentication key.'
            example: '{YOUR_AUTH_KEY}'
        -
          in: header
          name: Content-Type
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: "{\n \"quantity\": 3.0,\n \"warehouse\": [\"1\": 200.0, \"6\": 99.9]\n}"
      tags:
        - Inventory
    parameters:
      -
        in: path
        name: product_id
        description: 'The ID of the product.'
        example: 100
        required: true
        schema:
          type: integer
      -
        in: path
        name: warehouse_id
        description: 'Optional parameter. The ID of the warehouse. Leave empty and it will return all warehouse.'
        required: true
        schema:
          type: integer
        examples:
          omitted:
            summary: 'When the value is omitted'
            value: ''
          present:
            summary: 'When the value is present'
            value: 1
tags:
  -
    name: Inventory
    description: ''
components:
  securitySchemes:
    default:
      type: apiKey
      name: 'DOMAIN and api_token'
      in: query
      description: ''
security:
  -
    default: []