Page Comparison

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

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: variantadditional delivery information for product ordered- listobject for use in next version app
    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'
        variantsdelivery_related_products:
          type: array
          description: variant product ordered list additional delivery information for product - object for use in next version app
          items:
            $ref: '#/components/schemas/variantsdelivery_related_products'    
    deliveryget_relatedproducts_productsorder:
      type: object
      typerequired:
array        - product_id
  description: additional delivery information for product - objectproduct_name
for use in next version app   - base_price
      items:  - quantity
      properties:
  $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
         descriptionrequired:
variant product ordered list     - consent_id
    items:    - consent_description
       $ref: '#/components/schemas/variants'
 - consent_version
   variants:     -  requirement_type: object
      description: variant product- orderedconsent_link
      requiredproperties:
        - variantconsent_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: Object variantto descriptionadditional links on consents. Available in next version of variant_type: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_id    requirement_type:
    - consent_description     type: string
  -  consent_version      enum:
  - requirement_type         - consent_linkOPTIONAL
      properties:      - REQUIRED_ONCE
 consent_id:           type: string- REQUIRED_ALWAYS
          description: consentinformation idon requirement consent
      additional_consent_linklinks:
          type: stringobject
          descriptionproperties:
consent link         label_linkid:
          type: string
          description: label link presented in appconsent id
        additional_consent_linkslink:
          type: arraystring
          description: consent link
Object to additional links on consents. Available in nextlabel_link:
version of app        type: string
 items:         description: label link presented $ref: '#/components/schemas/additional_consent_links'in app        
consent_description:    delivery:
      type: stringobject
      description: delivery information
      descriptionrequired:
consent  description      - delivery_type
 consent_version:       - delivery_price
  type: string     - delivery_date
    description: consent versionproperties:
        requirementdelivery_type:
          type: string
          enumdescription: delivery type (APM; COURIER)
         - OPTIONALenum:
            - REQUIRED_ONCEAPM
            - REQUIRED_ALWAYSCOURIER
        delivery_date:
 description: information on requirement consent     additional_consent_linkstype: string
     type: object    format: date-time
 required:         - consent_id
description: delivery date
       - consent_linkdelivery_options:
          propertiestype: array
          consent_id:description: delivery options
          typeitems:
string            description$ref: consent id'#/components/schemas/delivery_options'
         consent_linkmail:
          type: string
          description: consentemial
link         labelphone_linknumber:
          type$ref: string'#/components/schemas/phone_number'
          descriptiondelivery_point:
label link presented in app      type: string
     delivery:       typedescription: objectAPM delivery point
    description: delivery information  delivery_address:
    required:         - delivery_type$ref: '#/components/schemas/delivery_address'
        - delivery_price:
        - delivery_date $ref: '#/components/schemas/base_price'
    properties:         delivery_typecourier_note:
          type: string
          description: deliveryadditional information typefor (APM;courier
COURIER)    delivery_order:
      enumtype: object
      description: delivery information
  - APM   required:
        - delivery_type
     - COURIERproperties:
        delivery_datetype:
          type: string
          format: date-timeenum:
            - APM
            - COURIER
          description: delivery date type (APM; COURIER)
        delivery_optionscodes:
          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:
          $reftype: '#/components/schemas/base_price' 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 type (APM; COURIER) name
        deliverycountry_codescode:
          type: arraystring
          description: delivery optionscountry 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: APMdelivery deliveryaddress
point      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: payment type  description: country code
  example: PWW     delivery_address:
      type: object   type: string
  description: delivery address       requireddescription:  address
      - name city:
       - country_code  type: string
     - address         -description: city
        - postal_code:
      properties:         name:
          type: type: string
          description: postal namecode
        country_code:
delivery_basket_response:
         type: stringobject
      required:
   description: country code   - delivery_type
    address:    - delivery_price
     type: string  - delivery_date
       descriptionproperties:
 address         citydelivery_type:
          type: string
          description: city delivery type (APM; COURIER)
          postal_codeenum:
          type: string - APM
        description: postal code  - COURIER
 client_address:       typedelivery_date:
