Page Comparison

---
openapi: 3.0.3
info:
  title: Swagger
  description: 'Merchant API. Merchant expose API only for Basket App '
  version: 3.6.5.7

tags:
  - name: Basket
    description: Provides access to managing baskets.
  - name: Order
    description: Provides access to managing orders.
paths:
  /v1/izi/basket/{basket_id}:
    get:
      tags:
        - Basket
      summary: Reads basket details.
      description: Reads basket details
      operationId: basket
      parameters:
        - name: basket_id
          in: path
          description: ID of basket
          required: true
          style: simple
          explode: false
          schema:
            type: string
      responses:
        "200":
          description: Basket details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/basket_response'
        "401":
          content:
            application/json:
              example:
                error_code: UNAUTHORIZED
                error_message: Given user is not authorized to access the resource.
              schema:
                $ref: '#/components/schemas/error'
          description: Unauthorized.
        "403":
          content:
            application/json:
              example:
                error_code: FORBIDDEN
                error_message: Access to given resource is forbidden for current user.
              schema:
                $ref: '#/components/schemas/error'
          description: Forbidden.
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                internalServerError:
                  $ref: '#/components/examples/internalServerError'
        "400":
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                argumentNotValidError:
                  $ref: '#/components/examples/argumentNotValidError'
                malformedRequest:
                  $ref: '#/components/examples/malformedRequest'
        "404":
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                basketNotFound:
                  $ref: '#/components/examples/basketNotFound'
  /v1/izi/basket/{basket_id}/confirmation:
    post:
      tags:
        - Basket
      summary: Basket binding confirmation.
      description: This method creates connection between BasketId and phoneNumber.
      operationId: bindingBasket
      parameters:
        - name: basket_id
          in: path
          description: ID of basket to bind with InPost Mobile App.
          required: true
          style: simple
          explode: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/request_browser_binding'
        required: true
      responses:
        "200":
          description: Basket details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/basket'
        "401":
          content:
            application/json:
              example:
                error_code: UNAUTHORIZED
                error_message: Given user is not authorized to access the resource.
              schema:
                $ref: '#/components/schemas/error'
          description: Unauthorized.
        "403":
          content:
            application/json:
              example:
                error_code: FORBIDDEN
                error_message: Access to given resource is forbidden for current user.
              schema:
                $ref: '#/components/schemas/error'
          description: Forbidden.
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                internalServerError:
                  $ref: '#/components/examples/internalServerError'
        "400":
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                argumentNotValidError:
                  $ref: '#/components/examples/argumentNotValidError'
                malformedRequest:
                  $ref: '#/components/examples/malformedRequest'
        "404":
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                basketNotFound:
                  $ref: '#/components/examples/basketNotFound'
  /v1/izi/basket/{basket_id}/event:
    post:
      tags:
        - Basket
      summary: Update basket details.
      description: Update basket details. The method allows to change products quantity, promotion codes.
      operationId: basketEvents
      parameters:
        - name: basket_id
          in: path
          description: ID of basket to update
          required: true
          style: simple
          explode: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/basket_events'
        required: true
      responses:
        "200":
          description: Get basket details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/basket'
        "401":
          content:
            application/json:
              example:
                error_code: UNAUTHORIZED
                error_message: Given user is not authorized to access the resource.
              schema:
                $ref: '#/components/schemas/error'
          description: Unauthorized.
        "403":
          content:
            application/json:
              example:
                error_code: FORBIDDEN
                error_message: Access to given resource is forbidden for current user.
              schema:
                $ref: '#/components/schemas/error'
          description: Forbidden.
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                internalServerError:
                  $ref: '#/components/examples/internalServerError'
        "400":
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                argumentNotValidError:
                  $ref: '#/components/examples/argumentNotValidError'
                malformedRequest:
                  $ref: '#/components/examples/malformedRequest'
        "404":
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                basketNotFound:
                  $ref: '#/components/examples/basketNotFound'
  /v1/izi/basket/{basketId}/binding:
    delete:
      tags:
        - Basket
      summary: Desynchronisation of basket with telephone number
      description: Desynchronisation of basket with telephone number
      operationId: deleteBasket
      parameters:
        - name: basketId
          in: path
          description: ID of basket to delete
          required: true
          style: simple
          explode: false
          schema:
            type: string
      responses:
        "200":
          description: basket deleted
        "401":
          content:
            application/json:
              example:
                error_code: UNAUTHORIZED
                error_message: Given user is not authorized to access the resource.
              schema:
                $ref: '#/components/schemas/error'
          description: Unauthorized.
        "403":
          content:
            application/json:
              example:
                error_code: FORBIDDEN
                error_message: Access to given resource is forbidden for current user.
              schema:
                $ref: '#/components/schemas/error'
          description: Forbidden.
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                internalServerError:
                  $ref: '#/components/examples/internalServerError'
        "400":
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                argumentNotValidError:
                  $ref: '#/components/examples/argumentNotValidError'
                malformedRequest:
                  $ref: '#/components/examples/malformedRequest'
        "404":
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                basketNotFound:
                  $ref: '#/components/examples/basketNotFound'
  /v1/izi/order:
    post:
      tags:
        - Order
      summary: Create order.
      operationId: createOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/post_order_request'
        required: true
      responses:
        "201":
          description: Order created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order_request'
        "401":
          content:
            application/json:
              example:
                error_code: UNAUTHORIZED
                error_message: Given user is not authorized to access the resource.
              schema:
                $ref: '#/components/schemas/error'
          description: Unauthorized.
        "403":
          content:
            application/json:
              example:
                error_code: FORBIDDEN
                error_message: Access to given resource is forbidden for current user.
              schema:
                $ref: '#/components/schemas/error'
          description: Forbidden.
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                internalServerError:
                  $ref: '#/components/examples/internalServerError'
        "400":
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                argumentNotValidError:
                  $ref: '#/components/examples/argumentNotValidError'
                malformedRequest:
                  $ref: '#/components/examples/malformedRequest'
        "404":
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                basketNotFound:
                  $ref: '#/components/examples/basketNotFound'
        "409":
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                orderNotCreate:
                  $ref: '#/components/examples/orderNotCreate'                  
  /v1/izi/order/{order_id}:
    get:
      tags:
        - Order
      summary: Get order details.
      operationId: getOrder
      parameters:
        - name: order_id
          in: path
          description: ID of order
          required: true
          style: simple
          explode: false
          schema:
            type: string
      responses:
        "200":
          description: Order details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order_request'
        "401":
          content:
            application/json:
              example:
                error_code: UNAUTHORIZED
                error_message: Given user is not authorized to access the resource.
              schema:
                $ref: '#/components/schemas/error'
          description: Unauthorized.
        "403":
          content:
            application/json:
              example:
                error_code: FORBIDDEN
                error_message: Access to given resource is forbidden for current user.
              schema:
                $ref: '#/components/schemas/error'
          description: Forbidden.
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                internalServerError:
                  $ref: '#/components/examples/internalServerError'
        "400":
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                argumentNotValidError:
                  $ref: '#/components/examples/argumentNotValidError'
                malformedRequest:
                  $ref: '#/components/examples/malformedRequest'
        "404":
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                orderNotFound:
                  $ref: '#/components/examples/orderNotFound'
  /v1/izi/order/{order_id}/event:
    post:
      tags:
        - Order
      summary: Update order.
      operationId: updateOrder
      parameters:
        - name: order_id
          in: path
          description: ID of order to update
          required: true
          style: simple
          explode: false
          schema:
            type: string
      requestBody:
        description: Please not that not all event_data payload will be populated on each event. Payload is functionally separated to payment and order status event, thus payment_* fields will be send for payment event, without order_status as it does not change on payment event. For order status change event only order_status will be populated as payment related data does not change with that event.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/request_order_event'
        required: true
      responses:
        "200":
          description: Basket response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_order_event_merchant'
        "401":
          content:
            application/json:
              example:
                error_code: UNAUTHORIZED
                error_message: Given user is not authorized to access the resource.
              schema:
                $ref: '#/components/schemas/error'
          description: Unauthorized.
        "403":
          content:
            application/json:
              example:
                error_code: FORBIDDEN
                error_message: Access to given resource is forbidden for current user.
              schema:
                $ref: '#/components/schemas/error'
          description: Forbidden.
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                internalServerError:
                  $ref: '#/components/examples/internalServerError'
        "400":
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                argumentNotValidError:
                  $ref: '#/components/examples/argumentNotValidError'
                malformedRequest:
                  $ref: '#/components/examples/malformedRequest'
        "404":
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                orderNotFound:
                  $ref: '#/components/examples/orderNotFound'
        "409":
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                orderNotFound:
                  $ref: '#/components/examples/orderNotUpdate'                  
