Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Headers

The following headers will be added to all the services called by InPost Pay (Basket App) in the Merchant's backend. The headers contain the signature of a message subject to verification in accordance with the signature verification algorithm. Currently, the headers are optional but will be eventually required.

Header

Description

x-signature

Signature

x-signature-timestamp

ISO8601 date and time string in the UTC time zone with the time when the signature was generated, for instance. 2023-05-11T15:02:23.429Z

x-public-key-ver

The version of the keys used to generate the signature

x-public-key-hash

SHA-256 the hash of the public key used to generate the signature


On this page:

Table of Contents

List of Merchant Backend API methods

The table below contains the list of methods issued by the Merchant's backend intended to communicate with InPost Pay.

Method

Description

Basket

GET /v1/izi/basket/{basketId}

Downloading the details of a basket

POST /v1/izi/basket/{basketId}/confirmation

Confirming adding a basket

POST /v1/izi/basket/{basketId}/event

Notifying of a basket update

DELETE /v1/izi/basket/{basketId}/binding

Basket desynchronization (unpairing the basket from the phone number)

Order

POST /v1/izi/order

Creating an order

GET v1/izi/order/{orderId}

Downloading the details of an order

POST /v1/izi/order/{orderId}/event

Sending information about order update

Confluence open api
---
openapi: 3.0.3
info:
  title: Swagger
  description: 'Merchant API. Merchant expose API only for Basket App '
  version: 3.6.5.6

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
      variant  consent_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 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_idrequirement_type:
          type: string
          enum:
            - consent_description OPTIONAL
            - consent_versionREQUIRED_ONCE
            - requirement_typeREQUIRED_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:APM
string           description: consent- versionCOURIER
        requirementdelivery_typedate:
          type: string
          enumformat: date-time
          description: -delivery OPTIONALdate
            - REQUIRED_ONCEdelivery_options:
            - REQUIRED_ALWAYStype: array
          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$ref: consent id'#/components/schemas/phone_number'
         consentdelivery_linkpoint:
          type: string
          description: consentAPM delivery linkpoint
        labeldelivery_linkaddress:
          type$ref: string'#/components/schemas/delivery_address'
          descriptiondelivery_price:
label link presented in app      $ref: '#/components/schemas/base_price'
     delivery:       typecourier_note:
object       description: delivery information
      required type:  string
      - delivery_type   description: additional information for courier
 - delivery_price
        - delivery_dateorder:
      propertiestype: object
      description: delivery_type: information
         typerequired:
string           description:- delivery type (APM; COURIER)_type
          enumproperties:
        delivery_type:
   - APM      type: string
     - COURIER    enum:
    delivery_date:        - APM
 type: string           format: date-time- 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'
        delivery_price:
          $ref: '#/components/schemas/base_price_request'
        courier_note:
          type: string
          description: additional information for courier
    delivery_ordercode:
      type: objectstring
      description: deliverypayment informationtype
      requiredexample: PWW
    delivery_address:
  - delivery_type   type: object
      propertiesdescription: delivery address
      delivery_typerequired:
        - name
type:    string    - country_code
     enum:   - address
        - APMcity
        - postal_code
  - COURIER   properties:
       description name: delivery
type (APM; COURIER)         delivery_codes:type: string
          typedescription: array name
         descriptioncountry_code:
delivery options           itemstype: string
          description: $ref: '#/components/schemas/delivery_code'country code
        mailaddress:
          type: string
          description: email  address
        city:
          phone_numbertype: string
          $refdescription: '#/components/schemas/phone_number'city
        deliverypostal_pointcode:
          type: string
          description: APMpostal delivery pointcode
    client_address:
   delivery_address:   type: object
      $refdescription: '#/components/schemas/delivery_address_request'delivery address
      required:
 courier_note:       - country_code
  type: string     - address
    description: additional information for courier- city
   delivery_code:     - postal_code
type: string       descriptionproperties:
payment type       example: PWW
country_code:
   delivery_address:       type: objectstring
      description: delivery address       required:
        - name
        - country_code