object       description: delivery address type: string
    required:      format:   date-time
country_code         - addressdescription: delivery date
      - city delivery_options:
       - postal_code  type: array
   properties:       description: delivery country_code:options
          typeitems:
string            description$ref: country code'#/components/schemas/delivery_options'
         addressdelivery_price:
          type$ref: string'#/components/schemas/base_price'
          descriptionfree_delivery_minimum_gross_price:
 address         citytype: number
          typeformat: stringdecimal
          description: city free delivery minimum gross price
        postalestimate_delivery_codetime:
          type: stringarray
          description: postal code estimate delivery time
          items:
            $ref: delivery_basket_response'#/components/schemas/delivery_time'        
    delivery_options:
      type: object
      description: additional delivery options
      required:
        - delivery_typename
        - delivery_code_pricevalue
        - delivery_dateoption_price
      properties:
        delivery_typename:
          type: string
          description: delivery typename
(APM; COURIER)           enumexample: Paczka w Weekend
        delivery_code_value:
- APM         type: string
  - COURIER         delivery_dateenum:
          type:- stringCOD
          format: date-time- PWW
          description: delivery datecode value. COD - option with payment on delivery, PWW - option with weekend delivery
          example: PWW
  delivery_options:      delivery_option_price:
          $ref: '#/components/schemas/base_price'
    basket_summary:
      type: array object
      required:
        - basket_base_price
        - currency
        - payment_type
      descriptionproperties:
delivery options        basket_base_price:
          items$ref: '#/components/schemas/base_price'
        basket_final_price:
          $ref: '#/components/schemas/delivery_options'base_price'
        basket_promo_price:
          $ref: '#/components/schemas/base_price'
        currency:
          type: string
          description: basket currency
          enum:
            - PLN
        free_basket:
          type: boolean
          description: flag inform if the basket without delivery costs is free            
        basket_expiration_date:
          type: string
          format: date-time
          description: expiry date of basket
        basket_additional_information:
          type: string
          description: additional information
        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: basket currency
          enum:
            - PLN
        free_basket:
          type: boolean
          description: flag inform if the basket without delivery costs is free            
        basket_expiration_date:
          type: string
          format: date-time
          description: expiry date of basket
        basket_additional_information:
          type: string
          description: additional information
        payment_type:
          type: array
          description: payment type
          items:
            $ref: '#/components/schemas/payment_type'
        basket_notice:
          $ref: '#/components/schemas/information'
    invoice_details:
      type: object
      properties:
        legal_form:
          type: string
          description: legal form of customer
          enum:
            - PERSON
            - COMPANY
        country_code:
          delivery_pricetype: string
          $refdescription: '#/components/schemas/base_price'country code
        freetax_delivery_minimum_gross_priceid_prefix:
          type: numberstring
          formatdescription: decimaltax id prefix
        descriptiontax_id:
  free delivery minimum gross price    type: string
         delivery_options: description: tax id
        type: objectcompany_name:
          descriptiontype: additionalstring
delivery options       required:  description: company name
    - delivery_name   name:
     - delivery_code_value    type: string
   - delivery_option_price      description: properties:name
        delivery_namesurname:
          type: string
          description: delivery name surname
        city:
          exampletype: Paczkastring
w Weekend         delivery_code_value:description: city
        street:
  type: string       type: string
  enum:        description: street
 - COD      building:
    - PWW     type: string
    description: delivery code value. COD - optiondescription: withbuilding
payment on delivery, PWW - option with weekend deliveryflat:
          exampletype: PWWstring
        delivery_option_price:  description: flat
       $ref: '#/components/schemas/base_price' postal_code:
    basket_summary:       type: string