components:
  examples:
    merchantDisabledError:
      value:
        error_code: MERCHANT_DISABLE
        error_message: 'Merchant with given id is DISABLED'
      summary: MERCHANT_DISABLE
      description: Service is temporarily disabled, because of to many incorrect requests or manual blockade
    basketBoundError:
      value:
        error_code: BASKET_IS_BINDED
        error_message: 'Basket already bound'
      summary: BASKET_IS_BINDED
      description: Basket already bound.
    basketExpired:
      value:
        error_code: BASKET_EXPIRED
        error_message: 'Basket expired'
      summary: BASKET_EXPIRED
      description: Basket expired and will be removed soon.
    basketNotBoundError:
      value:
        error_code: BASKET_NOT_BOUND
        error_message: 'Basket not bound'
      summary: BASKET_NOT_BOUND
      description: Basket not bound.
    bindingRedundantPhoneError:
      value:
        error_code: ERROR_VALIDATION_PHONE_NUMBER
        error_message: 'Phone number required for PHONE binding method only'
      summary: ERROR_VALIDATION_PHONE_NUMBER
      description: Phone number should not be passed for binding methods other than PHONE.
    bindingPhoneRequiredError:
      value:
        error_code: ERROR_VALIDATION_PHONE_NUMBER_REQUIRED
        error_message: 'Phone number is required'
      summary: ERROR_VALIDATION_PHONE_NUMBER_REQUIRED
      description: Phone number is required for PHONE method binding.
    bindingBrowserRequiredError:
      value:
        error_code: ERROR_VALIDATION_BROWSER_REQUIRED
        error_message: 'Browser is required for PHONE binding method'
      summary: ERROR_VALIDATION_BROWSER_REQUIRED
      description: Browser details are required for PHONE binding method
    phoneBindingMethodUnavailableError:
      value:
        error_code: PHONE_BINDING_METHOD_UNAVAILABLE
        error_message: 'Unavailable'
      summary: PHONE_BINDING_METHOD_UNAVAILABLE
      description: Phone binding method temporarily unavailable for requested number.
    orderStatusError:
      value:
        error_code: STATUS_ORDER_ERROR
        error_message: 'Unavailable'
      summary: STATUS_ORDER_ERROR
      description: Can't be changed ORDER_COMPLETED
    publicKeyNotFound:
      value:
        error_code: PUBLIC_KEY_NOT_FOUND
        error_message: 'Public key version {} not found'
      summary: PUBLIC_KEY_NOT_FOUND
      description: public key not found
    argumentNotValidError:
      value:
        error_code: BAD_REQUEST
        error_message: Invalid request.
      summary: BAD_REQUEST
      description: Request validation error. Error message might optionally contain information about constraint violations.
    malformedRequest:
      value:
        error_code: MALFORMED_REQUEST
        error_message: Request not readable.
      summary: MALFORMED_REQUEST
      description: The server was not able to read the request.
    notFound:
      value:
        error_code: NOT_FOUND
        error_message: Resource not found.
      summary: NOT_FOUND
      description: The server was not able to read the request.
    basketNotFound:
      value:
        error_code: BASKET_NOT_FOUND
        error_message: Basket not found.
      summary: BASKET_NOT_FOUND
      description: Basket not found.
    basketNotUpdate:
      value:
        error_code: BASKET_NOT_UPDATE
        error_message: Basket not update.
      summary: BASKET_NOT_UPDATE
      description: Basket not update.
    orderNotCreate:
      value:    
        error_code: ORDER_NOT_CREATE
        error_message: Merchant reason to present client.
      summary: ORDER_NOT_CREATE
      description: Order not create.    
    orderNotFound:
      value:
        error_code: ORDER_NOT_FOUND
        error_message: Order not found.
      summary: ORDER_NOT_FOUND
      description: Order not found.
    basketDelete:
      value:
        error_code: BASKET_DELETE
        error_message: Basket delete.
      summary: BASKET_DELETE
      description: Basket delete.
    internalServerError:
      value:
        error_code: INTERNAL_SERVER_ERROR
        error_message: Something went wrong. Please try again later.
      summary: INTERNAL_SERVER_ERROR
      description: The server encountered unexpected error.
    orderNotUpdate:
      value:
        error_code: ORDER_NOT_UPDATE
        error_message: Order not update.
      summary: ORDER_NOT_UPDATE
      description: Order not update.    
  schemas:
    error:
      required:
      - errorCode
      type: object
      properties:
        error_code:
          type: string
        error_message:
          type: string   
    basket_response:
      type: object
      required:
        - summary
        - delivery
        - products
        - consents
      properties:
        summary:
          $ref: '#/components/schemas/summary'
        delivery:
          type: array
          items:
            $ref: '#/components/schemas/delivery_basket_response'
        promo_codes:
          type: array
          description: promo codes
          items:
            $ref: '#/components/schemas/promo_codes'
        promotions_available:
          type: array
          items:
            $ref: '#/components/schemas/promotion'       
        products:
          type: array
          description: products information
          items:
            $ref: '#/components/schemas/get_products'
        related_products:
          type: array
          description: related product information
          items:
            $ref: '#/components/schemas/get_related_products'
        consents:
          type: array
          description: consents list
          items:
            $ref: '#/components/schemas/consents'
        merchant_store:
           type: object
           required:
             - url
             - cookies
           properties:
            url:
              type: string
              description: Url of the merchant shop or direct address to cart
              example: "https://uat.outofthebox.pl/cart/"
            cookies:
              type: array
              items:
                $ref: '#/components/schemas/cookies'
    basket:
      type: object
      required:
        - summary
        - delivery
        - products
        - consents
      properties:
        summary:
          $ref: '#/components/schemas/basket_summary'
        delivery:
          type: array
          items:
            $ref: '#/components/schemas/delivery_basket_response'
        promo_codes:
          type: array
          description: promo codes
          items:
            $ref: '#/components/schemas/promo_codes'
        promotions_available:
          type: array
          items:
            $ref: '#/components/schemas/promotion'               
        products:
          type: array
          description: products information
          items:
            $ref: '#/components/schemas/get_products'
        related_products:
          type: array
          description: related product information
          items:
            $ref: '#/components/schemas/get_related_products'
        consents:
          type: array
          description: consents list
          items:
            $ref: '#/components/schemas/consents'
        merchant_store:
           type: object
           required:
             - url
             - cookies
           properties:
            url:
              type: string
              description: Url of the merchant shop or direct address to cart
              example: "https://uat.outofthebox.pl/cart/"
            cookies:
              type: array
              items:
                $ref: '#/components/schemas/cookies'            
    basket_events:
      type: object
      description: event relating change in customer basket
      required:
        - event_id
        - event_data_time
        - event_type
      properties:
        event_id:
          type: string
          description: event id
        event_data_time:
          type: string
          description: event data time
          format: date-time
        event_type:
          type: string
          description: event type
          enum:
            - PRODUCTS_QUANTITY
            - PROMO_CODES
            - RELATED_PRODUCTS
        phone_number:
          $ref: '#/components/schemas/phone_number'
        quantity_event_data:
          type: array
          description: quantity event
          items:
            $ref: '#/components/schemas/quantity_event_data'
        promo_codes_event_data:
          type: array
          description: promo codes event. If an empty list is provided, it means that customer has deleted the promo code.
          items:
            $ref: '#/components/schemas/promo_codes'
        related_products_event_data:
          type: array
          description: related products event
          items:
            $ref: '#/components/schemas/related_products_event'
    quantity_event_data:
      type: object
      description: quantity event
      required:
        - product_id
        - quantity
      properties:
        product_id:
          type: string
          description: product id
        quantity:
          $ref: '#/components/schemas/quantity_event'
    related_products_event:
      type: object
      description: related products event
      required:
        - product_id
        - quantity
      properties:
        product_id:
          type: string
          description: product id
        ean:
          type: string
          description: ean code
        quantity:
          $ref: '#/components/schemas/quantity_event'
    request_browser_binding:
      type: object
      properties:
        status:
          description: status binding
          type: string
          enum:
            - SUCCESS
            - REJECT
        inpost_basket_id:
          type: string
          description: basket id created by BaketApp
        phone_number:
          $ref: '#/components/schemas/phone_number'
        browser:
          $ref: '#/components/schemas/browser'
        masked_phone_number:
          type: string
          description:  masked phone numebr
          example: 60*****00
        name:
          type: string
          description: client name
        surname:
          type: string
          description:  client surname
    browser:
      type: object
      required:
        - browser_trusted
      properties:
        browser_trusted:
          type: boolean
          description: is browser trusted
        browser_id:
          type: string
          description: browser id
    order_request:
      type: object
      required:
        - order_details
        - account_info
        - delivery
        - products
        - consents
      properties:
        order_details:
          $ref: '#/components/schemas/response_orders_details'
        account_info:
          $ref: '#/components/schemas/account_info'
        invoice_details:
          $ref: '#/components/schemas/invoice_details'
        delivery:
          $ref: '#/components/schemas/delivery'
        products:
          type: array
          description: products order list
          items:
            $ref: '#/components/schemas/get_products_order'
        consents:
          type: array
          description: consents list
          items:
            $ref: '#/components/schemas/consents_order'
    post_order_request:
      type: object
      required:
        - order_details
        - account_info
        - products
        - consents
        - delivery
      properties:
        order_details:
          $ref: '#/components/schemas/request_orders_details'
        account_info:
          $ref: '#/components/schemas/account_info_request'
        invoice_details:
          $ref: '#/components/schemas/invoice_details'
        delivery:
          $ref: '#/components/schemas/delivery_order'
        consents:
          type: array
          description: consents list
          items:
            $ref: '#/components/schemas/consents_order'
    request_order_event:
      type: object
      required:
        - event_id
        - event_data_time
        - event_data
      properties:
        event_id:
          type: string
          description: event id
        event_data_time:
          type: string
          format: date-time
          description: event date time
        phone_number:
          $ref: '#/components/schemas/phone_number'
        event_data:
          $ref: '#/components/schemas/event_data'
    get_products:
      type: object
      required:
        - product_id
        - product_name
        - base_price
        - quantity
      properties:
        product_id:
          type: string
          description: product id
        product_category:
          type: string
          description: product category
        ean:
          type: string
          description: ean code
        product_name:
          type: string
          description: product name
        product_description:
          type: string
          description: product description
        product_link:
          type: string
          description: product link
        product_image:
          type: string
          description: product image
        additional_product_images:
          type: array
          description: additional product images. Object available in next version app
          items:
           $ref: '#/components/schemas/product_images'        
        base_price:
          $ref: '#/components/schemas/base_price'
        promo_price:
          $ref: '#/components/schemas/base_price'
        lowest_price:
          $ref: '#/components/schemas/base_price'
        quantity:
          $ref: '#/components/schemas/quantity'
        product_attributes:
          type: array
          description: product attributes
          items:
            $ref: '#/components/schemas/product_attributes'
        variantsdelivery_product:
          type: array
          description: variant additional delivery information for product ordered- listobject for use in next version app
    items:      items:
      $ref: '#/components/schemas/variants'
        delivery_product:           type: array
          description: additional delivery information for product - object for use in next version app
          items:
            $ref: '#/components/schemas/delivery_product'
    get_related_products:
      type: object
      required:
        - product_id
        - product_name
        - base_price
        - quantity
      properties:
        product_id:
          type: string
          description: product id
        product_category:
          type: string
          description: product category
        ean:
          type: string
          description: ean code
        product_name:
          type: string
          description: product name
        product_description:
          type: string
          description: product description
        product_link:
          type: string
          description: product link
        product_image:
          type: string
          description: product image
        additional_product_images:
          type: array
          description: additional product images. Object available in next version app
          items:
           $ref: '#/components/schemas/product_images'          
        base_price:
          $ref: '#/components/schemas/base_price'
        promo_price:
          $ref: '#/components/schemas/base_price'
        lowest_price:
          $ref: '#/components/schemas/base_price'
        quantity:
          $ref: '#/components/schemas/quantity'
        product_attributes:
          type: array
          description: product attributes
          items:
            $ref: '#/components/schemas/product_attributes'
        variants:
          type: array
          description: variant product ordered list
          items:
            $ref: '#/components/schemas/variants'
        delivery_related_products:
          type: array
          description: additional delivery information for product - object for use in next version app
          items:
            $ref: '#/components/schemas/delivery_related_products'    
    get_products_order:
      type: object
      required:
        - product_id
        - product_name
        - base_price
        - quantity
      properties:
        product_id:
          type: string
          description: product id
        product_category:
          type: string
          description: product category
        ean:
          type: string
          description: ean code
        product_name:
          type: string
          description: product name
        product_description:
          type: string
          description: product description
        product_link:
          type: string
          description: product link
        product_image:
          type: string
          description: product image
        additional_product_images:
          type: array
          description: additional product images. Object available in next version app
          items:
           $ref: '#/components/schemas/product_images'          
        base_price:
          $ref: '#/components/schemas/base_price'
        quantity:
          $ref: '#/components/schemas/quantity_order'
        product_attributes:
          type: array
          description: product attributes
          items:
            $ref: '#/components/schemas/product_attributes'
    consents:
   variants:   type: object
      typedescription: arrayConsents list
      required:
  description: variant product ordered list  - consent_id
       items: - consent_description
        - consent_version