description: country code
       - address:
        - city type: string
      - postal_code   description:   address
properties:         namecity:
          type: string
          description: city
name         countrypostal_code:
          type: string
          description: countrypostal code
        address:
 delivery_basket_response:
        type: stringobject
       required:
  description:  address    - delivery_type
   city:     - delivery_price
    type: string   - delivery_date
      descriptionproperties: city
        postaldelivery_codetype:
          type: string
          description: delivery postaltype code(APM; COURIER)
   client_address:       typeenum:
object        description: delivery address  - APM
   required:         - country_codeCOURIER
        -delivery_date:
address         - citytype: string
       - postal_code  format: date-time
   properties:         country_codedescription: delivery date
        typedelivery_options:
string          type: description:array
country code         addressdescription: delivery options
        type  items:
string            description$ref:  address'#/components/schemas/delivery_options'
         citydelivery_price:
          type$ref: string'#/components/schemas/base_price'
        free_delivery_minimum_gross_price:
 description: city         postal_code:type: number
          typeformat: stringdecimal
          description: postalfree codedelivery minimum gross price
 delivery_basket_response:       typeestimate_delivery_time:
object       required:   type: array
    - delivery_type     description:  estimate  - delivery_price time
       - delivery_date  items:
    properties:        $ref: '#/components/schemas/delivery_type:time'        
  type: string delivery_options:
      type: object
 description: delivery type (APM; COURIER) description: additional delivery options
      enumrequired:
        - delivery_name
        - APMdelivery_code_value
        - delivery_option_price
     - COURIERproperties:
        delivery_datename:
          type: string
          formatdescription: date-timedelivery name
          descriptionexample: deliveryPaczka w dateWeekend
        delivery_code_optionsvalue:
          type: array string
          enum:
          - COD
          - PWW
          description: delivery optionscode value. COD - option with payment on delivery, PWW - option items:with weekend delivery
          $refexample: '#/components/schemas/delivery_options'PWW
        delivery_option_price:
          $ref: '#/components/schemas/base_price'
    basket_summary:
   free_delivery_minimum_gross_price:   type: object
      typerequired:
number        - basket_base_price
 format:   decimal    - currency
     description: free delivery minimum- grosspayment_type
price      properties:
        deliverybasket_base_optionsprice:
      type: object   $ref: '#/components/schemas/base_price'
  description: additional delivery options   basket_final_price:
   required:         - delivery_name$ref: '#/components/schemas/base_price'
        - deliverybasket_code_valuepromo_price:
          - delivery_option_price$ref: '#/components/schemas/base_price'
        propertiescurrency:
         delivery_name type: string
         type description: stringbasket currency
          descriptionenum: delivery
name           example: Paczka- w WeekendPLN
        deliveryfree_code_valuebasket:
          type: stringboolean
          enum:
    description: flag inform if the basket without delivery costs is free      -   COD   
       - PWW basket_expiration_date:
          descriptiontype: string
delivery code value. COD - option with payment on delivery, PWWformat: date- optiontime
with weekend delivery        description: expiry date example:of PWWbasket
        deliverybasket_optionadditional_priceinformation:
          $reftype: '#/components/schemas/base_price'string
    basket_summary:       typedescription: objectadditional information
     required:   payment_type:
     - basket_base_price    type: array
   - currency      description: payment  - payment_type

     properties:       items:
 basket_base_price:           $ref: '#/components/schemas/basepayment_pricetype'
        basket_final_pricenotice:
          $ref: '#/components/schemas/base_priceinformation'
    payment_type:
   basket_promo_price:   type: string
      $refdescription: '#/components/schemas/base_price'
payment type
       currencyenum:
        - CARD
type: string       - CARD_TOKEN
  description: basket currency    - GOOGLE_PAY
     enum:   - APPLE_PAY
        - PLNBLIK_CODE
        - basket_expiration_date:BLIK_TOKEN
          type: string- PAY_BY_LINK
          format: date-time SHOPPING_LIMIT
         description: expiry date of basket- DEFERRED_PAYMENT
        - basketCASH_additionalON_information:DELIVERY
    summary:
      type: stringobject
          descriptionrequired:
