openapi: 3.0.3
info:
  title: 'Dotcon API'
  description: ''
  version: 1.0.0
servers:
  -
    url: 'https://api.dotcon.io'
paths:
  /api/v1/allegro-new-orders:
    get:
      summary: 'Getting new orders'
      description: "This method returns all Allegro new orders and \"request_id\". We recommend that you save\n\"request_id\" and send it back to us using the \"confirm-orders” method. This will confirm\nthat you have received the orders and you will not receive the same orders again.\n\nPlease note, that order_id field is unique in Allegro (for same merchant), if you get\nsame order_id - this means there is no new order, but changes in same order.\n\nIn this link you can check example of a complete order:\n<a href=\"https://api.dotcon.io/allegro-order-example\" target=\"_blank\">Link to example</a>"
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'there are no new orders'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n []\n}"
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - 'Allegro orders management'
  /api/v1/allegro-not-fulfilled-orders:
    get:
      summary: 'Getting not fulfilled orders'
      description: 'This method returns all not fulfilled orders.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'there are no not fulfilled orders'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n []\n}"
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - 'Allegro orders management'
  '/api/v1/allegro-order/{order_id}':
    get:
      summary: 'Getting order'
      description: 'This method returns the order by order_id.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'is no order with provided order id'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n []\n}"
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
        422:
          description: 'given data was invalid'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'The given data was invalid.'
                  errors:
                    order_id:
                      - 'The order id format is invalid.'
                properties:
                  message:
                    type: string
                    example: 'The given data was invalid.'
                  errors:
                    type: object
                    example:
                      order_id:
                        - 'The order id format is invalid.'
      tags:
        - 'Allegro orders management'
    parameters:
      -
        in: path
        name: order_id
        description: 'The id of the order is required.'
        example: 12345678-a123-12ab-1234-123456789abc
        required: true
        schema:
          type: string
  /api/v1/allegro-confirm-orders:
    put:
      summary: 'Confirmation of receiving new orders'
      description: "This method confirms you received the orders. You need to send us\nthe \"request_id\", which you received after using the method \"allegro-new-orders\".\nIt will confirm you received the orders, and you will\nnot receive the same orders again next time."
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'the selected request id already confirmed or does not exist'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n []\n}"
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
        422:
          description: 'request_id was incorrect'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'The given data was invalid.'
                  errors: 'Provided request_id was incorrect'
                properties:
                  message:
                    type: string
                    example: 'The given data was invalid.'
                  errors:
                    type: string
                    example: 'Provided request_id was incorrect'
      tags:
        - 'Allegro orders management'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                request_id:
                  type: string
                  description: 'Must be "request_id" that was provided in "allegro-new-orders" response. "request_id" is required and must be between 1 and 10 digits.'
                  example: '1234'
              required:
                - request_id
  /api/v1/allegro-send-order-tracking:
    put:
      summary: 'Sending orders tracking information'
      description: 'By this method, you can fill in and share the order tracking information.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: success
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'Tracking information received successfully.'
                properties:
                  message:
                    type: string
                    example: 'Tracking information received successfully.'
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
        422:
          description: 'already exist'
          content:
            application/json:
              schema:
                type: object
                example:
                  errors: 'Order already fulfilled.'
                properties:
                  errors:
                    type: string
                    example: 'Order already fulfilled.'
      tags:
        - 'Allegro orders management'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                order_id:
                  type: string
                  description: 'The order_id is required.'
                  example: 12345678-a123-12ab-1234-123456789abc
                shipment_carrier:
                  type: string
                  description: 'The shipment_carrier is required.'
                  example: Name
                tracking:
                  type: string
                  description: 'The tracking is required.'
                  example: '123456789'
                shipping_from_warehouse:
                  type: string
                  description: 'The shipping_from_warehouse is optional.'
                  example: ABC
              required:
                - order_id
                - shipment_carrier
                - tracking
  '/api/v1/allegro-orders/{year}/{month}/{day}':
    get:
      summary: 'Getting orders by date'
      description: "This method returns all Allegro orders\nfor the selected year and month.\nIt is not possible to receive information older than 2 years."
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'there are no orders for this date'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n []\n}"
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
        422:
          description: 'invalid day'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'The given data was invalid.'
                  errors:
                    day:
                      - 'The day must be between 1 and 31.'
                properties:
                  message:
                    type: string
                    example: 'The given data was invalid.'
                  errors:
                    type: object
                    example:
                      day:
                        - 'The day must be between 1 and 31.'
      tags:
        - 'Allegro orders management'
    parameters:
      -
        in: path
        name: year
        description: 'Year is required and will return orders for the selected year.'
        example: 2022
        required: true
        schema:
          type: integer
      -
        in: path
        name: month
        description: 'Month is required and will return orders for the selected month.'
        example: 1
        required: true
        schema:
          type: integer
      -
        in: path
        name: day
        description: 'Optional parameter. optional Day is optional and will return orders for the selected day of the given month and year.'
        required: true
        schema:
          type: integer
        examples:
          omitted:
            summary: 'When the value is omitted'
            value: ''
          present:
            summary: 'When the value is present'
            value: 7
  /api/v1/upload-feed:
    post:
      summary: 'Uploading files'
      description: "When uploading a file, we recommend saving the\n\"file-id\". The \"file-id\" will be\nrequired using the method \"file-status\" to request\nthe report of the upload status and errors.\nThe value of the \"name\" should be \"Stock\" or \"Product\". The \"content\" must be an information from CSV file in a form of string.\nWe recommend using \"file_get_contents\" or \"fopen\" functions in PHP and equivalents in other programming languages.\nAdditionally, the \"filename\" parameter in the multipart request is recommended to preserve the original file name.\n\nIn this link, you can check how we recommend using this method in PHP programming language:\n<a href=\"https://api.dotcon.io/UploadFeed_php.txt\" target=\"_blank\">Link to example</a>\n\nIn this link, you can check the detailed file specification in Lithuanian language:\n<a href=\"https://api.dotcon.io/Dotcon feed formats v3_5 LT.pdf\" target=\"_blank\">Link to specification</a>\n\nIn this link, you can check the detailed file specification in English language:\n<a href=\"https://api.dotcon.io/Dotcon feed formats v3_5 EN.pdf\" target=\"_blank\">Link to specification</a>"
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          in: header
          name: Content-Type
          description: ''
          example: multipart/form-data
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
      responses:
        200:
          description: success
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'File saved successfully.'
                  file_id: 123
                properties:
                  message:
                    type: string
                    example: 'File saved successfully.'
                  file_id:
                    type: integer
                    example: 123
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
        422:
          description: 'incorrect file format'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'Incorrect file format.'
                properties:
                  message:
                    type: string
                    example: 'Incorrect file format.'
      tags:
        - 'Assortment/Stock management'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                Stock:
                  type: string
                  format: binary
                  description: 'File name should be Stock or Product. Include "filename" in the multipart request.'
              required:
                - Stock
  '/api/v1/file-status/{id}':
    get:
      summary: 'Checking file status'
      description: "We recommend checking the status of the file not often than hourly. The final status is \"Done\". Any other status indicates\nthat the upload or processing is not yet completed. All\nprocessing status options and errors are in the \"Example request\" section on the right."
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: success
          content:
            application/json:
              schema:
                type: object
                example:
                  file_type: Products
                  status: 'File saved successfully'
                  created_at: '2022-01-13T12:35:23.000000Z'
                  updated_at: '2022-01-13T12:35:23.000000Z'
                properties:
                  file_type:
                    type: string
                    example: Products
                  status:
                    type: string
                    example: 'File saved successfully'
                  created_at:
                    type: string
                    example: '2022-01-13T12:35:23.000000Z'
                  updated_at:
                    type: string
                    example: '2022-01-13T12:35:23.000000Z'
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
        404:
          description: 'id does not exist'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'File with this id does not exist.'
                properties:
                  message:
                    type: string
                    example: 'File with this id does not exist.'
      tags:
        - 'Assortment/Stock management'
    parameters:
      -
        in: path
        name: id
        description: 'The "file_id" that was provided in "upload-feed" response.'
        example: 123
        required: true
        schema:
          type: integer
  /api/v1/login:
    post:
      summary: Login
      description: "This method returns authentication token.\nThe token will expire after 60 minutes.\n\nBefore trying to login for the first time, you must change your password, you can do this by clicking this link:\n\n<a href=\"https://api.dotcon.io/change-password\" target=\"_blank\">Link to change password</a>"
      parameters:
        -
          in: header
          name: Content-Type
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
      responses:
        201:
          description: success
          content:
            application/json:
              schema:
                type: object
                example:
                  user: Name
                  token: 264|C1HGT4kiOvEeGkUiqQBJfWXiNfmFLoiFgYmkNo7O
                properties:
                  user:
                    type: string
                    example: Name
                  token:
                    type: string
                    example: 264|C1HGT4kiOvEeGkUiqQBJfWXiNfmFLoiFgYmkNo7O
        422:
          description: 'name is missing'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n\"message\": \"The given data was invalid.\"\n\"errors\": {\n \"name\": [\n     \"The name must be a string.\",\n     \"A name is required\"\n  ]\n}\n}"
        401:
          description: 'wrong password'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'Bad credentials'
                properties:
                  message:
                    type: string
                    example: 'Bad credentials'
      tags:
        - 'Authentication management'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'The name of the user is required.'
                  example: john_smith
                password:
                  type: string
                  description: 'Password is required and must be changed before trying to login first time.'
                  example: SecretPwd123!@x
              required:
                - name
                - password
      security: []
  /api/v1/logout:
    post:
      summary: Logout
      description: ''
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          in: header
          name: Content-Type
          description: ''
          example: application/json
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
      responses:
        201:
          description: success
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'logged out'
                properties:
                  message:
                    type: string
                    example: 'logged out'
        422:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - 'Authentication management'
  '/api/v1/{platform}/upload-vat-invoice':
    post:
      summary: 'Uploading VAT Invoice'
      description: "Upload a VAT invoice file for a specific order.\n\nCurrently, only the \"allegro\" platform is supported.\nEach order can have only one VAT invoice.\nOnly PDF files are accepted.\nThe file cannot be empty.\nThe order must exist in the system.\nIf a VAT invoice for the order already exists, the upload will be rejected.\n\nThe key-value pairs of the first associative array should look like this:\n\n'name' => 'order_id', (order_id is a string).\n\n'contents' => '31e88c80-a380-11ef-aaa8-ad165b9e76d3', (unique id of order whose VAT Invoice file you will send).\n\n The key-value pairs of the second associative array should look like this:\n\n'name' => 'invoice_number', (invoice_number is a string).\n\n'contents' => 'AB-AB-ABC-1234-1234567', (unique invoice number).\n\nThe key-value pairs of the third associative array should look like this:\n\n'name' => 'vat_invoice', (vat_invoice is a string).\n\n'contents' => fopen($pdfFilePath, 'r'), (content of VAT Invoice file in pdf format).\n\n'filename' => basename($pdfFilePath), (provided name of the file).\n\nIn this link you can check how we recommend using this method in PHP programming language:\n<a href=\"https://api.dotcon.io/UploadInvoice_php.txt\" target=\"_blank\">Link to example</a>"
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          in: header
          name: Content-Type
          description: ''
          example: multipart/form-data
          schema:
            type: string
        -
          in: header
          name: Accept
          description: ''
          example: application/json
          schema:
            type: string
      responses:
        200:
          description: success
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'File saved successfully.'
                properties:
                  message:
                    type: string
                    example: 'File saved successfully.'
        401:
          description: unauthenticated
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
        422:
          description: 'duplicate upload'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'VAT invoice for order 123-4567890-9876543 has already been uploaded.'
                properties:
                  message:
                    type: string
                    example: 'VAT invoice for order 123-4567890-9876543 has already been uploaded.'
      tags:
        - 'File upload management'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                order_id:
                  type: string
                  description: 'The ID of the order.'
                  example: 31e88c80-a380-11ef-aaa8-ad165b9e76d3
                invoice_number:
                  type: string
                  description: 'The VAT invoice number (5–40 characters).'
                  example: AB-AB-ABC-1234-1234567
                vat_invoice:
                  type: string
                  format: binary
                  description: vat_invoice.pdf
              required:
                - order_id
                - invoice_number
                - vat_invoice
    parameters:
      -
        in: path
        name: platform
        description: 'Currently, only the "allegro" platform is supported. Allowed values: "allegro".'
        example: allegro
        required: true
        schema:
          type: string
  /api/v1/new-orders:
    get:
      summary: 'Getting new orders'
      description: "This method returns all new orders and \"request_id\". We recommend that you save\n\"request_id\" and send it back to us using the \"confirm-orders” method. This will confirm\nthat you have received the orders and you will not receive the same orders again.\n\nPlease note, that order_id field is unique in Amazon (for same merchant), if you get\nsame order_id - this means there is no new order, but changes in same order.\nFor example, if customer requested cancelation, then you will receive this order update\nalong with all new orders, and \"is_buyer_requested_cancelation\" field will be set to \"TRUE\".\n\nIn this link you can check example of a complete order:\n<a href=\"https://api.dotcon.io/order-example\" target=\"_blank\">Link to example</a>"
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'there are no new orders'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n []\n}"
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - 'Orders management'
  '/api/v1/order/{order_id}':
    get:
      summary: 'Getting order'
      description: 'This method returns the order by order_id.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'is no order with provided order id'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n []\n}"
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
        422:
          description: 'given data was invalid'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'The given data was invalid.'
                  errors:
                    order_id:
                      - 'The order id format is invalid.'
                properties:
                  message:
                    type: string
                    example: 'The given data was invalid.'
                  errors:
                    type: object
                    example:
                      order_id:
                        - 'The order id format is invalid.'
      tags:
        - 'Orders management'
    parameters:
      -
        in: path
        name: order_id
        description: 'The id of the order is required.'
        example: 123-1234567-1234567
        required: true
        schema:
          type: string
  /api/v1/confirm-orders:
    put:
      summary: 'Confirmation of receiving new orders'
      description: "This method confirms you received the orders. You need to send us\nthe \"request_id\", which you received after using the method \"new-orders\".\nIt will confirm you received the orders, and you will\nnot receive the same orders again next time."
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'the selected request id already confirmed or does not exist'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n []\n}"
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
        422:
          description: 'request_id was incorrect'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'The given data was invalid.'
                  errors: 'Provided request_id was incorrect'
                properties:
                  message:
                    type: string
                    example: 'The given data was invalid.'
                  errors:
                    type: string
                    example: 'Provided request_id was incorrect'
      tags:
        - 'Orders management'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                request_id:
                  type: string
                  description: 'Must be "request_id" that was provided in "new-orders" response. "request_id" is required and must be between 1 and 10 digits.'
                  example: '1234'
              required:
                - request_id
  /api/v1/send-order-tracking:
    put:
      summary: 'Sending orders tracking information'
      description: 'By this method, you can fill in and share the order tracking information.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: success
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'Tracking information received successfully.'
                properties:
                  message:
                    type: string
                    example: 'Tracking information received successfully.'
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
        422:
          description: 'already exist'
          content:
            application/json:
              schema:
                type: object
                example:
                  errors: 'Order already fulfilled.'
                properties:
                  errors:
                    type: string
                    example: 'Order already fulfilled.'
      tags:
        - 'Orders management'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                order_id:
                  type: string
                  description: 'The order_id is required.'
                  example: 123-1234567-1234567
                shipment_carrier:
                  type: string
                  description: 'The shipment_carrier is required.'
                  example: Name
                tracking:
                  type: string
                  description: 'The tracking is required.'
                  example: '123456789'
                shipping_from_warehouse:
                  type: string
                  description: 'The shipping_from_warehouse is optional.'
                  example: ABC
              required:
                - order_id
                - shipment_carrier
                - tracking
  /api/v1/not-fulfilled-orders:
    get:
      summary: 'Getting not fulfilled orders'
      description: 'This method returns all not fulfilled orders.'
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'there are no not fulfilled orders'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n []\n}"
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - 'Orders management'
  '/api/v1/orders/{year}/{month}/{day}':
    get:
      summary: 'Getting orders by date'
      description: "This method returns all orders\nfor the selected year and month.\nIt is not possible to receive information older than 2 years.\nAccording to Amazon's data retention policy, orders older than 30 days will not contain personally identifiable information."
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'there are no orders for this date'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n []\n}"
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
        422:
          description: 'invalid day'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'The given data was invalid.'
                  errors:
                    day:
                      - 'The day must be between 1 and 31.'
                properties:
                  message:
                    type: string
                    example: 'The given data was invalid.'
                  errors:
                    type: object
                    example:
                      day:
                        - 'The day must be between 1 and 31.'
      tags:
        - 'Orders management'
    parameters:
      -
        in: path
        name: year
        description: 'Year is required and will return orders for the selected year.'
        example: 2022
        required: true
        schema:
          type: integer
      -
        in: path
        name: month
        description: 'Month is required and will return orders for the selected month.'
        example: 1
        required: true
        schema:
          type: integer
      -
        in: path
        name: day
        description: 'Optional parameter. optional Day is optional and will return orders for the selected day of the given month and year.'
        required: true
        schema:
          type: integer
        examples:
          omitted:
            summary: 'When the value is omitted'
            value: ''
          present:
            summary: 'When the value is present'
            value: 7
  '/api/v1/report-request/{report_type}':
    get:
      summary: 'Getting report'
      description: "This method retrieves information of latest available report for the specified report type.\nCurrently, the supported report type is FBA_MYI_UNSUPPRESSED_INVENTORY_DATA.\nThe response includes report information in JSON format, including the report filename and its timestamp."
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'is no report with provided report_type'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n []\n}"
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
        422:
          description: 'given data was invalid'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'The given data was invalid.'
                  errors:
                    report_type:
                      - 'The provided report type is invalid.'
                properties:
                  message:
                    type: string
                    example: 'The given data was invalid.'
                  errors:
                    type: object
                    example:
                      report_type:
                        - 'The provided report type is invalid.'
      tags:
        - 'Reports management'
    parameters:
      -
        in: path
        name: report_type
        description: 'The report_type is required.'
        example: FBA_MYI_UNSUPPRESSED_INVENTORY_DATA
        required: true
        schema:
          type: string
  /api/v1/amazon-dimensions-data:
    get:
      summary: 'Getting Amazon dimensions'
      description: "This method returns the dimensions of active Amazon products.\nThe response includes the SKU and item dimensions such as weight,\nheight, length, and width. All dimensions are returned in kilograms and meters.\n\nOnly active products are included in the report.\nIf no active products are found, a corresponding error message will be returned.\nThe information is returned in JSON format."
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: success
          content:
            application/json:
              schema:
                type: object
                example:
                  count: 2
                  data:
                    -
                      sku: ABC123
                      weight: 1.25
                      height: 0.12
                      length: 0.34
                      width: 0.18
                    -
                      sku: DEF456
                      weight: 0.8
                      height: 0.1
                      length: 0.25
                      width: 0.15
                properties:
                  count:
                    type: integer
                    example: 2
                  data:
                    type: array
                    example:
                      -
                        sku: ABC123
                        weight: 1.25
                        height: 0.12
                        length: 0.34
                        width: 0.18
                      -
                        sku: DEF456
                        weight: 0.8
                        height: 0.1
                        length: 0.25
                        width: 0.15
                    items:
                      type: object
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
        404:
          description: 'no active products found'
          content:
            application/json:
              schema:
                type: object
                example:
                  error: 'No active products found'
                properties:
                  error:
                    type: string
                    example: 'No active products found'
      tags:
        - 'Reports management'
  /api/v1/shipment-data:
    post:
      summary: 'Sending shipments information'
      description: "This method allows you to send shipment information for given orders.\n\nEach order must contain at least one shipment. Currently supported platform: \"allegro\".\n\nPlease note:\n- If the order already has a shipment, it will be skipped.\n- If at least one shipment is saved successfully, response will reflect both saved and skipped orders.\n- If all shipments already exist, response will return only skipped orders.\n- Shipment weight must be provided in kilograms.\n- Shipment height, width, and length must be provided in centimeters."
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'no shipments saved'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'No shipments were saved. Shipments already exist for all provided orders.'
                  skipped_orders:
                    - d94aee70-7e52-11f0-afc4-5debbe59dc7d
                properties:
                  message:
                    type: string
                    example: 'No shipments were saved. Shipments already exist for all provided orders.'
                  skipped_orders:
                    type: array
                    example:
                      - d94aee70-7e52-11f0-afc4-5debbe59dc7d
                    items:
                      type: string
        422:
          description: 'invalid data'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'The given data was invalid.'
                  errors:
                    orders.0.shipments.0.type:
                      - 'The selected type is invalid. Allowed values: PDF_A4, PDF_A6, ZPL.'
                    orders.0.shipments.0.weight:
                      - 'Shipment weight is required.'
                    orders.0.shipments.0.platform:
                      - 'Platform must be either "allegro".'
                properties:
                  message:
                    type: string
                    example: 'The given data was invalid.'
                  errors:
                    type: object
                    example:
                      orders.0.shipments.0.type:
                        - 'The selected type is invalid. Allowed values: PDF_A4, PDF_A6, ZPL.'
                      orders.0.shipments.0.weight:
                        - 'Shipment weight is required.'
                      orders.0.shipments.0.platform:
                        - 'Platform must be either "allegro".'
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - 'Shipments management'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                orders:
                  type: array
                  description: 'List of orders with shipments.'
                  example:
                    - alias
                  items:
                    type: string
              required:
                - orders
  '/api/v1/shipment-label/{platform}/{order_id}':
    get:
      summary: 'Getting shipment label'
      description: "This method allows you to retrieve the shipment labels for a given order.\nCurrently, only the \"allegro\" platform is supported.\n\nPlease note:\n- Label filenames correspond to the order ID. If an order has multiple shipment labels, each file will have a suffix \"_1\", \"_2\", etc.\n- Label files can be in PDF or ZPL format.\n- Each shipment will be paired with its corresponding label file(s)."
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                example:
                  -
                    carrier: ALLEGRO
                    tracking_number: AD0000K0B6
                    file:
                      filename: d94aee70-7e52-11f0-afc4-5debbe59dc7d_1.pdf
                      content: JVBERi0xLjQKJeLjz9MKM...
                  -
                    carrier: ALLEGRO
                    tracking_number: AD0000K0A8
                    file:
                      filename: d94aee70-7e52-11f0-afc4-5debbe59dc7d_2.zpl
                      content: XlhBDQpeQ0kyOA0KXkZP...
        404:
          description: 'no shipments found'
          content:
            application/json:
              schema:
                type: object
                example:
                  error: 'No shipments found for order'
                properties:
                  error:
                    type: string
                    example: 'No shipments found for order'
      tags:
        - 'Shipments management'
    parameters:
      -
        in: path
        name: platform
        description: 'Shipment platform. Only "allegro" is supported.'
        example: allegro
        required: true
        schema:
          type: string
      -
        in: path
        name: order_id
        description: 'The ID of the order to fetch labels for.'
        example: d94aee70-7e52-11f0-afc4-5debbe59dc7d
        required: true
        schema:
          type: string
  '/api/v1/{platform}/confirm-orders-ready-for-pickup':
    post:
      summary: 'Confirm orders are ready for pickup'
      description: "This method allows merchants to confirm that selected orders are ready for courier pickup.\n\nNotes:\n- Only orders with shipments that have a status allowing pickup confirmation can be confirmed.\n- If a shipment is already marked as ready for pickup, it will be listed in `already_confirmed_orders`.\n- Orders that cannot be confirmed (e.g., shipment not yet ready) will be listed in `cannot_confirm_orders`.\n- Orders not found in the system will be listed in `not_found_orders`.\n- Pickup scheduling logic:\n  - When this request is received, the system will first try to schedule a courier for the next day between 12:00 and 17:00.\n  - If the next day is Friday or Saturday, the system will look for a courier on Monday instead.\n  - If no suitable pickup time is available for that day, the system will take the first available proposal on the following working day, with hours between 08:00 and 17:00."
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: success
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'Pickup readiness confirmation processed.'
                  confirmed_orders:
                    - d94aee70-7e52-11f0-afc4-5debbe59dc7d
                  already_confirmed_orders:
                    - d94aee70-7e52-11f0-afc4-5debbe59dc7e
                  cannot_confirm_orders:
                    - d94aee70-7e52-11f0-afc4-5debbe59dc7f
                  not_found_orders:
                    - d94aee70-7e52-11f0-afc4-5debbe59dc80
                properties:
                  message:
                    type: string
                    example: 'Pickup readiness confirmation processed.'
                  confirmed_orders:
                    type: array
                    example:
                      - d94aee70-7e52-11f0-afc4-5debbe59dc7d
                    items:
                      type: string
                  already_confirmed_orders:
                    type: array
                    example:
                      - d94aee70-7e52-11f0-afc4-5debbe59dc7e
                    items:
                      type: string
                  cannot_confirm_orders:
                    type: array
                    example:
                      - d94aee70-7e52-11f0-afc4-5debbe59dc7f
                    items:
                      type: string
                  not_found_orders:
                    type: array
                    example:
                      - d94aee70-7e52-11f0-afc4-5debbe59dc80
                    items:
                      type: string
        422:
          description: 'unknown platform'
          content:
            application/json:
              schema:
                type: object
                example:
                  error: 'Unknown platform: xyz'
                properties:
                  error:
                    type: string
                    example: 'Unknown platform: xyz'
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - 'Shipments management'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                orders:
                  type: array
                  description: 'List of order IDs to confirm for pickup.'
                  example:
                    - d94aee70-7e52-11f0-afc4-5debbe59dc7d
                    - d94aee70-7e52-11f0-afc4-5debbe59dc7e
                  items:
                    type: string
              required:
                - orders
    parameters:
      -
        in: path
        name: platform
        description: 'The platform of the order. Allowed values: "allegro".'
        example: allegro
        required: true
        schema:
          type: string
  /api/v1/performances:
    get:
      summary: 'Getting performances data'
      description: "This method returns performance information for a specific date and optionally for the past N days. If no parameters\nare provided, the data for today will be returned.\n\nThe behavior depends on the query parameters provided:\n- If no parameters are provided, data for today will be returned.\n- If only `days_back` is provided, data for today and the previous N-1 days will be returned.\n  Example: `days_back=3` on 2025-10-23 returns data for 2025-10-21, 2025-10-22, and 2025-10-23.\n- If both `date` and `days_back` are provided, data will start from `date - (days_back-1)` up to `date`.\n  Example: `date=2025-10-23&days_back=3` returns data for 2025-10-21, 2025-10-22, and 2025-10-23."
      parameters:
        -
          in: query
          name: date
          description: 'optional Date in format YYYY-MM-DD. Returns data for this date.'
          example: '2025-10-23'
          required: false
          schema:
            type: string
            description: 'optional Date in format YYYY-MM-DD. Returns data for this date.'
            example: '2025-10-23'
        -
          in: query
          name: days_back
          description: 'optional Number of days back to include, counting from the given date (or today if date is not provided). Minimum is 1.'
          example: 3
          required: false
          schema:
            type: integer
            description: 'optional Number of days back to include, counting from the given date (or today if date is not provided). Minimum is 1.'
            example: 3
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: success
          content:
            application/json:
              schema:
                type: object
                example:
                  start_date: '2025-10-21'
                  end_date: '2025-10-23'
                  data: '[{"2025-10-21":{...}}, {"2025-10-22":{...}}, {"2025-10-23":{...}}]'
                properties:
                  start_date:
                    type: string
                    example: '2025-10-21'
                  end_date:
                    type: string
                    example: '2025-10-23'
                  data:
                    type: string
                    example: '[{"2025-10-21":{...}}, {"2025-10-22":{...}}, {"2025-10-23":{...}}]'
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
        422:
          description: 'invalid days_back'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'The given data was invalid.'
                  errors:
                    days_back:
                      - 'The days_back must be a numeric value greater than or equal to 0.'
                properties:
                  message:
                    type: string
                    example: 'The given data was invalid.'
                  errors:
                    type: object
                    example:
                      days_back:
                        - 'The days_back must be a numeric value greater than or equal to 0.'
      tags:
        - 'Statistics management'
  /api/v1/restore-test-orders:
    patch:
      summary: 'Restore test orders'
      description: "When testing orders, the status of the orders is changing.\nThis method restores all test orders to the status \"new\".\nThis method can be accessed only by \"Test\" user."
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'orders restored successfully'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n []\n}"
        422:
          description: 'incorrect user'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'Incorrect user.'
                properties:
                  message:
                    type: string
                    example: 'Incorrect user.'
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - 'Test data management'
  /api/v1/restore-test-vat-calculations-data:
    patch:
      summary: 'Restore VAT calculations data'
      description: "When testing VAT calculations data, the status of the VAT calculations data is changing.\nThis method restores all test VAT calculations data to the status \"new\".\nThis method can be accessed only by \"Test\" user."
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'VAT calculations data restored successfully'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n []\n}"
        422:
          description: 'incorrect user'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'Incorrect user.'
                properties:
                  message:
                    type: string
                    example: 'Incorrect user.'
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - 'Test data management'
  /api/v1/allegro-restore-test-orders:
    patch:
      summary: 'Restore Allegro test orders'
      description: "When testing orders, the status of the orders is changing.\nThis method restores all test orders to the status \"new\".\nThis method can be accessed only by \"Test\" user."
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'orders restored successfully'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n []\n}"
        422:
          description: 'incorrect user'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'Incorrect user.'
                properties:
                  message:
                    type: string
                    example: 'Incorrect user.'
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - 'Test data management'
  /api/v1/new-vat-calculations-data:
    get:
      summary: 'Getting new VAT calculations data'
      description: "This method returns all new VAT calculations data and \"request_id\". We recommend\nsaving \"request_id\" and sending it back to us using the method\n\"confirm-vat-calculations-data”. It will confirm you received the VAT calculations data, and you\nwill not receive the same VAT calculations data again next time.\n\nThe field \"buyer_company_name\" will be empty for new VAT calculation data.\nThis field will be filed later and information will be available through the method \"Getting VAT calculations data by date\".\n\nIn this link you can check full example of VAT calculation data:\n<a href=\"https://api.dotcon.io/vat-calculation-data-example\" target=\"_blank\">Link to example</a>"
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'there are no new VAT calculations data'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n []\n}"
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - 'VAT calculations data management'
  /api/v1/confirm-vat-calculations-data:
    put:
      summary: 'Confirmation of receiving new VAT calculations data'
      description: "This method confirms you received the VAT calculations data. You need to send us\nthe \"request_id\", which you received after using the method \"new-vat-calculations-data\".\nIt will confirm you received the data, and you will\nnot receive the same VAT calculations data again next time."
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'the selected request id already confirmed or does not exist'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n []\n}"
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
        422:
          description: 'request_id was incorrect'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'The given data was invalid.'
                  errors: 'Provided request_id was incorrect'
                properties:
                  message:
                    type: string
                    example: 'The given data was invalid.'
                  errors:
                    type: string
                    example: 'Provided request_id was incorrect'
      tags:
        - 'VAT calculations data management'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                request_id:
                  type: string
                  description: 'Must be "request_id" that was provided in "new-vat-calculations-data" response. "request_id" is required and must be between 1 and 10 digits.'
                  example: '1234'
              required:
                - request_id
  '/api/v1/vat-calculations-data/{year}/{month}/{day}':
    get:
      summary: 'Getting VAT calculations data by date'
      description: "This method returns all VAT calculations data\nfor the selected year and month.\nIt is not possible to receive information older than 2 years."
      parameters:
        -
          in: header
          name: Authorization
          description: ''
          example: 'Bearer {YOUR_AUTH_KEY}'
          schema:
            type: string
        -
          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: 'there are no VAT calculations data for this date'
          content:
            text/plain:
              schema:
                type: string
                example: "{\n []\n}"
        401:
          description: 'wrong token'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
        422:
          description: 'invalid day'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'The given data was invalid.'
                  errors:
                    day:
                      - 'The day must be between 1 and 31.'
                properties:
                  message:
                    type: string
                    example: 'The given data was invalid.'
                  errors:
                    type: object
                    example:
                      day:
                        - 'The day must be between 1 and 31.'
      tags:
        - 'VAT calculations data management'
    parameters:
      -
        in: path
        name: year
        description: 'Year is required and will return VAT calculations data for the selected year.'
        example: 2022
        required: true
        schema:
          type: integer
      -
        in: path
        name: month
        description: 'Month is required and will return VAT calculations data for the selected month.'
        example: 1
        required: true
        schema:
          type: integer
      -
        in: path
        name: day
        description: 'Optional parameter. optional Day is optional and will return VAT calculations for the selected day of the given month and year.'
        required: true
        schema:
          type: integer
        examples:
          omitted:
            summary: 'When the value is omitted'
            value: ''
          present:
            summary: 'When the value is present'
            value: 7
tags:
  -
    name: 'Allegro orders management'
    description: ''
  -
    name: 'Assortment/Stock management'
    description: ''
  -
    name: 'Authentication management'
    description: ''
  -
    name: 'File upload management'
    description: ''
  -
    name: 'Orders management'
    description: ''
  -
    name: 'Reports management'
    description: ''
  -
    name: 'Shipments management'
    description: ''
  -
    name: 'Statistics management'
    description: ''
  -
    name: 'Test data management'
    description: ''
  -
    name: 'VAT calculations data management'
    description: ''
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: ''
security:
  -
    default: []