$ref: '#/components/schemas/variants'     variants:  - requirement_type
   type: object    - consent_link
 description: variant product ordered  properties:
    required:    consent_id:
    - variant_id     type: string
  - variant_name       propertiesdescription: consent id
        variantconsent_idlink:
          type: string
          description: variantconsent idlink
        variantlabel_namelink:
          type: string
          description: variant name label link presented in app
        variantadditional_consent_descriptionlinks:
          type: stringarray
          description: variantObject descriptionto additional links on consents. Available in next  variant_type:version of app
          typeitems:
 string           description$ref: variant type'#/components/schemas/additional_consent_links'
         variantconsent_valuesdescription:
          type: string
          description: variantconsent valuesdescription
    consents:    consent_version:
  type: object       descriptiontype: Consentsstring
list       required:   description: consent version
      -  consent_idrequirement_type:
          type: string
          enum:
            - consent_descriptionOPTIONAL
            - consent_versionREQUIRED_ONCE
            - requirement_type
    REQUIRED_ALWAYS
          description: information on requirement consent
   - additional_consent_linklinks:
      type: object
      properties:
        consent_id:
          type: string
          description: consent id
        consent_link:
          type: string
          description: consent link
        label_link:
          type: string
          description: label link presented in app        
additional_consent_links:    delivery:
      type: object
 array     description: delivery information
      descriptionrequired:
 Object to additional links on consents. Available in- nextdelivery_type