object       required:   description: postal code
   - basket_base_price    mail:
    - currency     type: string
  - payment_type       propertiesdescription: mail
        basketregistration_basedata_priceedited:
          $reftype: '#/components/schemas/base_price' string
          basket_final_pricedescription: registration data edited
       $ref additional_information:
'#/components/schemas/base_price'          basket_promo_price:type: string
          $refdescription: '#/components/schemas/base_price'additional information
    account_info:
   currency:   type: object
      typerequired:
string        - name
 description:  basket currency    - surname
     enum:   - phone_number
        - PLN client_address
        - mail
    basket_expiration_date:  properties:
        typename:
string           formattype: date-timestring
          description: expiry date ofname
basket         basket_additional_informationsurname:
          type: string
          description: additionalsurname
information         paymentphone_typenumber:
          type$ref: array'#/components/schemas/phone_number'
          descriptionmail: payment
type           itemstype: string
           $refdescription: '#/components/schemas/payment_type'mail
        basketclient_noticeaddress:
          $ref: '#/components/schemas/informationclient_address'
    paymentconsents_typeorder:
      type: stringobject
      description: consents paymentorder typelist
      enumrequired:
        - CARDconsent_id
        - CARDconsent_TOKENversion
        - GOOGLE_PAY
is_accepted
      properties:
       - APPLE_PAY
consent_id:
          type: string
          description: consent id
       - BLIK_CODEconsent_version:
          type: string
          - BLIK_TOKEN
description: consent version
       - PAY_BY_LINKis_accepted:
         - SHOPPING_LIMITtype: boolean
       - DEFERRED_PAYMENT  description: is accepted consent
   - CASHresponse_ON_DELIVERYorders_details:
      summarytype: object
      typerequired:
  object      - required:order_id
        - basketorder_basecreation_pricedate
        - currencybasket_id
        - payment_typestatus
      properties:  - order_merchant_status_description
     basket_base_price:   - payment_type
       $ref: '#/components/schemas/ - order_base_price'
        - basketorder_final_price:
        -  $ref: '#/components/schemas/base_price'currency
        - basket_promo_price:pos_id
          $refproperties:
'#/components/schemas/base_price'         currencyorder_comments:
          type: string
          description: basket currencyorder comments
        order_id:
          enumtype: string
          description: -order PLNid
        basketcustomer_expirationorder_dateid:
          type: string
          format: date-time
          description: expiry date of basketdescription: order ID presented to customer and used for payment. In case of lack of customer_order_id order_id will be used.     
        basketpos_additional_informationid:
          type: string
          description: additionalPOS informationidentifier provided by Vodeno, allowing merchant to filter payments in payment_type:the reporting tools
        typeorder_creation_date:
array           descriptiontype: paymentstring
type           items:format: date-time
          description: order $ref: '#/components/schemas/payment_type'creation date
        basket_noticeid:
          $reftype: '#/components/schemas/information'string
    invoice_details:       typedescription: objectbasket id
     properties:         legal_formorder_merchant_status_description:
          type: string
          description: legalorder formmerchant ofstatus customerdescription
          enumpayment_type:
            - PERSON
    type: string
       - COMPANY  description: order status
    country_code:      enum:
    type: string       - CARD
  description: country code        - tax_id_prefix:CARD_TOKEN
          type: string - GOOGLE_PAY
         description: tax id prefix- APPLE_PAY
       tax_id:     - BLIK_CODE
    type: string       - BLIK_TOKEN
  description: tax id        - company_name:PAY_BY_LINK
          type: string - SHOPPING_LIMIT
        description: company name  - DEFERRED_PAYMENT
     name:       - CASH_ON_DELIVERY
  type: string         - FREE_ORDER
