doboxa-js 1.0.0

package/api-doc.yaml

@@ -0,0 +1,2013 @@
+openapi: 3.0.0
+info:
+  title: API V2
+  description: API V2
+  version: 1.0-alpha
+paths:
+  /api/v2/authentication/token:
+    post:
+      tags:
+        - Authentication
+      description: Retrieve a JWT token using your username and password
+      operationId: null
+      requestBody:
+        description: Username and password
+        required: true
+        content:
+          application/json:
+            schema:
+              properties:
+                username:
+                  type: string
+                password:
+                  type: string
+              type: object
+      responses:
+        "200":
+          description: Authentication successful
+          content:
+            application/json:
+              schema:
+                properties:
+                  token:
+                    description: JWT token, valid for 3600 seconds (1 hour)
+                    type: string
+                  refresh_token:
+                    description: Refresh token, valid for 2592000 seconds (30 days)
+                    type: string
+                type: object
+        "401":
+          description: Bad credentials
+          content:
+            application/json:
+              schema:
+                properties:
+                  code:
+                    type: int
+                    example: 401
+                  message:
+                    type: string
+                    example: Bad credentials
+                type: object
+  /api/v2/authentication/refresh_token:
+    post:
+      tags:
+        - Authentication
+      description: Retrieve a new valid JWT token using refresh token. Refresh token
+        lifetime will be reset
+      operationId: null
+      requestBody:
+        description: Refresh token
+        required: true
+        content:
+          application/json:
+            schema:
+              properties:
+                refresh_token:
+                  type: string
+              type: object
+      responses:
+        "200":
+          description: Login successful
+          content:
+            application/json:
+              schema:
+                properties:
+                  token:
+                    type: string
+                  refresh_token:
+                    type: string
+                type: object
+        "401":
+          description: Bad credentials
+          content:
+            application/json:
+              schema:
+                properties:
+                  code:
+                    type: int
+                    example: 401
+                  message:
+                    type: string
+                    example: Bad credentials
+                type: object
+  /api/v2/client:
+    get:
+      tags:
+        - Client
+      summary: Get clients (only commission type)
+      operationId: get_app_ecommerce_api_v2_getclients__invoke
+      parameters:
+        - name: page
+          in: query
+          description: Page number
+          required: false
+          schema:
+            type: integer
+            example: "1"
+      responses:
+        "200":
+          description: List of clients
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PageOfClients"
+        "400":
+          description: Invalid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "401":
+          description: Not authorized for this resource
+        "403":
+          description: Access token expired
+        "500":
+          description: Error while processing the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+  /api/v2/discount_code:
+    get:
+      tags:
+        - Discount code
+      summary: Get discount codes (only commission type)
+      operationId: get_api_v2_discount_codes_external
+      parameters:
+        - name: page
+          in: query
+          description: Page number
+          required: false
+          schema:
+            type: integer
+            example: "1"
+      responses:
+        "200":
+          description: Returned paginated discount codes
+          content:
+            application/json:
+              schema:
+                properties:
+                  items:
+                    type: array
+                    items:
+                      properties:
+                        code:
+                          description: Discount code
+                          type: string
+                        type:
+                          description: Discount type
+                          type: string
+                        client_email:
+                          description: Client associated with the discount
+                          type: string
+                        domain:
+                          description: Domain associated with the discount
+                          type: string
+                        currency:
+                          description: Discount currency
+                          type: string
+                          nullable: true
+                        action:
+                          description: Discount amount
+                          type: string
+                        valid_until:
+                          description: Discount expiration time
+                          type: string
+                          nullable: true
+                      type: object
+                  next_page:
+                    description: Link to the next page of results
+                    type: string
+                    nullable: true
+                type: object
+        "400":
+          description: Invalid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "401":
+          description: Not authorized for this resource
+        "403":
+          description: Access token expired
+        "500":
+          description: Error while processing the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+  /api/v2/invoice/{invoice_id}:
+    get:
+      tags:
+        - Invoice
+      summary: Get a specific invoice
+      operationId: get_app_ecommerce_api_v2_getinvoice__invoke
+      parameters:
+        - name: invoice_id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Invoice data
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Invoice"
+        "400":
+          description: Invalid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "401":
+          description: Not authorized for this resource
+        "403":
+          description: Access token expired
+        "404":
+          description: Invoice not found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "500":
+          description: Error while processing the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+  /api/v2/invoice:
+    get:
+      tags:
+        - Invoice
+      summary: Get latest invoices
+      operationId: get_app_ecommerce_api_v2_getinvoices__invoke
+      parameters:
+        - name: page
+          in: query
+          description: Page number
+          required: false
+          schema:
+            type: integer
+            example: "1"
+        - name: from
+          in: query
+          description: "Invoices added after given time. Default: now - 1 day"
+          required: false
+          schema:
+            type: string
+            format: date-time
+        - name: to
+          in: query
+          description: "Invoices added before given time. Default: now"
+          required: false
+          schema:
+            type: string
+            format: date-time
+      responses:
+        "200":
+          description: List of invoices
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PageOfInvoices"
+        "400":
+          description: Invalid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "401":
+          description: Not authorized for this resource
+        "403":
+          description: Access token expired
+        "500":
+          description: Error while processing the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+  /api/v2/user/me:
+    get:
+      tags:
+        - User
+      summary: Validate your access token
+      operationId: get_app_ecommerce_api_v2_getme__invoke
+      responses:
+        "200":
+          description: Current user
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Me"
+        "400":
+          description: Invalid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "401":
+          description: Not authorized for this resource
+        "403":
+          description: Access token expired
+        "500":
+          description: Error while processing the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+  /api/v2/order/{order_id}/comment:
+    get:
+      tags:
+        - Order
+      summary: Get a specific order comments
+      operationId: get_app_ecommerce_api_v2_getordercomments__invoke
+      parameters:
+        - name: order_id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: List of order comments
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PageOfOrderComments"
+        "400":
+          description: Invalid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "401":
+          description: Not authorized for this resource
+        "403":
+          description: Access token expired
+        "404":
+          description: Order not found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "500":
+          description: Error while processing the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+    post:
+      tags:
+        - Order
+      summary: Create an Order comment
+      operationId: post_app_ecommerce_api_v2_postordercomment__invoke
+      parameters:
+        - name: order_id
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateOrderComment"
+      responses:
+        "201":
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PostOrderCommentResponse"
+        "400":
+          description: Invalid data found in the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "401":
+          description: Not authorized for this resource
+        "403":
+          description: Access token expired
+        "404":
+          description: Order not found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "500":
+          description: Error while processing the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+  /api/v2/order/{order_id}/invoice:
+    get:
+      tags:
+        - Order
+      summary: Get Order invoices
+      operationId: get_app_ecommerce_api_v2_getorderinvoices__invoke
+      parameters:
+        - name: order_id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: List of invoices
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PageOfInvoices"
+        "400":
+          description: Invalid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "401":
+          description: Not authorized for this resource
+        "403":
+          description: Access token expired
+        "500":
+          description: Error while processing the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+  /api/v2/order/{order_id}/status:
+    get:
+      tags:
+        - Order
+      summary: Get current order status
+      operationId: get_app_ecommerce_api_v2_getorderstatus__invoke
+      parameters:
+        - name: order_id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Order status
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/OrderStatus"
+        "400":
+          description: Invalid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "401":
+          description: Not authorized for this resource
+        "403":
+          description: Access token expired
+        "404":
+          description: Order not found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "500":
+          description: Error while processing the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+    post:
+      tags:
+        - Order
+      summary: Change Order status (only commision type or test orders)
+      operationId: post_app_ecommerce_api_v2_postorderstatuschange__invoke
+      parameters:
+        - name: order_id
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/PostOrderStatus"
+      responses:
+        "201":
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PostOrderStatusResponse"
+        "400":
+          description: Invalid data found in the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "401":
+          description: Not authorized for this resource
+        "403":
+          description: Access token expired
+        "404":
+          description: Order not found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "500":
+          description: Error while processing the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+  /api/v2/order_status_change:
+    get:
+      tags:
+        - Order Status Change
+      summary: Get latest status changes. Note that only the latest order status
+        change is provided.
+      operationId: get_app_ecommerce_api_v2_getorderstatuschanges__invoke
+      parameters:
+        - name: page
+          in: query
+          description: Page number
+          required: false
+          schema:
+            type: integer
+            example: "1"
+        - name: from
+          in: query
+          description: "Order status changes newer than given time. Default: now - 4 hours"
+          required: false
+          schema:
+            type: string
+            format: date-time
+        - name: to
+          in: query
+          description: "Order status changes older than given time. Default: now"
+          required: false
+          schema:
+            type: string
+            format: date-time
+      responses:
+        "200":
+          description: List of order status changes
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PageOfOrderStatusChanges"
+        "400":
+          description: Invalid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "401":
+          description: Not authorized for this resource
+        "403":
+          description: Access token expired
+        "500":
+          description: Error while processing the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+  /api/v2/order/{order_id}/tracking_number:
+    get:
+      tags:
+        - Order
+      summary: Get Order tracking numbers
+      operationId: get_app_ecommerce_api_v2_getordertrackingnumbers__invoke
+      parameters:
+        - name: order_id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: List of order tracking numbers
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PageOfTrackingNumbers"
+        "400":
+          description: Invalid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "401":
+          description: Not authorized for this resource
+        "403":
+          description: Access token expired
+        "404":
+          description: Order not found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "500":
+          description: Error while processing the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+  /api/v2/order_comment:
+    get:
+      tags:
+        - Order Comment
+      summary: Get latest order comments.
+      operationId: get_app_ecommerce_api_v2_getorderscomments__invoke
+      parameters:
+        - name: page
+          in: query
+          description: Page number
+          required: false
+          schema:
+            type: integer
+            example: "1"
+        - name: from
+          in: query
+          description: "Comments added after given time. Default: now - 4 hours"
+          required: false
+          schema:
+            type: string
+            format: date-time
+        - name: to
+          in: query
+          description: "Comments added before given time. Default: now"
+          required: false
+          schema:
+            type: string
+            format: date-time
+      responses:
+        "200":
+          description: List of latest orders comments
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PageOfOrderComments"
+        "400":
+          description: Invalid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "401":
+          description: Not authorized for this resource
+        "403":
+          description: Access token expired
+        "500":
+          description: Error while processing the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+  /api/v2/tracking_number:
+    get:
+      tags:
+        - Tracking Number
+      summary: Get latest tracking numbers
+      operationId: get_app_ecommerce_api_v2_gettrackingnumbers__invoke
+      parameters:
+        - name: page
+          in: query
+          description: Page number
+          required: false
+          schema:
+            type: integer
+            example: "1"
+        - name: from
+          in: query
+          description: "Tracking numbers added after given time. Default: now - 1 day"
+          required: false
+          schema:
+            type: string
+            format: date-time
+        - name: to
+          in: query
+          description: "Tracking numbers added before given time. Default: now"
+          required: false
+          schema:
+            type: string
+            format: date-time
+      responses:
+        "200":
+          description: List of tracking numbers
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PageOfTrackingNumbers"
+        "400":
+          description: Invalid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "401":
+          description: Not authorized for this resource
+        "403":
+          description: Access token expired
+        "500":
+          description: Error while processing the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+  /api/v2/order:
+    post:
+      tags:
+        - Order
+      summary: Create an Order
+      operationId: post_app_ecommerce_api_v2_postorder__invoke
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/Order"
+      responses:
+        "201":
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PostOrderResponse"
+        "400":
+          description: Invalid data found in the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "401":
+          description: Not authorized for this resource
+        "403":
+          description: Access token expired
+        "500":
+          description: Error while processing the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+  /api/v2/order_cancellation:
+    post:
+      tags:
+        - Order Cancellation
+      summary: Cancel an order if possible (orders already in production cannot be
+        cancelled)
+      operationId: post_app_ecommerce_api_v2_postordercancellation__invoke
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/OrderCancellation"
+      responses:
+        "200":
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/OrderCancellationResponse"
+        "400":
+          description: Invalid data found in the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "401":
+          description: Not authorized for this resource
+        "403":
+          description: Access token expired
+        "404":
+          description: Order not found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InvalidRequestDataResponse"
+        "422":
+          description: Order cancellation cannot be processed due to order status
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/OrderCancellationResponse"
+        "500":
+          description: Error while processing the request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+components:
+  schemas:
+    PageOfClients:
+      properties:
+        items:
+          type: array
+          items:
+            $ref: "#/components/schemas/Client"
+        next_page:
+          type: string
+          nullable: true
+      type: object
+    InvalidRequestDataResponse:
+      properties:
+        invalid_parameters:
+          type: array
+          items:
+            $ref: "#/components/schemas/InvalidParameter"
+        result_code:
+          description: HTTP status code
+          type: integer
+          example: 400
+          nullable: false
+        error_message:
+          description: Error summary, in case of errors. Sometimes invalid_parameters may
+            be empty!
+          type: string
+          example: Invalid parameters in the request
+          nullable: false
+      type: object
+    ServerErrorResponse:
+      properties:
+        result_code:
+          description: HTTP status code
+          type: integer
+          example: 500
+          nullable: false
+        error_message:
+          description: Error summary
+          type: string
+          example: Internal Server Error
+          nullable: true
+      type: object
+    Invoice:
+      properties:
+        id:
+          description: Invoice id
+          type: string
+          example: "123456789"
+          nullable: false
+        client:
+          description: Client owning the Invoice
+          type: string
+          example: client@mail.com
+          nullable: false
+        file:
+          description: Direct link to Invoice PDF file
+          type: string
+          example: https://pl.doboxa.biz/documents/invoices/abc123/invoice_file.pdf
+          nullable: false
+        state:
+          description: Invoice payment status
+          type: string
+          enum:
+            - PAID
+            - UNPAID
+          nullable: false
+        document_number:
+          description: Invoice number
+          type: string
+          example: FAV/2023/11/23
+          nullable: false
+        document_amount:
+          description: Amount to pay
+          type: integer
+          example: 12300
+          nullable: false
+        net_amount:
+          description: Net amount
+          type: integer
+          example: 10000
+          nullable: false
+        tax_amount:
+          description: Tax amount
+          type: integer
+          example: 2300
+          nullable: false
+        tax_rate:
+          description: Tax rate
+          type: string
+          example: "23.5"
+          nullable: true
+        paid_amount:
+          description: Amount already paid
+          type: integer
+          example: 0
+          nullable: false
+        currency:
+          description: Currency
+          type: string
+          example: PLN
+          nullable: false
+        date_of_issue:
+          description: Date of issue
+          type: string
+          format: date-time
+          nullable: false
+        due_date:
+          description: Due date
+          type: string
+          format: date-time
+          nullable: false
+        document_type:
+          description: Document type
+          type: string
+          enum:
+            - main
+          nullable: false
+        orders:
+          type: array
+          items:
+            $ref: "#/components/schemas/InvoiceOrder"
+        invoice_items:
+          type: array
+          items:
+            $ref: "#/components/schemas/InvoiceItem"
+      type: object
+    PageOfInvoices:
+      properties:
+        items:
+          type: array
+          items:
+            $ref: "#/components/schemas/Invoice"
+        next_page:
+          type: string
+          nullable: true
+      type: object
+    Me:
+      properties:
+        username:
+          type: string
+      type: object
+    PageOfOrderComments:
+      properties:
+        items:
+          type: array
+          items:
+            $ref: "#/components/schemas/OrderComment"
+        next_page:
+          type: string
+          nullable: true
+      type: object
+    CreateOrderComment:
+      required:
+        - author_type
+        - author_email
+        - content
+        - created_at
+      properties:
+        author_type:
+          description: Author type
+          type: string
+          enum:
+            - client
+            - support
+          nullable: false
+        author_email:
+          description: Author type
+          type: string
+          example: mail@mail.com
+          nullable: false
+        content:
+          description: Comment content
+          type: string
+          example: Comment content
+          nullable: false
+        created_at:
+          description: Comment creation time
+          type: string
+          format: date-time
+          nullable: false
+      type: object
+    PostOrderCommentResponse:
+      properties:
+        result_code:
+          description: HTTP status code
+          type: integer
+          example: 200
+          nullable: false
+        comment_id:
+          description: Comment id, if successfully created
+          type: string
+          example: "123456"
+          nullable: false
+      type: object
+    OrderStatus:
+      properties:
+        status:
+          description: Order status
+          type: string
+          enum:
+            - new
+            - wait_for_payment
+            - paid
+            - in_progress
+            - ready_to_be_sent
+            - sent
+            - cancelled
+            - hold
+            - refund
+          nullable: false
+        item_status:
+          description: Order items status
+          type: array
+          items:
+            $ref: "#/components/schemas/OrderItemStatus"
+          nullable: false
+      type: object
+    PostOrderStatus:
+      required:
+        - status
+      properties:
+        status:
+          description: Order status
+          type: string
+          enum:
+            - new
+            - wait_for_payment
+            - paid
+            - in_progress
+            - ready_to_be_sent
+            - sent
+            - cancelled
+            - hold
+            - refund
+          nullable: false
+        item_status:
+          description: Order items status. If any item is not specified, its status will
+            be changed to order status
+          type: array
+          items:
+            $ref: "#/components/schemas/PostOrderStatusItem"
+          nullable: true
+      type: object
+    PostOrderStatusResponse:
+      properties:
+        result_code:
+          description: HTTP status code
+          type: integer
+          example: 200
+          nullable: false
+      type: object
+    PageOfOrderStatusChanges:
+      properties:
+        items:
+          type: array
+          items:
+            $ref: "#/components/schemas/OrderStatusChange"
+        next_page:
+          type: string
+          nullable: true
+      type: object
+    PageOfTrackingNumbers:
+      properties:
+        items:
+          type: array
+          items:
+            $ref: "#/components/schemas/TrackingNumber"
+        next_page:
+          type: string
+          nullable: true
+      type: object
+    Order:
+      required:
+        - deliver_address
+        - items
+        - order_time
+        - order_channel
+        - currency
+      properties:
+        external_id:
+          description: Your order id
+          type: string
+          example: "12345678"
+          nullable: false
+        billing_address:
+          readOnly: true
+          nullable: true
+          allOf:
+            - $ref: "#/components/schemas/BillingAddress"
+        deliver_address:
+          $ref: "#/components/schemas/DeliveryAddress"
+        items:
+          type: array
+          items:
+            $ref: "#/components/schemas/OrderItem"
+        order_time:
+          description: PHP's RFC3339_EXTENDED date-time (see
+            https://www.php.net/manual/en/class.datetimeinterface.php#datetimeinterface.constants.rfc3339-extended)
+          type: string
+          format: date-time
+          nullable: false
+        payment_time:
+          description: PHP's RFC3339_EXTENDED date-time (see
+            https://www.php.net/manual/en/class.datetimeinterface.php#datetimeinterface.constants.rfc3339-extended)
+          type: string
+          format: date-time
+          nullable: true
+        info:
+          description: Optional order description
+          type: string
+          example: Additional order description
+          nullable: true
+        order_channel:
+          description: Order channel
+          type: string
+          example: channel_id
+          nullable: true
+        order_source:
+          description: Order source
+          type: string
+          readOnly: true
+          example: source_id
+          nullable: true
+        currency:
+          description: Currency code (ISO 4217)
+          type: string
+          example: PLN
+          nullable: false
+        company_name:
+          description: Billing company name/id
+          type: string
+          example: company_id
+          nullable: true
+        own_delivery:
+          description: If set to true, a shipping label is required for every order.
+            Currently it is possible to upload shipping labels via FTP
+          type: boolean
+          example: false
+        discount_code:
+          description: Discount code
+          type: string
+          readOnly: true
+          example: DISCOUNT_CODE
+          nullable: true
+        partner_code:
+          description: Partner code
+          type: string
+          readOnly: true
+          example: PARTNER_CODE
+          nullable: true
+        order_original_data:
+          readOnly: true
+          nullable: true
+          allOf:
+            - $ref: "#/components/schemas/OrderOriginalData"
+        payment_method:
+          description: Original order payment method
+          type: string
+          enum:
+            - gotówka
+            - przelew
+            - karta
+            - Przelewy 24
+            - PayU
+            - PayU DE
+            - PayU EN
+            - PayU PL
+            - Kompensata
+            - PayPal
+            - Raty PayU
+            - pobranie
+            - amazon
+            - allegro
+            - Allegro PayU
+            - Allegro P24
+            - etsy
+            - emag.ro
+            - emag.hu
+            - real
+            - ebay
+            - stripe
+            - BRW
+            - eMag.bg
+            - Empik
+            - Home&you
+            - Home24
+            - Kaufland
+            - Erli
+            - Leroy Merlin
+            - Castorama
+            - Vivre
+            - Vilandy
+            - Pigu
+            - Fruugo
+            - Hood
+            - XXXLutz
+            - BricoDepot
+            - Adyen
+            - Mirakl
+            - Payoneer
+            - Hitmeister
+          readOnly: true
+          example: Adyen
+          nullable: true
+        payment_transaction_id:
+          description: Payment transaction id
+          type: string
+          readOnly: true
+          example: "3543647735754"
+          nullable: true
+        ag_invoice_requested:
+          type: boolean
+          readOnly: true
+          nullable: true
+        waybills:
+          type: array
+          items:
+            $ref: "#/components/schemas/Waybill"
+        attachments:
+          type: array
+          items:
+            $ref: "#/components/schemas/Attachment"
+        suggested_delivery_method:
+          description: Suggest delivery method (may be taken into consideration according
+            to business agreements)
+          type: string
+          readOnly: true
+          example: DHL
+          nullable: true
+      type: object
+    PostOrderResponse:
+      properties:
+        result_code:
+          description: HTTP status code
+          type: integer
+          example: 200
+          nullable: false
+        order_id:
+          description: Order id, if successfully created
+          type: string
+          example: "123456"
+          nullable: false
+      type: object
+    OrderCancellation:
+      required:
+        - order_id
+      properties:
+        order_id:
+          description: Doboxa order id
+          type: string
+          example: "123456"
+          nullable: false
+      type: object
+    OrderCancellationResponse:
+      properties:
+        cancelled:
+          description: Cancellation result
+          type: bool
+          example: true
+          nullable: false
+        details:
+          description: Additional details regarding the cancellation process
+          type: string
+          enum:
+            - cancelled
+            - already_in_production
+          nullable: false
+      type: object
+    Client:
+      properties:
+        email:
+          description: Client email
+          type: string
+          example: test@fairbox.biz
+          nullable: false
+        token:
+          description: Client token
+          type: string
+          example: vf24534gdsfvq42
+          nullable: false
+      type: object
+    InvalidParameter:
+      properties:
+        parameter:
+          description: Invalid parameter name
+          type: string
+          example: external_id
+          nullable: false
+        error_cause:
+          description: Error cause
+          type: string
+          example: Given external_id was already used
+          nullable: false
+      type: object
+    InvoiceOrder:
+      properties:
+        doboxa_order_id:
+          description: Order id
+          type: string
+          example: "23212332"
+          nullable: true
+        external_order_id:
+          description: Order external id
+          type: string
+          example: "23212332"
+          nullable: true
+        items:
+          type: array
+          items:
+            $ref: "#/components/schemas/InvoiceOrderItem"
+      type: object
+    InvoiceItem:
+      properties:
+        doboxa_item_id:
+          description: Doboxa item id. Can be null if invoice item cannot be mapped to
+            order item.
+          type: string
+          example: "21212332"
+          nullable: true
+        foreign_item_id:
+          description: Order.items.foreign_id provided while creating order. Can be null
+            if invoice item cannot be mapped to order item.
+          type: string
+          example: "21212332"
+          nullable: true
+        name:
+          description: Item name
+          type: string
+          example: Product name
+          nullable: false
+        qty:
+          description: Quantity
+          type: string
+          example: "2"
+          nullable: false
+        unit:
+          description: Unit type
+          type: string
+          example: szt
+          nullable: false
+        net_unit_price:
+          description: Unit net price
+          type: string
+          example: "100.00"
+          nullable: false
+        net_value:
+          description: Net position value
+          type: string
+          example: "100.00"
+          nullable: false
+        vat_value:
+          description: Tax amount
+          type: string
+          example: "23.00"
+          nullable: false
+        vat_rate:
+          description: Tax rate
+          type: string
+          example: "23"
+          nullable: false
+        currency:
+          description: Currency
+          type: string
+          example: PLN
+          nullable: false
+      type: object
+    OrderComment:
+      properties:
+        comment_id:
+          description: Doboxa comment id
+          type: string
+          example: "12345678"
+          nullable: false
+        author_type:
+          description: Author type
+          type: string
+          enum:
+            - client
+            - support
+          nullable: false
+        author:
+          description: Comment author. Can be empty
+          type: string
+          example: client@mail.com
+          nullable: true
+        content:
+          description: Comment content
+          type: string
+          example: Comment content
+          nullable: false
+        created_at:
+          description: Comment creation time
+          type: string
+          format: date-time
+          nullable: false
+      type: object
+    OrderItemStatus:
+      properties:
+        doboxa_order_id:
+          description: Id assigned to order by doboxa (returned after successful order
+            creation)
+          type: string
+          example: "12345678"
+          nullable: false
+        external_order_id:
+          description: Id provided in external_id during order creation
+          type: string
+          example: "12345678"
+          nullable: true
+        doboxa_item_id:
+          description: Item id assigned to item by doboxa
+          type: string
+          example: "123"
+          nullable: true
+        foreign_item_id:
+          description: Id provided in items.foreign_id during order creation
+          type: string
+          example: "123"
+          nullable: true
+        product_sku:
+          description: SKU of the product related to this item
+          type: string
+          example: SKU-123
+          nullable: true
+        status:
+          description: Product status
+          type: string
+          enum:
+            - new
+            - wait_for_payment
+            - paid
+            - in_progress
+            - ready_to_be_sent
+            - sent
+            - cancelled
+            - hold
+            - refund
+          nullable: false
+      type: object
+    PostOrderStatusItem:
+      required:
+        - doboxa_item_id
+        - status
+      properties:
+        doboxa_item_id:
+          description: Item id assigned to item by doboxa
+          type: string
+          example: "123"
+          nullable: true
+        status:
+          description: Order status
+          type: string
+          enum:
+            - new
+            - wait_for_payment
+            - paid
+            - in_progress
+            - ready_to_be_sent
+            - sent
+            - cancelled
+            - hold
+            - refund
+          nullable: false
+      type: object
+    OrderStatusChange:
+      properties:
+        order_id:
+          description: Doboxa order id
+          type: string
+          example: "12345678"
+          nullable: false
+        status:
+          description: Order status
+          type: string
+          enum:
+            - new
+            - wait_for_payment
+            - paid
+            - in_progress
+            - ready_to_be_sent
+            - sent
+            - cancelled
+            - hold
+            - refund
+          nullable: false
+        change_time:
+          description: Order status change time
+          type: string
+          format: date-time
+          nullable: false
+        item_status:
+          description: Order items status
+          type: array
+          items:
+            $ref: "#/components/schemas/OrderItemStatus"
+          nullable: false
+      type: object
+    TrackingNumber:
+      properties:
+        order_id:
+          description: Related order id
+          type: string
+          example: "12345678"
+          nullable: false
+        number:
+          description: Tracking number
+          type: string
+          example: "123456789009876543"
+          nullable: false
+        delivery_method:
+          description: Delivery method
+          type: string
+          nullable: false
+        sent_at:
+          description: Sent time. Can be empty (if not yet sent)
+          type: string
+          format: date-time
+          nullable: true
+        created_at:
+          description: Creation time
+          type: string
+          format: date-time
+          nullable: false
+        return_label:
+          $ref: "#/components/schemas/ReturnLabel"
+        order_items:
+          description: Order items assigned to the tracking number
+          type: array
+          items:
+            $ref: "#/components/schemas/TrackingNumberItem"
+          nullable: true
+      type: object
+    BillingAddress:
+      required:
+        - first_name
+        - last_name
+        - address1
+        - city
+        - post_code
+        - country_iso
+      properties:
+        first_name:
+          description: Customer's first name
+          type: string
+          example: John
+          nullable: false
+        last_name:
+          description: Customer's last name
+          type: string
+          example: Doe
+          nullable: false
+        company_name:
+          description: Additional/company name (for delivery)
+          type: string
+          example: Company name
+          nullable: true
+        phone_number:
+          description: Customer's phone number
+          type: string
+          maxLength: 20
+          minLength: 5
+          example: "+48123456789"
+          nullable: false
+        email:
+          description: Customer's e-mail address
+          type: string
+          example: johndoe@mail.com
+          nullable: false
+        address1:
+          description: Delivery address
+          type: string
+          example: 123 Dubious st.
+          nullable: false
+        address2:
+          description: Optional additional address line
+          type: string
+          example: Silky Walks dept.
+          nullable: true
+        city:
+          description: City
+          type: string
+          example: City
+          nullable: false
+        region:
+          description: Optional region name (required for delivery to some countries)
+          type: string
+          example: Region
+          nullable: true
+        post_code:
+          description: Postal code
+          type: string
+          example: "12345"
+          nullable: false
+        country_iso:
+          description: Country code - ISO 3166 alpha 2
+          type: string
+          example: PL
+          nullable: false
+        tax_id:
+          description: Tax identification number
+          type: string
+          example: PL123456789
+          nullable: true
+      type: object
+    DeliveryAddress:
+      required:
+        - first_name
+        - last_name
+        - phone_number
+        - email
+        - address1
+        - city
+        - post_code
+        - country_iso
+      properties:
+        first_name:
+          description: Customer's first name
+          type: string
+          example: John
+          nullable: false
+        last_name:
+          description: Customer's last name
+          type: string
+          example: Doe
+          nullable: false
+        company_name:
+          description: Additional/company name (for delivery)
+          type: string
+          example: Company name
+          nullable: true
+        phone_number:
+          description: Customer's phone number
+          type: string
+          maxLength: 20
+          minLength: 5
+          example: "+48123456789"
+          nullable: false
+        email:
+          description: Customer's e-mail address
+          type: string
+          example: johndoe@mail.com
+          nullable: false
+        address1:
+          description: Delivery address
+          type: string
+          example: 123 Dubious st.
+          nullable: false
+        address2:
+          description: Optional additional address line
+          type: string
+          example: Silky Walks dept.
+          nullable: true
+        city:
+          description: City
+          type: string
+          example: City
+          nullable: false
+        region:
+          type: string
+          nullable: true
+        post_code:
+          description: Postal code
+          type: string
+          example: "12345"
+          nullable: false
+        country_iso:
+          description: Country code - ISO 3166 alpha 2
+          type: string
+          example: PL
+          nullable: false
+        delivery_point_id:
+          description: Delivery point (e.g. paczkomat) id
+          type: string
+          example: "12345678"
+          nullable: true
+        allegro_smart_account_id:
+          description: Allegro account id for processing smart orders
+          type: string
+          example: "12345678"
+          nullable: true
+      type: object
+    OrderItem:
+      required:
+        - id
+        - qty
+      properties:
+        foreign_id:
+          description: Your order item id
+          type: string
+          example: "432536"
+          nullable: true
+        id:
+          description: SKU
+          type: string
+          example: FT-688-VE90-60
+          nullable: false
+        additional_sku:
+          description: Your sku
+          type: string
+          example: FT-688-VE90-60
+          nullable: true
+        ean:
+          description: Product EAN
+          type: string
+          example: "123456789"
+          nullable: true
+        symbol_code:
+          description: Product symbol code
+          type: string
+          example: VE90-60
+          nullable: true
+        name:
+          description: Article display name
+          type: string
+          example: Product name
+          nullable: false
+        qty:
+          description: Quantity (pieces)
+          type: integer
+          minimum: 0
+          exclusiveMinimum: true
+          example: 1
+          nullable: false
+        item_price:
+          description: Sale item price, 9999 = 99.99
+          type: integer
+          minimum: 0
+          example: 9999
+          nullable: false
+        width_in_cm:
+          description: Custom print width (in cm)
+          type: string
+          example: 100
+          nullable: true
+        height_in_cm:
+          description: Custom print height (in cm)
+          type: string
+          example: 80
+          nullable: true
+        custom_file:
+          description: Custom file path or name (e. g. from FTP server)
+          type: string
+          example: https://pl.doboxa.biz/upload/1/product-mask/FT-688/FT-688-2000x1333-125.jpg
+          nullable: true
+        additional_custom_file:
+          description: Additional custom file path or name (e. g. from FTP server)
+          type: string
+          example: https://pl.doboxa.biz/upload/1/product-mask/FT-688/FT-688-2000x1333-125.jpg
+          nullable: true
+        additional_info:
+          description: Optional additional info about the item
+          type: string
+          example: additional info
+          nullable: true
+        crop_data:
+          nullable: true
+          allOf:
+            - $ref: "#/components/schemas/OrderItemCropData"
+        initial_price:
+          type: integer
+          minimum: 0
+          readOnly: true
+          nullable: true
+        item_delivery_cost:
+          type: integer
+          minimum: 0
+          exclusiveMinimum: true
+          readOnly: true
+          nullable: true
+        item_original_data:
+          readOnly: true
+          nullable: true
+          allOf:
+            - $ref: "#/components/schemas/OrderItemOriginalData"
+        fulfillment_date:
+          description: PHP's RFC3339_EXTENDED date-time (see
+            https://www.php.net/manual/en/class.datetimeinterface.php#datetimeinterface.constants.rfc3339-extended)
+          type: string
+          format: date-time
+          nullable: false
+        custom_file_id:
+          description: Custom file id (to reuse in other orders)
+          type: string
+          example: 5f009451b3b4d415234f3cabbab857c9
+          nullable: true
+        item_tax:
+          type: integer
+          minimum: 0
+          exclusiveMinimum: true
+          readOnly: true
+          nullable: true
+      type: object
+    OrderOriginalData:
+      properties:
+        currency:
+          description: Original/client currency
+          type: string
+          example: PLN
+          nullable: true
+        order_sum:
+          description: Original order sum (gross), 9999 = 99.99
+          type: integer
+          minimum: 0
+          example: 9999
+          nullable: false
+        delivery_cost:
+          description: Original order delivery cost, 999 = 9.99
+          type: integer
+          example: "999"
+          nullable: true
+        payment_cost:
+          description: Original order payment cost, 999 = 9.99
+          type: integer
+          example: "999"
+          nullable: true
+        rebate:
+          description: Original order rebate, 999 = 9.99
+          type: integer
+          example: "999"
+          nullable: true
+      type: object
+    Waybill:
+      required:
+        - file_path
+      properties:
+        number:
+          description: Bill number
+          type: string
+          example: "0000001234567890000"
+          nullable: true
+        delivery_method:
+          description: Company processing the delivery
+          type: string
+          enum:
+            - dpd
+            - dpd_de
+            - dpd_pl
+            - gls
+            - fedex
+            - fedex_pl
+            - dhl
+            - dhl_de
+            - ups
+            - inpost
+            - to_resolve_in_erp
+          nullable: true
+        file_path:
+          description: Path to a printable file (or file name)
+          type: string
+          example: https://path.to/file.pdf
+          nullable: false
+        articles:
+          description: Order articles (foreign_id) related to this waybill
+          type: array
+          items:
+            description: foreign_id of all articles related to this waybill (as string)
+            type: string
+            example: "432536"
+          nullable: true
+      type: object
+    Attachment:
+      required:
+        - type
+        - file_path
+      properties:
+        type:
+          description: Attachment type
+          type: string
+          example: Installation manual
+          nullable: false
+        file_path:
+          description: Path to a printable file (or file name)
+          type: string
+          example: https://path.to/file.pdf
+          nullable: false
+        articles:
+          description: Order articles (foreign_id) related to this waybill
+          type: array
+          items:
+            description: foreign_id of all articles related to this waybill (as string)
+            type: string
+            example: "432536"
+          nullable: true
+      type: object
+    InvoiceOrderItem:
+      properties:
+        doboxa_item_id:
+          description: Order item id
+          type: string
+          example: "21212332"
+          nullable: true
+        foreign_item_id:
+          description: Order item external id
+          type: string
+          example: "21212332"
+          nullable: true
+      type: object
+    ReturnLabel:
+      properties:
+        number:
+          description: Tracking number
+          type: string
+          example: "123456789009876543"
+          nullable: false
+        delivery_method:
+          description: Delivery method
+          type: string
+          nullable: false
+      type: object
+    TrackingNumberItem:
+      properties:
+        doboxa_item_id:
+          description: Doboxa item id
+          type: string
+          example: "12345678"
+          nullable: false
+        foreign_item_id:
+          description: External item id
+          type: string
+          example: "12345678"
+          nullable: true
+        product_sku:
+          description: Product SKU
+          type: string
+          example: SKU
+          nullable: false
+      type: object
+    OrderItemCropData:
+      properties:
+        left:
+          type: string
+          example: "0"
+          nullable: true
+        top:
+          type: string
+          example: "0"
+          nullable: true
+        width:
+          type: string
+          example: "700"
+          nullable: true
+        height:
+          type: string
+          example: "500"
+          nullable: true
+        original_photo_width:
+          type: string
+          example: "700"
+          nullable: true
+        original_photo_height:
+          type: string
+          example: "700"
+          nullable: true
+        filter:
+          description: Filter - none, blackwhite, sepia
+          type: string
+          enum:
+            - none
+            - blackwhite
+            - sepia
+          nullable: true
+        reflection:
+          description: Reflection - none, vertical, horizontal, both
+          type: string
+          enum:
+            - none
+            - vertical
+            - horizontal
+            - both
+          nullable: true
+        rotation:
+          description: Number of degrees to rotate the image clockwise
+          type: int
+          example: 90
+          nullable: true
+        scale:
+          description: Resize the original image by
+          type: string
+          example: "0.5"
+          nullable: true
+      type: object
+    OrderItemOriginalData:
+      properties:
+        item_unit_price:
+          description: Original item unit price (gross), 9999 = 99.99
+          type: integer
+          minimum: 0
+          example: 9999
+          nullable: false
+        item_value:
+          description: Original item value (gross), 9999 = 99.99
+          type: integer
+          minimum: 0
+          example: 9999
+          nullable: false
+      type: object
+  securitySchemes:
+    Bearer:
+      type: apiKey
+      description: "Value: Bearer {token}"
+      name: Authorization
+      in: header
+security:
+  - Bearer: []