additional information       -  payment_type:basket_base_price
        - currency
type: array       - payment_type
  description: payment type  properties:
        itemsbasket_base_price:

           $ref: '#/components/schemas/paymentbase_typeprice'
        basket_final_noticeprice:
          $ref: '#/components/schemas/informationbase_price'
    payment_type:    basket_promo_price:
  type: string       description: payment type$ref: '#/components/schemas/base_price'
        enumcurrency:
        - CARD type: string
      - CARD_TOKEN   description: basket currency
   - GOOGLE_PAY      enum:
  - APPLE_PAY         - BLIK_CODEPLN
        - BLIK_TOKENfree_basket:
        - PAY_BY_LINK type: boolean
      - SHOPPING_LIMIT   description: flag inform if the basket -without DEFERRED_PAYMENTdelivery costs is free      - CASH_ON_DELIVERY     summary:
      type: object basket_expiration_date:
     required:     type: string
  - basket_base_price       format:  date-time
currency         - payment_type
 description: expiry date of basket
        basket_additional_information:
          type: string
     properties:     description: additional information
        basket_base_price:
payment_type:
          type: array
         $ref: '#/components/schemas/base_price' description: payment type
          basket_final_price:items:
            $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'
       invoice_details:   type: string
  type: object       propertiesdescription: company name
        legal_formname:
          type: string
          description: legal form ofname
customer           enumsurname:
          type: string
- PERSON         description: surname
  - COMPANY         country_codecity:
          type: string
          description: countrycity
code         tax_id_prefixstreet:
          type: string
          description: taxstreet
id prefix         tax_idbuilding:
          type: string
          description: taxbuilding
id         company_nameflat:
          type: string
          description: companyflat
name         namepostal_code:
          type: string
          description: namepostal code
        surnamemail:
          type: string
          description: surnamemail
        cityregistration_data_edited:
          type: string
          description: registration citydata edited
        streetadditional_information:
          type: string
          description: streetadditional information
    account_info:
   building:   type: object
      typerequired:
string        - name
 description: building      - surname
 flat:           type: string- phone_number
        - client_address
        - mail
      descriptionproperties:
flat         postal_codename:
          type: string
          description: postalname
code         mailsurname:
          type: string
          description: mailsurname
        registrationphone_data_editednumber:
          type$ref: string'#/components/schemas/phone_number'
        mail:
 description: registration data edited      type: string
 additional_information:         description: mail
type: string       client_address:
   description: additional information     account_info$ref: '#/components/schemas/client_address'
     typeconsents_order:
object       requiredtype: object
      description: -consents nameorder list
       -required:
surname         - phoneconsent_numberid
        - clientconsent_addressversion
        - mailis_accepted
      properties:
        nameconsent_id:
          type: string
          description: consent nameid
        surnameconsent_version:
          type: string
          description: consent surnameversion
        phoneis_numberaccepted:
          $reftype: '#/components/schemas/phone_number'boolean
        mail:  description: is accepted consent
     type: stringresponse_orders_details:
      type: object
      descriptionrequired:
mail        - client_address:
 order_id
        - order_creation_date
        $ref: '#/components/schemas/client_address'- basket_id
    consents_order:    - payment_status
 type: object      - order_merchant_status_description:
consents order list      - required:payment_type
        - consentorder_base_idprice
        - consent_versionorder_final_price
        - currency
        - ispos_acceptedid
      properties:
        consentorder_idcomments:
          type: string
          description: consentorder idcomments
        consentorder_versionid:
          type: string
          description: consentorder versionid
        iscustomer_order_acceptedid:
          type: booleanstring
          description: isorder acceptedID consentpresented to customer and  response_orders_details:
      type: object
  used for payment. In case of lack of customer_order_id order_id will be used.    required: 
       - orderpos_id:
        - order_creation_date
  type: string
       - basket_id  description: POS identifier provided by   - payment_status
        - order_merchant_status_description
        - payment_type