description: name         surnameorder_base_price:
          type: stringobject
          description: surnameprice for order without delivery costs
   city:       required:
   type: string        - net
 description: city         street: - gross
        type: string   - vat
      description: street   properties:
     building:       net:
   type: string           descriptiontype: buildingnumber
        flat:      format: decimal
   type: string           description: flatnet         postal_code:price
            typegross:
 string           description: postal codetype: number
       mail:       format: decimal
  type: string           description: gross mailprice
        registration_data_edited:    vat:
      type: string       type: number
  description: registration data edited         additional_informationformat: decimal
         type: string    description: VAT
     description: additional information order_final_price:
   account_info:       type: object
      required:    description: total order price with -delivery namecosts
        - surname required:
       - phone_number    - net
   - client_address        - -gross
mail       properties:     - vat
  name:        properties:
  type: string         net:
 description: name         surname:   type: number
      type: string       format: decimal
  description: surname         phone_number:  description: net price
      $ref: '#/components/schemas/phone_number'     gross:
   mail:           type: stringnumber
          description: mail   format: decimal
     client_address:         description: gross $ref: '#/components/schemas/client_address'price
     consents_order:       typevat:
  object       description: consents order list  type: number
   required:         - consent_id format: decimal
      - consent_version       description: VAT
- is_accepted       propertiesorder_discount:
        consent_id:  type: number
          typeformat: stringdecimal
          description: consent id Value used discount coupons on order       
        consent_versioncurrency:
          type: string
          description: basket consentcurrency
 version         is_acceptedenum:
          type: boolean - PLN
        descriptiondelivery_references_list:
is accepted consent     response_orders_details:   type: array
  type: object       requireddescription: delivery references list
     - order_id    items:
    - order_creation_date       $ref:  - basket_id'#/components/schemas/delivery_references'
    delivery_references:
      type: string
-   payment_status   description: delivery references
   - orderrequest_merchant_status_descriptionorders_details:
      type: object
     - payment_typerequired:
        - orderbasket_base_priceid
        - orderpayment_final_pricetype
        - currency
        - posbasket_idprice
      properties:
        order_comments:
          type: string
          description: order commentsinformation
        orderbasket_id:
          type: string
          description: orderbasket id
        customer_order_idcurrency:
          type: string
          description: orderbasket currency
  ID presented to customer and used for payment. Inenum:
case of lack of customer_order_id order_id will be used.    - PLN
        posbasket_idprice:
          type: stringobject
          description: POStotal identifierbasket providedprice
by Vodeno, allowing merchant to filter payments in the reporting toolsrequired:
        order_creation_date:    - net
     type: string      - gross
   format: date-time           description:- ordervat
creation date         basket_idproperties:
          type: string
          description net:
basket id         order_merchant_status_description:           type: stringnumber
          description: order merchant status description
        payment_type:format: decimal
           type: string  description: net price
      description: order status    gross:
      enum:        type: number
   - CARD          format: decimal
 - CARD_TOKEN            description: -gross GOOGLE_PAYprice
            -vat:
APPLE_PAY             - BLIK_CODEtype: number
           - BLIK_TOKEN  format: decimal
         - PAY_BY_LINK    description: VAT
       - SHOPPINGpayment_LIMITtype:
          type: string
- DEFERRED_PAYMENT         description: payment type
 -  CASH_ON_DELIVERY       enum:
 order_base_price:           type:- objectCARD
          description: price for- orderCARD_TOKEN
without delivery costs          - required:GOOGLE_PAY
            - netAPPLE_PAY
            - grossBLIK_CODE
            - vatBLIK_TOKEN
          properties:  - PAY_BY_LINK
         net:   - SHOPPING_LIMIT
          type: number - DEFERRED_PAYMENT
            format: decimal- CASH_ON_DELIVERY
            - FREE_ORDER
description: net price  promo_codes:
      type: object
  gross:    description:   promo code
      typerequired:
number        - name
     format: decimal  - promo_code_value
      properties:
    description: gross price  name:
          vattype: string
          description: promo code type:name
number        promo_code_value:
      format: decimal   type: string
          description: promo code VATvalue
        orderregulation_final_pricetype:
          type: objectstring
          description: totallegal orderregulation pricefor witha deliverypromotional costscode for example. If the promo code is regulated by the required:Omnibus Directive then pass "OMNIBUS"
        - net example: OMNIBUS           -
