swagger: '2.0'
info:
  title: Integration API
  version: "1.0.0"
  description: API для интеграции заказов с сервисом goodwix - выгрузка товаров в заказ, резервы, прайс-листы с различными ценами товаров. Перед загрузкой товаров убедитесь в том, что заказ создан в аккаунте goodwix.
  # put the contact info for your development or API team
  # contact:
    # email: you@your-company.com

schemes:
- https

parameters:
  integId:
    in: path
    type: string
    name: integId
    description: интегрированный id заказа
    required: true

paths:
  /orders:
    get:
      summary: Заказы
      produces:
      - application/json
      responses:
        200:
          description: Список заказов
          schema:
            $ref: '#/definitions/IntegrationOrders'
  /orders/{integId}:
    put:
      summary: Обновление заказа
      operationId: updateOrders
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
        - in: path
          name: integId
          required: true
          type: string
        - in: body
          name: body
          schema:
            $ref: '#/definitions/OrderUpdateBody'
      responses:
        200:
          description: Результат успешного запроса
          schema:
            $ref: '#/definitions/MsgSuccess'

definitions:
  MsgSuccess:
    type: object
    properties:
      success:
        type: boolean
        example: true

  IntegrationOrders:
    type: array
    items:
      properties:
        orderId:
          type: string
          format: uuid
          example: fdb8c2f7-d71d-4aa3-3333-6b76de647d35
        status:
          type: string
          example: confirmed
        stockId:
          type: string
          format: uuid
          example: fdb8c2f7-d71d-4aa3-3333-6b76de647d35
        currency:
          type: string
          example: RUB
        customer:
          type: object
          properties:
            customerId:
              type: string
              format: uuid
              example: fdb8c2f7-d71d-4aa3-3333-6b76de647d35
            name:
              type: string
              format: name
            inn:
              type: number
            kpp:
              type: number
        goods: # Заказанные товары
          type: array
          items:
            type: object
            properties:
              goodsId:
                type: string
                format: uuid
                example: fdb8c2f7-d71d-4aa3-3333-6b76de647d35
              quantity:
                type: number
              price:
                type: number
                example: 10000
              tax:
                type: number
              dateOfShipped:
                type: string
                format: date-time

  OrderUpdateBody:
    type: object
    required:
    - status
    - stockId
    - goods
    properties:
      status:
        type: string
        format: name
        example: confirmed
      stockId: # Внешний id склада
        type: string
        format: uuid
        example: fdb8c2f7-d71d-4aa3-3333-6b76de647d35
      goods:
        type: array
        items:
          $ref: '#/definitions/Good'

  Good:
    type: object
    required:
    - goodsId
    - name
    - quantity
    - price
    - tax
    - shipped
    - dateOfShipped
    - canceled
    - canceltionReason
    properties:
      goodsId:
        type: string
        format: uuid
        example: fdb8c2f7-1111-4aa3-1111-6b76de647d35
      name:
        type: string
        format: name
      quantity:
        type: number
        example: 1
      price:
        type: number
        example: 500
      tax: # НДС
        type: number
      shipped:
        type: number
      dateOfShipped:
        type: string
        format: date-time
      canceled:
        type: number
      canceltionReason:
        type: string

# Added by API Auto Mocking Plugin
# host: pub.goodwix.com
# basePath: /api/1c
# Added by API Auto Mocking Plugin
host: virtserver.swaggerhub.com
basePath: /Goodwix5/order_integration/1.0.0