Vodeno, allowing merchant to filter payments in the reporting tools
       - order_basecreation_pricedate:
         - order_final_price
 type: string
       - currency  format: date-time
     - pos_id    description: order creation properties:date
        orderbasket_commentsid:
          type: string
          description: orderbasket commentsid
        order_merchant_status_iddescription:
          type: string
          description: order merchant status iddescription
        customerpayment_order_idtype:
          type: string
          description: order IDstatus
presented to customer and used for payment. In case of lackenum:
of customer_order_id order_id will be used.       - CARD
     pos_id:       - CARD_TOKEN
  type: string         - GOOGLE_PAY
description: POS identifier provided by Vodeno, allowing merchant to filter payments in the- reportingAPPLE_PAY
tools         order_creation_date:   - BLIK_CODE
            - type:BLIK_TOKEN
string           format: date-time- PAY_BY_LINK
            - SHOPPING_LIMIT
 description: order creation date        - basket_id:DEFERRED_PAYMENT
             type: string- CASH_ON_DELIVERY
           description: basket- idFREE_ORDER
        order_merchantbase_status_descriptionprice:
          type: stringobject
          description: price for order merchantwithout statusdelivery descriptioncosts
        payment_type:  required:
        type: string   - net
      description: order status    - gross
     enum:       - vat
    - CARD     properties:
       - CARD_TOKEN    net:
        - GOOGLE_PAY     type: number
      - APPLE_PAY       format: decimal
    - BLIK_CODE         description: net price
 - BLIK_TOKEN          gross:
  - PAY_BY_LINK           type: number
- SHOPPING_LIMIT             - DEFERRED_PAYMENTformat: decimal
            - CASH_ON_DELIVERY description: gross price
     order_base_price:       vat:
   type: object           descriptiontype: price fornumber
order without delivery costs           requiredformat: decimal
           - net  description: VAT
        order_final_price:
- gross         type: object
  - vat       description: total order price properties:with delivery costs
          netrequired:
            - net
  type: number         - gross
    format: decimal       - vat
      description:   net priceproperties:
            grossnet:
              type: number
              format: decimal
              description: grossnet price
            vatgross:
              type: number
              format: decimal
              description: VATgross price
       order_final_price:     vat:
     type: object           descriptiontype: total ordernumber
price with delivery costs           requiredformat: decimal
           - net  description: VAT
        order_discount:
- gross         type:   number
- vat           propertiesformat: decimal
           netdescription: Value used discount coupons on order       
 type: number      currency:
        format: decimal type:   string
          description: netbasket pricecurrency
            grossenum:
            - PLN
type: number        delivery_references_list:
      format: decimal   type: array
          description: grossdelivery pricereferences list
           vatitems:
            $ref:  type: number
 '#/components/schemas/delivery_references'
    delivery_references:
      type: string
    format: decimal description: delivery references
    request_orders_details:
      descriptiontype: VATobject
        order_discountrequired:
        - basket_id
type: number       - payment_type
  format: decimal     - currency
    description: Value used discount coupons- onbasket_price
order      properties:
         currencyorder_comments:
          type: string
          description: basketorder currencyinformation
          enumbasket_id:
          type: string
- PLN         delivery_references_listdescription: basket id
        typecurrency:
array           descriptiontype: deliverystring
references list           itemsdescription: basket currency
          $refenum:
'#/components/schemas/delivery_references'     delivery_references:       type:- stringPLN
      description: delivery referencesbasket_price:
    request_orders_details:       type: object
      required:    description: total basket price
   - basket_id      required:
  - payment_type         - currencynet
        - basket_price   - gross
  properties:         order_comments: - vat
        type: string properties:
         description: order information net:
       basket_id:       type: number
  type: string           descriptionformat: basketdecimal
id         currency:     description: net price
   type: string        gross:
  description: basket currency           enumtype: number
            - PLN format: decimal
      basket_price:        description: gross price
type: object           descriptionvat:
total  basket price           requiredtype: number
           - net  format: decimal
         - gross    description: VAT
       - vatpayment_type:
          propertiestype: string
           netdescription: payment type
            typeenum:
number            - CARD
 format: decimal          - CARD_TOKEN
   description: net price       - GOOGLE_PAY
    gross:        - APPLE_PAY
     type: number      - BLIK_CODE
       format: decimal    - BLIK_TOKEN
         description: gross price - PAY_BY_LINK
          vat:  - SHOPPING_LIMIT
           type: number- DEFERRED_PAYMENT
             format: decimal- CASH_ON_DELIVERY
            - FREE_ORDER
 description: VAT  promo_codes:
      payment_type: object
      description: promo code
   type   required:
string        - name
  description:  payment type   - promo_code_value
      enumproperties:
        name:
   - CARD      type: string
     -   CARD_TOKEN  description: promo code name
       - GOOGLE_PAYpromo_code_value:
          type: string
 - APPLE_PAY         description: promo code value
    - BLIK_CODE   regulation_type:
         - BLIK_TOKENtype: string
          description: - PAY_BY_LINK
            - SHOPPING_LIMIT
    legal regulation for a promotional code for example. If the promo code is regulated by the Omnibus Directive then pass "OMNIBUS"
       - DEFERRED_PAYMENT  example: OMNIBUS          - CASH_ON_DELIVERY
    promoproduct_codesattributes:
      type: object
      description: promoproduct codeattributes
      required:
        - attribute_name
        - promo_codeattribute_value
      properties:
        attribute_name:
          type: string
          description: promoattribute code name
        promo_codeattribute_value:
          type: string
          description: promo codeattribute value
    productevent_attributesdata:
      type: object
      description: productData on attributesevents
      requiredproperties:
        - attribute_name
        - attribute_value
      properties:
        attribute_name:
          type: string
          description: attribute name
        attribute_value:
          type: string
          description: attribute value
    event_data:
      type: object
      description: Data on events
      properties:
        payment_payment_status:
          type: string
          description: payment status. AUTHORIZED - payment successfully completed
          enum:
            - AUTHORIZED
        order_status:
          type: string
          description: order status
          enum:
            - ORDER_REJECTED
        payment_id:
          type: string
          description: payment id
        payment_reference:
          type: string
          description: payment reference
        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
    base_price:    payment_additional_parameters:
  type: object       description: type: array
          items:        
           $ref: '#/components/schemas/payment_additional_parameter'            
    base_price:
      type: object
      description: price information
      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
    quantity:
      type: object
      description: product quantity information
      required:
        - quantity
      properties:
        quantity:
          type: number
          description: product quantity
        quantity_type:
          type: string
          description: product quantity type
          enum:
            - DECIMAL
            - INTEGER
        quantity_unit:
          type: string
          description: unit quantity
        available_quantity:
          type: number
          format: decimal
          description: product quantity available
        max_quantity:
          type: number
          format: decimal
          description: maximum product quantity
        min_quantity:
          type: number
          format: decimal
          description: minimum product quantity. Field available in next version app
        quantity_jump:
          type: number
          format: decimal
          description: quantity jump value in case of increase/decrease of product quantity by customer (e.g. 0.1 or 0.5 or 0.01)          
    quantity_event:
      type: object
      description: product quantity
      required:
         - quantity       
      properties:
        quantity:
          type: number
          description: product quantity
        quantity_type:
          type: string
          enum:
          - DECIMAL
          - INTEGER
          description: product quantity type
        quantity_unit:
          type: string
          description: unit quantity          
    quantity_order:
      type: object
      description: product quantity
      required:
        - quantity
      properties:
        quantity:
          type: number
          description: product quantity
        quantity_type:
          type: string
          enum:
            - DECIMAL
            - INTEGER
          description: product quantity type
        quantity_unit:
          type: string
          description: unit quantity
    phone_number:
      type: object
      description: phone number
      required:
        - country_prefix
        - phone
      properties:
        country_prefix:
          type: string
          description: prefix
          example: '+48'
        phone:
          type: string
          example: 600123123
    information:
      type: object
      required:
        - type
        - description
      properties:
        type:
          type: string
          enum:
            - ATTENTION
            - ERROR
          description: type additional notice
        description:
          type: string
          description: basket additional notice
    response_order_event_merchant:
      type: object
      properties:
        order_merchant_status_description:
          type: string
          description: order merchant status description
 - Merchant can change order status to; ORDER_COMPLETED - order completed in merchant's shop, ORDER_REJECTED - order rejected by merchantdelivery_references_list:
          type: array
          enumdescription: delivery references list
         - ORDER_COMPLETEDitems:
            - ORDER_REJECTED$ref: '#/components/schemas/delivery_references'
    address_details:
   order_merchant_status_description:   description: This is auto-generated object from single line user input. Correctness of the data is not guaranteed.
      type: object
      properties:
        street:
          type: string
          description: street
        building:
          type: string
          description: Building number. Populated with "_" if not found in the address.
        flat:
          type: string
          description: flat
    account_info_request:
      type: object
      required:
        - name
        - surname
        - phone_number
        - client_address
        - mail
      properties:
        name:
          type: string
          description: name
        surname:
          type: string
          description: surname
        phone_number:
          $ref: '#/components/schemas/phone_number'
        mail:
          type: string
          description: mail
        client_address:
          $ref: '#/components/schemas/client_address_request'
    client_address_request:
      type: object
      description: delivery address
      required:
        - country_code
        - address
        - city
        - postal_code
      properties:
        country_code:
          type: string
          description: country code
        address:
          type: string
          description:  address
        address_details:
          $ref: '#/components/schemas/address_details'
        city:
          type: string
          description: city
        postal_code:
          type: string
          description: postal code
    delivery_address_request:
      type: object
      description: delivery address
      required:
        - name
        - country_code
        - address
        - city
        - postal_code
      properties:
        name:
          type: string
          description:  name
        country_code:
          type: string
          description: country code
        address:
          type: string
          description:  address
        city:
          type: string
          description: city
        postal_code:
          type: string
          description: postal code
        address_details:
          $ref: '#/components/schemas/address_details' 
    delivery_product: order merchant status description
      type: object
      description: additional delivery information for product
      properties:
        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: object
      properties: boolean
           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: object       requiredtype: boolean
       - name  description: is free delivery for a type -of surnamedelivery
        - phone_numberif_delivery_available:
        - client_address type:   boolean
    - mail       propertiesdescription: if type of delivery available for product
 name:   product_images:
       type: stringobject
      description: additional product images