gross    product_attributes:
      type: object
  -  vat  description: product attributes
      propertiesrequired:
        - attribute_name
  net:      - attribute_value
       typeproperties:
number        attribute_name:
      format: decimal   type: string
          description: attribute netname
price        attribute_value:
    gross:      type: string
        type  description: numberattribute value
    event_data:
      type: object
format: decimal     description: Data on events
      descriptionproperties:
gross   price     payment_status:
       vat:   type: string
          typedescription: numberpayment status. AUTHORIZED - payment successfully completed
        format: decimal  enum:
            description:- VATAUTHORIZED
        order_discountstatus:
          type: numberstring
          formatdescription: order decimalstatus
          descriptionenum:
Value  used discount coupons on order      - ORDER_REJECTED
        currencypayment_id:
          type: string
          description: basketpayment currencyid
          enumpayment_reference:
          type: string
- PLN         delivery_references_listdescription: payment reference
        payment_type:
array           descriptiontype: deliverystring
references list           itemsdescription: payment type
          $refenum:
'#/components/schemas/delivery_references'     delivery_references:       type:- stringCARD
      description: delivery references    - request_orders_details:CARD_TOKEN
      type: object       required:
  - GOOGLE_PAY
     - basket_id         - paymentAPPLE_typePAY
        - currency         - basketBLIK_priceCODE
      properties:      -   order_comments:BLIK_TOKEN
          type: string    - PAY_BY_LINK
     description: order information     - SHOPPING_LIMIT
  basket_id:          - type:DEFERRED_PAYMENT
string           description: basket id- CASH_ON_DELIVERY
        currencypayment_additional_parameters:
          type: stringarray
          descriptionitems: basket currency      
    enum:       $ref: '#/components/schemas/payment_additional_parameter'     -   PLN    
    basketbase_price:
      type: object
  type: object   description: price information
     description required:
 total  basket price    - net
     required:   - gross
        - netvat
      properties:
     - gross  net:
          -type: vatnumber
          propertiesformat: decimal
          description: net: price
        gross:
      type: number   type: number
          format: decimal
              description: netgross price
        vat:
   gross:       type: number
      type: number   format: decimal
          formatdescription: decimalVAT
    quantity:
      type: object
 description: gross price   description: product quantity information
      vatrequired:
        - quantity
    type  properties:
number        quantity:
      format: decimal   type: number
          description: VATproduct quantity
        paymentquantity_type:
          type: string
          description: product paymentquantity type
          enum:
            - CARDDECIMAL
            - INTEGER
CARD_TOKEN        quantity_unit:
    - GOOGLE_PAY     type: string
      - APPLE_PAY   description: unit quantity
       - BLIK_CODEavailable_quantity:
          type: number
     - BLIK_TOKEN    format: decimal
       - PAY_BY_LINK  description: product quantity available
       - SHOPPINGmax_LIMITquantity:
          type: number
 - DEFERRED_PAYMENT        format: decimal
   -  CASH_ON_DELIVERY     promo_codesdescription: maximum product quantity
       type min_quantity:
object       description: promo code type: number
    required:      format: decimal
 - name        description: - promo_code_value
      properties:minimum product quantity. Field available in next version app
        namequantity_jump:
          type: stringnumber
          descriptionformat: decimal
promo  code name       description:  promo_code_value:
          type: string
  quantity jump value in case of increase/decrease of product quantity by customer (e.g. 0.1 or 0.5 or 0.01)        description: promo code value
    productquantity_attributesevent:
      type: object
      description: product attributesquantity
      required:
         - attribute_name
 quantity       - attribute_value
      properties:
        attribute_namequantity:
          type: stringnumber
          description: attributeproduct namequantity
        attributequantity_valuetype:
          type: string
          descriptionenum:
  attribute  value     event_data: - DECIMAL
    type: object     - INTEGER