version of app      - delivery_price
   items:     - delivery_date
      $ref: '#/components/schemas/additional_consent_links'properties:
        consentdelivery_descriptiontype:
          type: string
          description: consentdelivery descriptiontype (APM; COURIER)
      consent_version:    enum:
      type: string     - APM
           description: consent- versionCOURIER
        requirementdelivery_typedate:
          type: string
          enumformat: date-time
          description: -delivery OPTIONALdate
            - REQUIRED_ONCEdelivery_options:
          type: array
- REQUIRED_ALWAYS
          description: informationdelivery onoptions
requirement consent     additional_consent_links:    items:
  type: object       required:  $ref: '#/components/schemas/delivery_options'
     - consent_id  mail:
      - consent_link   type:  string
 properties:         consent_iddescription: emial
         typephone_number:
string           description: consent id$ref: '#/components/schemas/phone_number'
        consentdelivery_linkpoint:
          type: string
          description: APM consentdelivery linkpoint
        labeldelivery_linkaddress:
          type$ref: string'#/components/schemas/delivery_address'
        delivery_price:
 description:  label link presented in app   $ref: '#/components/schemas/base_price'
        deliverycourier_note:
      type: object   type: string
  description: delivery information       requireddescription: additional information for  courier
   - delivery_typeorder:
      type: object
- delivery_price     description: delivery information
 - delivery_date      required:
properties:        - delivery_type:
      properties:
   type:   string  delivery_type:
        description: delivery type: (APM;string
COURIER)           enum:
            - APM
            - COURIER
        delivery_date:          description: delivery type: string(APM; COURIER)
         format: date-time
          description: delivery date
        delivery_optionsdelivery_codes:
          type: array
          description: delivery options
          items:
            $ref: '#/components/schemas/delivery_optionscode'
        mail:
          type: string
          description: emialemail
        phone_number:
          $ref: '#/components/schemas/phone_number'
        delivery_point:
          type: string
          description: APM delivery point
        delivery_address:
          $ref: '#/components/schemas/delivery_address_request'
        deliverycourier_pricenote:
          $ref: '#/components/schemas/base_price'type: string
          description: additional information for courier_note:
    delivery_code:
      type: string
      description: payment type
   description: additional information forexample: courierPWW
    delivery_orderaddress:
      type: object
      description: delivery informationaddress
      required:
        - delivery_typename
       properties: - country_code
      delivery_type:  - address
       type: string- city
        - enum:postal_code
      properties:
     - APM  name:
          -type: COURIERstring
          description: delivery typename
(APM; COURIER)         deliverycountry_codescode:
          type: arraystring
          description: delivery options country code
        address:
          itemstype: string
          description: $ref: '#/components/schemas/delivery_code' address
        mailcity:
          type: string
          description: emailcity
        phonepostal_numbercode:
          $reftype: '#/components/schemas/phone_number' string
          delivery_pointdescription: postal code
     client_address:
  type: string   type: object
      description: APM delivery pointaddress
      required:
 delivery_address:       - country_code
   $ref: '#/components/schemas/delivery_address_request'    - address
   courier_note:     - city
    type: string   - postal_code
      descriptionproperties:
additional information for courier     deliverycountry_code:
          type: string
          description: paymentcountry typecode
      example: PWW address:
   delivery_address:       type: string
   object       description: delivery address
      required  city:
        - name type: string
      - country_code   description: city
    - address   postal_code:
     - city    type: string
   - postal_code       propertiesdescription: postal code
      name:
  delivery_basket_response:
       type: stringobject
      required:
   description:  name   - delivery_type
    country_code:    - delivery_price
     type: string  - delivery_date
       descriptionproperties:
country code         addressdelivery_type:
          type: string
          description: delivery type (APM; COURIER)
 address         cityenum:
            - type:APM
 string           description:- cityCOURIER
        postaldelivery_codedate:
          type: string
          descriptionformat: postaldate-time
code     client_address:     description: delivery type:date
object       description: delivery_options:
address       required:   type: array
    - country_code     description: delivery options
 - address        items:
- city         - postal_code    $ref: '#/components/schemas/delivery_options'
  properties:         country_codedelivery_price:
          type$ref: string'#/components/schemas/base_price'
          descriptionfree_delivery_minimum_gross_price:
country code         addresstype: number
         type format: stringdecimal
          description:  addressfree delivery minimum gross price
        cityestimate_delivery_time:
          type: stringarray
          description: cityestimate delivery time
       postal_code:   items:
       type: string    $ref: '#/components/schemas/delivery_time'      description: postal code
    delivery_basket_responseoptions:
      type: object
      description: additional delivery options
      required:
        - delivery_typename
        - delivery_pricecode_value
        - delivery_dateoption_price
      properties:
        delivery_typename:
          type: string
          description: delivery typename
(APM; COURIER)         example: Paczka w enum:Weekend
        delivery_code_value:
   - APM      type: string
     - COURIER    enum:
    delivery_date:      - COD
   type: string      - PWW
   format: date-time
          description: delivery datecode value. COD - option with payment  on delivery_options:, PWW - option with weekend   delivery
  type: array           descriptionexample: deliveryPWW
options           items:
 delivery_option_price:
          $ref: '#/components/schemas/deliverybase_optionsprice'
    basket_summary:
   delivery_price:   type: object
      $refrequired:
'#/components/schemas/base_price'        - freebasket_deliverybase_minimum_gross_price:
        - currency
type: number       - payment_type
  format: decimal   properties:
       description: free delivery minimum gross price basket_base_price:
           estimate_delivery_time:$ref: '#/components/schemas/base_price'
          typebasket_final_price:
array           description: estimate delivery time$ref: '#/components/schemas/base_price'
           itemsbasket_promo_price:
            $ref: '#/components/schemas/deliverybase_timeprice'
        currency:
   delivery_options:       type: objectstring
          description: basket currency
additional  delivery options       requiredenum:
            - delivery_name PLN
        free_basket:
          type: boolean
          description: flag  - delivery_code_valueinform if the basket without delivery costs is free            
        basket_expiration_date:
          type: string
          format: date- delivery_option_pricetime
          description: expiry date of basket
        basket_additional_information:
          type: string
          propertiesdescription: additional information
      delivery_name  payment_type:
          type: array
          description: payment type
          items:
            $ref: '#/components/schemas/payment_type'
        basket_notice:
          $ref: '#/components/schemas/information'
    payment_type:
      type: string
      description: payment type
      enum:
        - CARD
        - CARD_TOKEN
        - GOOGLE_PAY
        - APPLE_PAY
        - BLIK_CODE
        - BLIK_TOKEN
        - PAY_BY_LINK
        - SHOPPING_LIMIT
        - DEFERRED_PAYMENT
        - CASH_ON_DELIVERY
    summary:
      type: object
      required:
        - basket_base_price
        - currency
        - payment_type
      properties:
        basket_base_price:
          $ref: '#/components/schemas/base_price'
        basket_final_price:
          $ref: '#/components/schemas/base_price'
        basket_promo_price:
          $ref: '#/components/schemas/base_price'
        currency:
          type: string
          description: deliverybasket namecurrency
          exampleenum:
Paczka w Weekend         delivery_code_value: - PLN
        typefree_basket:
string           enumtype: boolean
         - CODdescription: flag inform if the basket without delivery costs is free - PWW          
description: delivery code value. COD - option with payment on delivery, PWW - option with weekend delivery
    basket_expiration_date:
          type: string
      example: PWW   format: date-time
    delivery_option_price:      description: expiry date of basket
$ref: '#/components/schemas/base_price'        basket_additional_summaryinformation:
      type: object       requiredtype: string
       - basket_base_price  description:       - currencyadditional information
        - payment_type:
      properties:    type: array
    basket_base_price:      description: payment type
  $ref: '#/components/schemas/base_price'       items:
 basket_final_price:           $ref: '#/components/schemas/basepayment_pricetype'
        basket_promo_pricenotice:
          $ref: '#/components/schemas/base_priceinformation'
        currency:
   invoice_details:
      type: stringobject
          descriptionproperties:
basket currency       legal_form:
   enum:       type: string
    - PLN     description: legal form  basket_expiration_date:of customer
          typeenum:
string           format: date-time PERSON
         description: expiry date of- basketCOMPANY
        basketcountry_additional_informationcode:
          type: string
          description: additionalcountry informationcode
        paymenttax_id_typeprefix:
          type: arraystring
          description: paymenttax typeid prefix
         itemstax_id:
          type: string
$ref: '#/components/schemas/payment_type'         basket_noticedescription: tax id
        $refcompany_name:
'#/components/schemas/information'     payment_type:       type: string
          description: paymentcompany typename
      enum:  name:
      - CARD   type: string
    - CARD_TOKEN     description:  name
 - GOOGLE_PAY      surname:
  - APPLE_PAY       type: string
- BLIK_CODE         - BLIK_TOKENdescription: surname
        city:
- PAY_BY_LINK         - SHOPPING_LIMITtype: string
        - DEFERRED_PAYMENT description: city
      - CASH_ON_DELIVERY street:
   summary:       type: objectstring
      required:    description: street
   - basket_base_price    building:
    - currency     type: string
  - payment_type       propertiesdescription: building
        basket_base_priceflat:
          $reftype: '#/components/schemas/base_price' string
          basket_final_pricedescription: flat
        postal_code:
$ref: '#/components/schemas/base_price'         basket_promo_price:type: string
          $refdescription: '#/components/schemas/base_price' postal code
        currencymail:
          type: string
          description: basketmail
currency           enumregistration_data_edited:
          type: string
- PLN         basket_expiration_datedescription: registration data edited
       type additional_information:
string           formattype: date-timestring
          description: expiry date of basketadditional information
    account_info:
      type: object
   basket_additional_information:   required:
       type: string- name
        - description:surname
additional information       -  paymentphone_type:number
        - client_address
type: array       - mail
  description: payment type  properties:
        itemsname:
          type: string
$ref: '#/components/schemas/payment_type'         basket_noticedescription: name
        surname:
 $ref: '#/components/schemas/information'     invoice_details:   type: string
  type: object       propertiesdescription: surname
        legalphone_formnumber:
          type$ref: string'#/components/schemas/phone_number'
        mail:
 description: legal form of customer     type: string
    enum:      description: mail
     - PERSON  client_address:
          - COMPANY$ref: '#/components/schemas/client_address'
    consents_order:
   country_code:   type: object
      typedescription: stringconsents order list
        descriptionrequired: country
code        - taxconsent_id_prefix:
        - consent_version
 type: string      - is_accepted
   description: tax id prefixproperties:
        taxconsent_id:
          type: string
          description: taxconsent id
        companyconsent_nameversion:
          type: string
          description: companyconsent nameversion
        nameis_accepted:
          type: stringboolean
          description: nameis accepted consent
      surnameresponse_orders_details:
      type: object
  type: string   required:
       description: surname- order_id
       city: - order_creation_date
        type: string- basket_id
        - payment_status
description: city       -  street:order_merchant_status_description
        - payment_type
 type: string      - order_base_price
   description: street    - order_final_price
   building:     - currency
    type: string   - pos_id
      descriptionproperties:
building         flatorder_comments:
          type: string
          description: flatorder comments
        postalorder_codeid:
          type: string
          description: postalorder codeid
        mailcustomer_order_id:
          type: string
          description: mail
        registration_data_edited:
    order ID presented to customer and used for payment. In case of lack of customer_order_id order_id will be used.     
 type: string      pos_id:
    description: registration data edited   type: string
    additional_information:      description: POS identifier provided by type:Vodeno, stringallowing merchant to filter payments in the reporting tools
  description: additional information     account_infoorder_creation_date:
      type: object   type: string
  required:        format: date-time
name         - surnamedescription: order creation date
     - phone_number  basket_id:
      - client_address   type: string
    - mail     description: basket properties:id
        nameorder_merchant_status_description:
          type: string
          description: nameorder merchant status description
        surnamepayment_type:
          type: string
          description: order status
 surname         phone_numberenum:
          $ref: '#/components/schemas/phone_number'  - CARD
        mail:    - CARD_TOKEN
     type: string      - GOOGLE_PAY
   description: mail        - client_address:APPLE_PAY
            $ref: '#/components/schemas/client_address'- BLIK_CODE
      consents_order:      - type:BLIK_TOKEN
object       description: consents order list  - PAY_BY_LINK
   required:         - consent_idSHOPPING_LIMIT
            - consentDEFERRED_versionPAYMENT
        - is_accepted   - CASH_ON_DELIVERY
  properties:         consent_id: - FREE_ORDER
        typeorder_base_price:
string          type: description:object
consent id         consent_versiondescription: price for order without delivery costs
    type: string     required:
     description: consent version     - net
  is_accepted:          - type:gross
boolean           description: is- acceptedvat
consent     response_orders_details:     properties:
 type: object       required:   net:
     - order_id        type: -number
order_creation_date         - basket_id    format: decimal
   - payment_status         - order_merchant_status_description: net price
      - payment_type     gross:
   - order_base_price         - order_final_price
 type: number
       - currency      format: decimal
 - pos_id       properties:     description: gross price
 order_comments:           typevat:
string            description: order commentstype: number
       order_id:       format: decimal
  type: string           description: orderVAT
id         customerorder_orderfinal_idprice:
          type: stringobject
          description: total order IDprice presentedwith todelivery customercosts
and used for payment. In case of lack of customer_order_id order_id will be used. required:
            - net
  pos_id:          - type:gross
string           description: POS- identifiervat
provided by Vodeno, allowing merchant to filter payments in the reportingproperties:
tools         order_creation_date:    net:
      type: string       type: number
  format: date-time           descriptionformat: orderdecimal
creation date         basket_id:    description: net price
    type: string       gross:
   description: basket id         order_merchant_status_descriptiontype: number
         type: string    format: decimal
     description: order merchant status description     description: gross price
 payment_type:           typevat: string
          description: order status  type: number
       enum:       format: decimal
    - CARD         description: VAT
  - CARD_TOKEN     order_discount:
       - GOOGLE_PAY  type: number
         - APPLE_PAYformat: decimal
          description: -Value BLIK_CODEused discount coupons on order       
 - BLIK_TOKEN      currency:
      - PAY_BY_LINK   type: string
        - SHOPPING_LIMIT description: basket currency
         - DEFERRED_PAYMENTenum:
            - CASH_ON_DELIVERYPLN
        orderdelivery_basereferences_pricelist:
          type: objectarray
          description: pricedelivery forreferences orderlist
without delivery costs           requireditems:
            - net$ref: '#/components/schemas/delivery_references'
    delivery_references:
      type: -string
gross      description: delivery references
    - vatrequest_orders_details:
          propertiestype: object
      required:
    net:    - basket_id
        - payment_type:
number        - currency
     format: decimal  - basket_price
      properties:
    description: net price  order_comments:
          grosstype: string
          description: order information
type: number       basket_id:
       format: decimal  type:  string
          description: basket grossid
price        currency:
    vat:      type: string
       type: number  description: basket currency
          formatenum:
decimal            - PLN
 description: VAT         order_finalbasket_price:
          type: object
          description: total orderbasket price
with delivery costs
          required:
            - net
            - gross
            - vat
          properties:
            net:
              type: number
              format: decimal
              description: net price
            gross:
              type: number
              format: decimal
              description: gross price
            vat:
              type: number
              format: decimal
              description: VAT
        orderpayment_discounttype:
          type: numberstring
          formatdescription: payment decimaltype
          descriptionenum: Value used discount coupons on order
            - CARD
            - CARD_TOKEN
            - GOOGLE_PAY
            - APPLE_PAY
            - BLIK_CODE
          currency:  - BLIK_TOKEN
       type: string    - PAY_BY_LINK
     description: basket currency     - SHOPPING_LIMIT
    enum:        - DEFERRED_PAYMENT
   - PLN        - deliveryCASH_referencesON_list:DELIVERY
          type: array - FREE_ORDER
    promo_codes:
   description: delivery references listtype: object
      description: promo code
items:      required:
       $ref: '#/components/schemas/delivery_references'
 - name
   delivery_references:     - promo_code_value
type: string     properties:
 description: delivery references     request_orders_detailsname:
      type: object   type: string
  required:        description: -promo basket_idcode name
       - payment_typepromo_code_value:
        - currency type: string
      - basket_price    description: promo code properties:value
        orderregulation_commentstype:
          type: string
          description: orderlegal informationregulation for a promotional code for example. If the basket_id:promo code is regulated by the Omnibus Directive then pass "OMNIBUS"
type: string         example: OMNIBUS description: basket id        
currency:    product_attributes:
      type: stringobject
      description: product attributes
      descriptionrequired:
basket currency       - attribute_name
  enum:      - attribute_value
     - PLNproperties:
        basketattribute_pricename:
          type: objectstring
          description: totalattribute basketname
price        attribute_value:
  required:        type: string
   - net      description: attribute value
    -event_data:
gross      type: object
     - vatdescription: Data on events
       properties:
        payment_status:
   net:       type: string
          typedescription: payment status. numberAUTHORIZED - payment successfully completed
          formatenum:
decimal            - AUTHORIZED
 description: net price     order_status:
       gross:   type: string
          typedescription: numberorder status
          enum:
  format: decimal         - ORDER_REJECTED
    description: gross price  payment_id:
          vattype: string
          description: payment id
type: number       payment_reference:
       format: decimal  type:  string
          description: payment VATreference
        payment_type:
          type: string
          description: payment type
          enum:
            - CARD
            - CARD_TOKEN
            - GOOGLE_PAY
            - APPLE_PAY
            - BLIK_CODE
            - BLIK_TOKEN
            - PAY_BY_LINK
            - SHOPPING_LIMIT
            - DEFERRED_PAYMENT
            - CASH_ON_DELIVERY
       promo_codes: payment_additional_parameters:
          type: array
   object       descriptionitems: promo code       
         required:  $ref: '#/components/schemas/payment_additional_parameter'      - name     
   - promo_code_valuebase_price:
      propertiestype: object
       namedescription: price information
      required:
 type: string      - net
   description: promo code name  - gross
     promo_code_value:   - vat
      typeproperties:
string        net:
  description: promo code value     product_attributestype: number
     type: object    format: decimal
 description: product attributes       requireddescription: net price
      - attribute_name gross:
       - attribute_value  type: number
   properties:       format: decimal
attribute_name:           typedescription: stringgross price
         descriptionvat:
attribute name         attribute_valuetype: number
          typeformat: stringdecimal
          description: attributeVAT
value     event_dataquantity:
      type: object
      description: Dataproduct onquantity eventsinformation
      propertiesrequired:
        payment_status:- quantity
         typeproperties:
string           description: payment status. AUTHORIZED - payment successfully completedquantity:
              enumtype: number
          description: -product AUTHORIZEDquantity
        orderquantity_statustype:
          type: string
          description: product orderquantity statustype
          enum:
            - ORDER_REJECTED DECIMAL
            - INTEGER
        paymentquantity_idunit:
          type: string
          description: paymentunit idquantity
        paymentavailable_referencequantity:
          type: stringnumber
          descriptionformat: paymentdecimal
 reference         payment_typedescription: product quantity available
        typemax_quantity:
string           descriptiontype: payment typenumber
          enumformat: decimal
          description: -maximum CARDproduct quantity
        min_quantity:
  - CARD_TOKEN       type: number
    - GOOGLE_PAY     format: decimal
      - APPLE_PAY   description: minimum product quantity. Field available in next version app
- BLIK_CODE       quantity_jump:
     - BLIK_TOKEN    type: number
       - PAY_BY_LINK  format: decimal
         - SHOPPING_LIMITdescription: quantity jump value in case of increase/decrease of product quantity by customer - DEFERRED_PAYMENT
   (e.g. 0.1 or 0.5 or 0.01)         - CASH_ON_DELIVERY 
    basequantity_priceevent:
      type: object
      description: priceproduct informationquantity
      required:
         - netquantity       
 - gross    properties:
    - vat   quantity:
   properties:       type: number
net:           typedescription: numberproduct quantity
         formatquantity_type:
decimal          type: description:string
net price         grossenum:
          type:- numberDECIMAL
          format:- decimalINTEGER
          description: product grossquantity pricetype
        vatquantity_unit:
          type: numberstring
          formatdescription: decimalunit quantity          description: VAT
    quantity_order:
      type: object
      description: product quantity information
      required:
        - quantity
      properties:
        quantity:
          type: number
          description: product quantity
        quantity_type:
          type: string
          descriptionenum:
product quantity type          - enum:DECIMAL
            - DECIMALINTEGER
          description: product -quantity INTEGERtype
        quantity_unit:
          type: string
          description: unit quantity
        available_quantityphone_number:
          type: numberobject
          formatdescription: decimalphone number
         descriptionrequired:
product quantity available      -   max_quantity:
          type: number
          format: decimalcountry_prefix
          description: maximum product quantity   - phone
    min_quantity:  properties:
        typecountry_prefix:
number           formattype: decimalstring
          description: prefix
  minimum  product quantity. Field available in next version appexample: '+48'
        quantity_jumpphone:
          type: numberstring
          formatexample: decimal600123123
    information:
      descriptiontype: object
quantity jump value in case of increase/decreaserequired:
of product quantity by customer (e.g. 0.1 or 0.5- ortype
0.01)        - description
     quantity_event: properties:
        type:
object       description: product quantity type: string
    required:      enum:
   - quantity        - ATTENTION
    properties:        - quantity:ERROR
          typedescription: numbertype additional notice
        description:
product quantity         quantity_type: string
         type description: stringbasket additional notice
        enumresponse_order_event_merchant:
      type: object
  - DECIMAL   properties:
       - INTEGER order_merchant_status_description:
          descriptiontype: productstring
quantity type         quantity_unitdescription: order merchant status description
        typedelivery_references_list:
string           descriptiontype: unitarray
quantity          description: delivery references list
 quantity_order:       type: object  items:
    description: product quantity       required$ref: '#/components/schemas/delivery_references'
    address_details:
  - quantity   description: This is auto-generated properties:object from single line user input. Correctness of the quantity:data is not  guaranteed.
      type: numberobject
          descriptionproperties:
product quantity         quantity_typestreet:
          type: string
          enumdescription: street
        building:
  - DECIMAL       type: string
    - INTEGER     description: Building number. Populated with "_" if not description:found productin quantitythe typeaddress.
        quantity_unitflat:
          type: string
          description: unitflat
quantity     phone_numberaccount_info_request:
      type: object
      descriptionrequired:
 phone number      - required:name
        - country_prefixsurname
        - phone_number
        - client_address
     properties:   - mail
    country_prefix:  properties:
        typename:
string           descriptiontype: prefixstring
          exampledescription: '+48'name
        phonesurname:
          type: string
          exampledescription: surname
   600123123     informationphone_number:
      type: object   $ref: '#/components/schemas/phone_number'
  required:      mail:
  -   type     type: string
  - description       propertiesdescription: mail
       type client_address:
          type: string$ref: '#/components/schemas/client_address_request'
    client_address_request:
      enumtype: object
      description: delivery address
  - ATTENTION    required:
        - ERRORcountry_code
        - address
description: type additional notice     - city
  description:      - postal_code
   type: string  properties:
        descriptioncountry_code:
basket additional notice     response_order_event_merchant:   type: string
  type: object       propertiesdescription: country code
        order_statusaddress:
          type: string
          description:  orderaddress
status - Merchant can change order status to; ORDER_COMPLETED - order completed in merchant's shop, ORDER_REJECTED - order rejected by merchantaddress_details:
          $ref: '#/components/schemas/address_details'
    enum:    city:
        - ORDER_COMPLETED type: string
          - ORDER_REJECTEDdescription: city
        order_merchant_status_descriptionpostal_code:
          type: string
          description: order merchant status description
postal code
       delivery_referencesaddress_listrequest:
          type: array
   object
      description: delivery referencesaddress
list      required:
    items:    - name
       $ref: '#/components/schemas/delivery_references'
    address_details: - country_code
      description: This is auto-generated objectaddress
from single line user input. Correctness of the data- iscity
not guaranteed.       type: object- postal_code
      properties:
        streetname:
          type: string
          description: street name
        buildingcountry_code:
          type: string
          description: Buildingcountry number.code
Populated with "_" if not found in the address.:
          flattype: string
          typedescription: string address
         descriptioncity: flat
    account_info_request:       type: string
   object       requireddescription: city
       - namepostal_code:
        - surname type: string
      - phone_number   description: postal code
   - client_address    address_details:
    - mail     $ref:  properties:'#/components/schemas/address_details' 
    delivery_product:
   name:   type: object
      typedescription: stringadditional delivery information for product
      descriptionproperties:
name         surnamedelivery_type:
          type: string
          description: surnamedelivery type (APM; COURIER)
     phone_number:     enum:
     $ref: '#/components/schemas/phone_number'      - APM
 mail:           type:- stringCOURIER
        if_delivery_available:
 description: mail         client_addresstype: boolean
           $ref: '#/components/schemas/client_address_request'description: if type of delivery available for product
    clientdelivery_addressrelated_requestproducts:
      type: object
      description: additional delivery addressinformation for product
    required:         - country_codeproperties:
        delivery_type:
- address         -type: citystring
        - postal_code description: delivery type (APM; COURIER)
 properties:         country_code:enum:
            - type:APM
string           description: country- codeCOURIER
        addressif_delivery_free:
          type: stringboolean
          description: is free  addressdelivery for a type of delivery
        addressif_delivery_detailsavailable:
          $reftype: '#/components/schemas/address_details'boolean
        city:  description: if type of delivery available for product
 type: string  product_images:
        descriptiontype: cityobject
        postal_codedescription: additional product images
       typerequired:
string        - small_size
 description: postal code     delivery_address_request:- normal_size      
 type: object    properties:   description: delivery address 
     required:   small_size:
     - name    type: string
   - country_code      description: product image. -Preferred addresssize 360 x 352
     - city  normal_size:
      - postal_code   type: string
  properties:        description: name:product image. Preferred size 360 x 504
    typecookies:
string       required:
   description:  name   - domain
    country_code:    - keyValue
     type: string  - key
       description: country- codevalue
        address:-   path
       type: stringobject
          descriptionproperties: 
address         citydomain:
          type: string
          description: cityDomain of the cookie represented by pair key-value
 postal_code:           typeexample: string"uat.outofthebox.pl"
          descriptionkey:
postal code         address_detailstype: string
         $ref description: '#/components/schemas/address_details' Cookie key
     delivery_product:     example:  type: object"wp_woocommerce_session_f3cd21b400c074e165b59837d7a9d0a4"
        descriptionvalue: additional
delivery information for product       propertiestype: string
       delivery_type:   description: Cookie value
     type: string    example: "t_f13664beda2ec455d97546c1ddab8b%7C%7C1699438060%7C%7C1699434460%7C%7Cf77d310ce1f0440cb4812f5043736989"
     description: delivery type (APM; COURIER)path:
           enumtype:   string
         - APMdescription: Cookie path
          - COURIERexample: "/"
        if_delivery_availableexpires:
           type: booleanstring
           description: ifCookie typeexpiration oftime deliveryor availablemaxAge
for product     delivery_related_products:    example: "2025-01-16T14:17:02.486Z"
 type: object       descriptionsecure:
additional delivery information for product       propertiestype: boolean
       delivery_type:   description: Cookie security information
    type: string     example: false
    description: delivery type (APM; COURIER) http_only:
          enumtype: boolean
          description: -Cookie APMhttp information
          example: -true
COURIER         if_delivery_freesame_site:
          type: booleanstring
          descriptionenum:
 is free delivery for a type of delivery    - STRICT
   if_delivery_available:         - LAX
type: boolean           description:- ifNONE
type of delivery available for product     product_images:description: Cookie sameSite information
          typeexample: object"LAX"
        descriptionpriority:
additional  product images       requiredtype: string
        - small_size enum:
       - normal_size    - LOW
       properties:     - MEDIUM
        small_size:    - HIGH
     type: string    description: Cookie priority
    description: product image. Preferred size 360 x 352example: "MEDIUM"
        normalmax_sizeage:
          type: stringinteger
          description: productCookie image.max Preferredage
size 360 x 504     cookies:  example: 0
    requireddelivery_time:
       required:
- domain       - description - keyValue  
      - keytype: object
       -properties:
value        description:
-  path        type: string
 object         propertiesdescription: message present to customer in inpostpay app
 domain:         example: "Kup do type15:00 string- dostawa jutro"
        descriptiondays_available:
 Domain    of the cookie represented by pair key-valuetype: array
          exampledescription: "uat.outofthebox.pl"
        key:days of week on which delivery information is to be present
          typeitems:
string            description: Cookie key
  $ref: '#/components/schemas/day'        example: "wp_woocommerce_session_f3cd21b400c074e165b59837d7a9d0a4"
        valuestart_hour:
          type: string
          description: Cookie valuestart time of presentation of delivery date app
          example: "t_f13664beda2ec455d97546c1ddab8b%7C%7C1699438060%7C%7C1699434460%7C%7Cf77d310ce1f0440cb4812f504373698910:00"
        pathend_hour:
          type: string
          description: Cookieend pathtime of presentation of delivery date app
    example: "/"     example: "15:00" 
 expires:    day:
      type: string
      description: day
   description: Cookie expiration time or maxAge
    example: "MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY"
     example: "2025-01-16T14:17:02.486Z" enum:
        secure:    - MONDAY
     type: boolean      - TUESDAY
   description: Cookie security information      - WEDNESDAY
   example: false        - http_only:THURSDAY
          type: boolean - FRIDAY
        description: Cookie http information - SATURDAY
        example: true   - SUNDAY
    same_sitepromotion:
     required:
      type: string - type
        enum:- promo_code_value
        - description
  - STRICT     - details
     type: -object
LAX     properties:
       - NONEtype:
          descriptiontype: Cookiestring
sameSite information         description: type example: "LAX"
        priority:
          type: stringproco code. MERCHANT - merchant promo code;  ONLY_IN_APP - merchant promo code which is only available in the InPost pay app 
          enum:

           - LOWMERCHANT
            - MEDIUMONLY_IN_APP
        promo_code_value:
   - HIGH      type: string
   description: Cookie priority     description: promo code value
  example: "MEDIUM"         max_agedescription:
          type: integerstring
          description: description
 Cookie max age       maxLength: 60
  example: 0     deliverystart_timedate:
          requiredtype: string
       -   description: image url
         type: object format: date-time          properties:
        descriptionend_date:
          type: string
          description: messageimage presenturl
to customer in inpostpay app           example: "Kup do 15:00 - dostawa jutro"format: date-time          days_available:   
        typepriority: array
          descriptiontype: daysinteger
of week on which delivery information is to be present description: image url
       items details:
            $ref: '#/components/schemas/daydetails'
       
        start_hourdetails:
          type: stringobject
      required:
   description: start time of presentation of- deliverylink date app    
      example: "10:00"properties:
        end_hourlink:
          type: string
          description: endlink timeto ofdetails presentation of delivery date app      
    example: "15:00" payment_additional_parameter:
    day:       type: stringobject
      description: daypayment additional  parameter
   example: "MONDAY, TUESDAY, WEDNESDAY,required:
THURSDAY, FRIDAY, SATURDAY, SUNDAY"       enum:
     - key
      - MONDAYvalue
      properties:
     - TUESDAY  key:
          -type: WEDNESDAYstring
          description: key
- THURSDAY       value:
     - FRIDAY    type: string
       - SATURDAY  description: value          - SUNDAY