description: name     required:
   surname:     - small_size
    type: string   - normal_size      
description: surname     properties:    phone_number:  
        $refsmall_size:
'#/components/schemas/phone_number'          mailtype: string
          typedescription: string
    product image. Preferred size 360 x 352
      description  normal_size:
mail          client_addresstype: string
          $ref: '#/components/schemas/client_address_request'description: product image. Preferred size 360 x 504
    client_address_requestcookies:
      type required:
   object     - domain
description: 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: citystring
        postal_code:   description: Cookie value
     type: string    example: "t_f13664beda2ec455d97546c1ddab8b%7C%7C1699438060%7C%7C1699434460%7C%7Cf77d310ce1f0440cb4812f5043736989"
     description: postal code path:
   delivery_address_request:       type: objectstring
      description: delivery address  description: Cookie path
  required:         - nameexample: "/"
        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 security information
 name         country_codeexample: false
         typehttp_only:
string          type: description:boolean
country code         addressdescription: Cookie http information
        type: string example: true
        descriptionsame_site:
 address         citytype: string
         type enum:
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: if0
  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
          example: "Kup do enum15: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: start iftime of typepresentation 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         -  description: product image. Preferred size 360 x 504TUESDAY
          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
      exampleproperties:
"uat.outofthebox.pl"         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
         example: "/"
   description:
    expires:           type: string
          description: Cookiedescription
expiration time or maxAge           example: "2025-01-16T14:17:02.486Z"maxLength: 60
        securestart_date:
          type: booleanstring
          description: Cookie security information
   image url
          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
      exampleproperties: "MEDIUM"
        max_agekey:
          type: integerstring
          description: key
        value: Cookie max age
          type: string
          exampledescription: 0value