description: Data on events       properties:description: product quantity type
        paymentquantity_statusunit:
          type: string
          description: paymentunit status.quantity AUTHORIZED - payment successfully completed     
    quantity_order:
enum:      type: object
     - AUTHORIZEDdescription: product quantity
      order_statusrequired:
        - quantity
 type: string    properties:
      description: order statusquantity:
          enumtype: number
          description: -product ORDER_REJECTEDquantity
        paymentquantity_idtype:
          type: string
          descriptionenum:
payment id         payment_reference:  - DECIMAL
       type: string    - INTEGER
     description: payment reference   description: product quantity    payment_type:
          typequantity_unit:
string           description: payment type: string
          enumdescription: unit quantity
    phone_number:
     - CARDtype: object
      description: phone number
  - CARD_TOKEN    required:
        - GOOGLEcountry_PAYprefix
        - phone
  - APPLE_PAY   properties:
         - BLIK_CODEcountry_prefix:
          type: string
- BLIK_TOKEN         description: prefix
  - PAY_BY_LINK       example: '+48'
    - SHOPPING_LIMIT   phone:
         - DEFERRED_PAYMENTtype: string
          example: -600123123
CASH_ON_DELIVERY     base_priceinformation:
      type: object
      descriptionrequired:
price  information      - required:type
        - netdescription
      properties:
 - gross      type:
  - vat       propertiestype: string
          netenum:
           type: number - ATTENTION
            format:- decimalERROR
          description: nettype additional pricenotice
        grossdescription:
          type: numberstring
          formatdescription: decimalbasket additional notice
    response_order_event_merchant:
   description: gross price type: object
      vatproperties:
          type: numberorder_merchant_status_description:
          formattype: decimalstring
          description: VATorder merchant status description
 quantity:       typedelivery_references_list:
object          descriptiontype: productarray
quantity information       required:  description: delivery references list
   - quantity       propertiesitems:
        quantity:    $ref: '#/components/schemas/delivery_references'
     type: number
address_details:
         description: product quantity
        quantity_type:
   This is auto-generated object from single line user input. Correctness of the data is not guaranteed.
      type: stringobject
      properties:
   description: product quantity type  street:
        enum:  type: string
         - DECIMALdescription: street
        building:
  - INTEGER         quantity_unit:type: string
          typedescription: stringBuilding number. Populated with "_" if not found in   description: unit quantitythe address.
         available_quantityflat:
          type: numberstring
          formatdescription: decimalflat
    account_info_request:
     description: product quantity available
  type: object
      required:
      max_quantity:  - name
        type:- numbersurname
        - phone_number
format: decimal       - client_address
  description: maximum product quantity   - mail
    min_quantity:  properties:
        typename:
number           formattype: decimalstring
          description: minimumname
  product quantity. Field available in next versionsurname:
app          type: string
   quantity_order:       typedescription: objectsurname
      description: product quantityphone_number:
      required:    $ref: '#/components/schemas/phone_number'
   - quantity    mail:
  properties:        type: quantity:string
          typedescription: numbermail
        client_address:
 description: product quantity       $ref:  quantity_type:'#/components/schemas/client_address_request'
    client_address_request:
      type: stringobject
      description: delivery address
  enum:    required:
        - DECIMALcountry_code
        - address
  - INTEGER     - city
    description: product quantity type - postal_code
      quantity_unitproperties:
          typecountry_code:
string          type: description:string
unit quantity     phone_number:    description: country code
type: object       descriptionaddress:
phone number       required:  type: string
     - country_prefix    description:  address
  - phone     address_details:
 properties:         country_prefix$ref: '#/components/schemas/address_details'
         typecity: string
          descriptiontype: prefixstring
          exampledescription: '+48'city
        phonepostal_code:
          type: string
          exampledescription: postal 600123123code
    informationdelivery_address_request:
      type: object
      requireddescription: delivery address
      -required:
type        - -name
description       properties: - country_code
      type:  - address
       type: string- city
        - enum:postal_code
      properties:
     - ATTENTION  name:
          -type: ERRORstring
          description: type additionalname
notice         descriptioncountry_code:
          type: string
          description: basketcountry code
  additional notice     response_order_event_merchant:address:
          type: objectstring
      properties:    description:  address
  order_status:      city:
    type: string      type: string
   description: order status - Merchant can change orderdescription: statuscity
to; ORDER_COMPLETED - order completed in merchant's shop, ORDERpostal_REJECTEDcode:
- order rejected by merchant      type: string
   enum:       description: postal code
   - ORDER_COMPLETED    address_details:
        - ORDER_REJECTED $ref: '#/components/schemas/address_details' 
     order_merchant_status_descriptiondelivery_product:
      type: object
  type: string   description: additional delivery information for product
  description: order merchant status descriptionproperties:
        delivery_references_listtype:
          type: arraystring
          description: delivery type references list(APM; COURIER)
          itemsenum:
            $ref: '#/components/schemas/delivery_references'- APM
    address_details:       description: This- isCOURIER
auto-generated object from single line user input. Correctness of the data is not guaranteed. if_delivery_available:
           type: objectboolean
           properties:description: if type of delivery available for product
    delivery_related_products:
   street:   type: object
      typedescription: stringadditional delivery information for product
      descriptionproperties:
street         buildingdelivery_type:
          type: string
          description: Building number. Populated with "_" if not found in the address.
 delivery type (APM; COURIER)
          enum:
       flat:     - APM
    type: string       - COURIER
  description: flat     accountif_infodelivery_requestfree:
          type: objectboolean
      required:    description: is free delivery for -a nametype of delivery
      - surname if_delivery_available:
       - phone_number  type: boolean
     - client_address    description: if type of delivery -available mailfor product
     propertiesproduct_images:
        nametype: object
      description: additional product type:images
string      required:
    description: name   - small_size
    surname:    - normal_size      type:
string      properties:     description: surname
        phonesmall_numbersize:
          $reftype: '#/components/schemas/phone_number' string
          maildescription: product image. Preferred size 360 x 352
    type: string   normal_size:
       description: mail  type: string
     client_address:     description: product image. Preferred size 360 $ref: '#/components/schemas/client_address_request'x 504
    client_address_requestcookies:
      type required:
object        - description:domain
 delivery address      - required:keyValue
        - country_codekey
        - addressvalue
        - citypath
       type: -object
postal_code       properties:
        country_codedomain:
          type: string
          description: countryDomain codeof the cookie represented by pair key-value
  address:        example: "uat.outofthebox.pl"
 type: string      key:
    description:  address    type: string
   address_details:       description: Cookie key
 $ref: '#/components/schemas/address_details'         cityexample: "wp_woocommerce_session_f3cd21b400c074e165b59837d7a9d0a4"
         typevalue:
string           descriptiontype: city
string
       postal_code:   description: Cookie value
     type:  string    example: "t_f13664beda2ec455d97546c1ddab8b%7C%7C1699438060%7C%7C1699434460%7C%7Cf77d310ce1f0440cb4812f5043736989"
     description: postal code path:
   delivery_address_request:       type: string
object       description: delivery address description: Cookie path
   required:       example: "/"
- name       expires:
 - country_code        type: -string
address         - citydescription: Cookie expiration time or maxAge
   - postal_code       properties:example: "2025-01-16T14:17:02.486Z"
        namesecure:
          type: stringboolean
          description: Cookie namesecurity information
          country_codeexample: false
         typehttp_only:
string          type: description:boolean
country code         addressdescription: Cookie http information
        type: string example: true
        descriptionsame_site:
 address         citytype: string
          typeenum:
string           description: city- STRICT
       postal_code:     - LAX
    type: string       - NONE
  description: postal code      description: Cookie sameSite address_details:information
          $refexample: '#/components/schemas/address_details'"LAX"
     delivery_product:    priority:
  type: object       descriptiontype: additionalstring
delivery information for product       propertiesenum:
         delivery_type:
    - LOW
        type: string   - MEDIUM
      description: delivery type (APM; COURIER)  - HIGH
       enum:   description: Cookie priority
       - APM  example: "MEDIUM"
        max_age:
- COURIER         if_delivery_availabletype: integer
          typedescription: Cookie booleanmax age
          descriptionexample: 0
 if type of delivery_time:
available for product     delivery_related_products:required:
        - description type: object  
    description: additional delivery informationtype: forobject
product       properties:
        delivery_typedescription:
          type: string
          description: delivery type (APM; COURIER) message present to customer in inpostpay app
           enum:
  example: "Kup do 15:00 - dostawa jutro"
         - APMdays_available:
          type: array
      - COURIER   description: days of week on which if_delivery_free:delivery information is to be present
          typeitems:
boolean            description$ref: is free delivery for a type of delivery'#/components/schemas/day'        
        ifstart_delivery_availablehour:
          type: booleanstring
          description: if typestart time of presentation of delivery availabledate forapp
product     product_images:     example: "10:00"
type: object       descriptionend_hour:
additional  product images       requiredtype: string
       - small_size  description: end time of presentation of delivery -date normal_sizeapp
          example:  properties"15:00" 
    day:
        small_sizetype: string
         typedescription: stringday
      example: "MONDAY, TUESDAY, WEDNESDAY, description: product image. Preferred size 360 x 352THURSDAY, FRIDAY, SATURDAY, SUNDAY"
      enum:
     normal_size:       - MONDAY
  type: string         - TUESDAY
description: product image. Preferred size 360 x 504     cookies:- WEDNESDAY
      required:         - domainTHURSDAY
        - keyValue   - FRIDAY
    - key         - SATURDAY
value         - path  - SUNDAY
    typepromotion:
object     required:
  properties:      - type
 domain:       - promo_code_value
  type: string     - description
    description: Domain of the cookie- representeddetails
by pair key-value   type: object
      example: "uat.outofthebox.pl"properties:
        keytype:
          type: string
          description: type Cookieproco keycode. MERCHANT - merchant promo code;  ONLY_IN_APP - merchant promo example: "wp_woocommerce_session_f3cd21b400c074e165b59837d7a9d0a4"
        value:code which is only available in the InPost pay app 
          typeenum:
string           description:- CookieMERCHANT
value           example: "t_f13664beda2ec455d97546c1ddab8b%7C%7C1699438060%7C%7C1699434460%7C%7Cf77d310ce1f0440cb4812f5043736989"- ONLY_IN_APP
        pathpromo_code_value:
          type: string
          description: Cookiepromo pathcode value
        description:
example: "/"         expirestype: string
          typedescription: stringdescription
          descriptionmaxLength: Cookie60
expiration time or maxAge           example: "2025-01-16T14:17:02.486Z"start_date:
        secure:  type: string
       type: boolean  description: image url
      description: Cookie security information format: date-time         example: false
        httpend_onlydate:
          type: booleanstring
          description: Cookie http information
  image url
          format: date-time         example: true
        same_sitepriority:
          type: stringinteger
          enumdescription: image url
        details:
  - STRICT         $ref: '#/components/schemas/details'
  - LAX details:
      type: object
   - NONE  required:
        description:- Cookielink sameSite information    
      exampleproperties: "LAX"
        prioritylink:
          type: string
          enumdescription: link to details          - LOW
    payment_additional_parameter:
      type: -object
MEDIUM      description: payment additional parameter
   - HIGH  required:
      - key
description: Cookie priority    - value
     example: "MEDIUM" properties:
        max_agekey:
          type: integerstring
          description: Cookie max age key
        value:
          type: string
          exampledescription: 0value