Basket Update

Field name

Description

Type

Requirement status

Additional remarks

basket_id

Basket's unique ID assigned by the merchant

string

Y

Field name

Description

Type

Requirement status

Additional remarks

event_id

Event's ID

 string

 Y

event_data_time

Event's date and time

 string($date-time)

 Y

event_type

Event's Type.

Enum:

[PRODUCTS_QUANTITY, PROMO_CODES, RELATED_PRODUCTS]

PRODUCTS_QUANTITY - change in product quantity

PROMO_CODES - adding/updating/removing a promotional code

RELATED_PRODUCTS - adding a suggested product

 string

 Y

phone_number

The user's number associated with the basket

 object

 O

phone_number.country_prefix

Prefix

 string

 Y

phone_number.phone

Telephone number

 string

 Y

quantity_event_data

Object which returns the event's details PRODUCTS_QUANTITY

 O

quantity_event_data.product_id

Product ID assigned by the merchant

string

Y

"product_id": 26

quantity_event_data.quantity

Object for reporting the product quantity

object

Y

quantity_event_data.quantity.quantity

product quantity

number ($decimal)

Y

"quantity":1

quantity_event_data.quantity.quantity_type

Field type quantity. Available values Enum: [DECIMAL, INTEGER]

If the quantity_type of the product is INTEGER, then the Merchant provides the price for 1 piece. If the quantity_type of the product is DECIMAL, then the Merchant provides the price for the product quantity selected.

• Example 1) We have 5 pcs of shirts 10 PLN a piece. In such a case, the quantity_type, is INTEGER and the product's price is PLN 10.

• Example 2) We have 0.35 kg of flour, costing PLN 5. In such a case, the quantity_type, is DECIMAL and the product's price is PLN 5.

string

O

"quantity_type":"INTEGER"

quantity_event_data.quantity.quantity_unit

Quantity unit of the product

string

O

"quantity_unit":"pcs"

quantity_event_data.quantity.available_quantity

The quantity available at the store

number ($decimal)

O

"available_quantity":26

quantity_event_data.quantity.max_quantity

The maximum number of the product a Customer can order e.g. at one order

number ($decimal)

O

"max_quantity":26

promo_codes_event_data

Object which returns the event's details PROMO_CODES

 object

O

promo_codes_event_data.name

Code name. In the app's next version the field not required

string

Y

"name ": "Promotion 5%"

promo_codes_event_data.promo_code_value

Promotion code

string

Y

"promo_code_value": "INPOST10"

related_products_event_data

Object which returns the event's details RELATED_PRODUCTS

 object

O

related_products_event_data.product_id

Product ID assigned by the merchant

string

Y

"product_id": 26

related_products_event_data.ean

Ean

string

O

"ean":"0"

related_products_event_data.quantity

Object for reporting the product quantity

object

Y

related_products_event_data.quantity.quantity

product quantity

number ($decimal)

Y

"quantity":1

related_products_event_data.quantity.quantity_type

Field type quantity. Values available Enum: [DECIMAL, INTEGER]

string

O

"quantity_type":"INTEGER"

related_products_event_data.quantity.quantity_unit

Quantity unit of the product

string

O

"quantity_unit":"pcs"

related_products_event_data.quantity.available_quantity

The quantity available at the store

number ($decimal)

O

"available_quantity":26

related_products_event_data.quantity.max_quantity

The maximum number of the product a Customer can order e.g. at one order

number ($decimal)

O

"max_quantity":26

Field name

Description

Type

Requirement status

Additional remarks

summary

Object intended to transfer the basket's key data

object

Y

summary.basket_base_price

Object intended to transfer the main price for the basket without the delivery costs

object

Y

summary.basket_base_price.net

Net price

number ($decimal) (10,2)

Y

"summary":{"basket_base_price":{"net":"250.00","gross":"307.50","vat":"57.5

summary.basket_base_price.gross

Gross Price (net + VAT)

number ($decimal) (10,2)

Y

summary.basket_base_price.vat

VAT

number ($decimal) (10,2)

Y

summary.basket_final_price

Object intended to transfer the basket's final price with any promotion and discount code taken into account without the delivery costs.
The discount value for products arising out from the application of a code displayed in the basket summary will be the difference between the promo_price, and the final_price or the base_price, and the final_price when the products are not promoted.

object

O

summary.basket_final_price.net

Net price

number ($decimal) (10,2)

Y

"basket_final_price":{"net":"220.00","gross":"270.60","vat":"50.60"}

summary.basket_final_price.gross

Gross Price (net + VAT)

number ($decimal) (10,2)

Y

summary.basket_final_price.vat

VAT

number ($decimal) (10,2)

Y

summary.basket_promo_price

Object intended to transfer the basket's price taken into account any promotion, but without any rebate code and without the delivery costs.

object

O

summary.basket_promo_price.net

Net price

number ($decimal) (10,2)

Y

"basket_promo_price":{"net":"220.00","gross":"270.60","vat":"50.60"}

summary.basket_promo_price.gross

Gross Price (net + VAT)

number ($decimal) (10,2)

Y

summary.basket_promo_price.vat

VAT

number ($decimal) (10,2)

Y

summary.currency

Basket's currency. Currently, the only currency available PLN

string

Y

"currency":"PLN"

summary.basket_expiration_date

Basket's expiration /validity date. This is the date when the basket will be automatically removed from the InPost Pay app (it becomes invalid). The date cannot be backward.

string($date-time)

O

"basket_expiration_date":"2023-09-13T07:40:53.000Z"

summary.basket_additional_information

The field is used to transfer additional information of the basket which, from the merchant's point of view, could be significant for the customer

string

O

"basket_additional_information": "Order today, and receive a discount code for future purchases"

summary.payment_type

Preferable payment methods for the basket. The merchant provides the list of preferred payment forms for the basket from which the customer can choose a payment method in the course of creating an order. In the case of transferring an empty list, the customer will be presented with a default list of payment methods according to the merchnat's configuration.

List with payment types: [CARD, CARD_TOKEN, GOOGLE_PAY, APPLE_PAY, BLIK_CODE, BLIK_TOKEN, PAY_BY_LINK, SHOPPING_LIMIT, DEFERRED_PAYMENT, CASH_ON_DELIVERY]

object

Y

"payment_type":["CARD","CARD_TOKEN","APPLE_PAY","BLIK_CODE","BLIK_TOKEN","PAY_BY_LINK","SHOPPING_LIMIT","DEFERRED_PAYMENT","GOOGLE_PAY"],

summary.basket_notice

Object with additional information of the basket which the merchant wants to transfer to the customer in the InPost Pay App

object

O

summary.basket_notice.type

Information Type. We can distinguish two information types, based on which the app presents the relevant Enum message format: [ATTENTION, ERROR]:

ATTENTION - to be used if we want to notify the customer of significant information about the basket, e.g. promotional code, adding a free product etc.

ERROR- to be used if any action couldn't be performed for the basket eg. incorrect discount code or unsuccessful addition of a suggested product.

string

Y

"type":"ATTENTION"

summary.basket_notice.description

The message presented to the customer in the InPost Pay app for the given notice.type

string

Y

"description": "the code has been activated"

delivery

Object intended to transfer information related to delivery methods preferred for the given basket

array

Y

delivery.delivery_type

Delivery method.. Two forms available Enum:[APM, COURIER]

APM - parcel locker,

COURIER - InPost courier

string

Y

"delivery_type":"APM"

delivery.delivery_date

Suggested delivery date

string($date-time)

Y

"delivery_date":"2023-09-14T12:00:00.000Z"

delivery.delivery_options

Object intended to transfer additional description of the delivery. Currently two additional delivery options available:

PWW- parcel on weekend

COD- cash on delivery. If, for a given basket, the payment_type is CASH_ON_DELIVERY, it is required to enter COD as an additional delivery option

O

delivery.delivery_options.delivery_name

Name of additional delivery option

string

Y

"delivery_name": "Paczka w Weekend"

delivery.delivery_options.delivery_code_value

Additional delivery option code. Currently available, two codes:

PWW - parcel on weekend

COD - cash on delivery

string

Y

 "delivery_code_value": "PWW"

delivery.delivery_options.delivery_option_price

Object intended to transfer information related to the cost of additional delivery options

object

Y

delivery.delivery_options.delivery_option_price.net

Net price

number ($decimal) (10,2)

Y

"delivery_option_price ":{"net":"10.00","gross":"12.30","vat":"2.30"}

delivery.delivery_options.delivery_option_price.gorss

Gross Price (net + VAT)

number ($decimal) (10,2)

Y

delivery.delivery_options.delivery_option_price.vat

VAT

number ($decimal) (10,2)

Y

delivery.delivery_price

Object intended to transfer information related to the cost of delivery

object

Y

delivery.delivery_price.net

Net price

number ($decimal) (10,2)

Y

"delivery_price":{"net":"10.00","gross":"12.30","vat":"2.30"}

delivery.delivery_price.gorss

Gross Price (net + VAT)

number ($decimal) (10,2)

Y

delivery.delivery_price.vat

VAT

number ($decimal) (10,2)

Y

free_delivery_minimum_gross_price

The minimum basket value from which the delivery cost will be PLN 0

number ($decimal) (10,2)

O

"free_delivery_minimum_gross_price": "100.00"

promo_codes

List of promotional codes applied for the basket

array

O

promo_codes.name

Code name. In the app's next version, the field not required

string

Y

 "name ": "Promotion 5%"

promo_codes.promo_code_value

Promotion code

string

Y

"promo_code_value": "INPOST10"

products

List for providing information of the products in the basket

array

Y

products.product_id

Product ID assigned by the merchant

string

Y

"product_id": 26

products.product_category

Product category assigned by the merchant

string

O

"product_category":20

products.ean

ean

string

O

"ean":"0"

products.product_name

Product name

string

Y

"product_name": "washpapa backpack"

products.product_description

Product description

string

O

"product_description": "  \r\n\r\nSometimes you just want to leave everything, pack your bags and go to Bieszczady? It's a good plan for holidays. And during the year, simply discover your city again.\r\n\r\ Exploration cannot be successful without a reliable backpack with foldable closings and made of high quality materials, such as our.\r\n\r\nThe cotton straps ensure the convenience of carrying, and washpapa will express your devotion to the nature. Remember! Behind each adventure, there is a good backpack."

products.product_link

Link to the product on the merchant's website

string

O

"product_link":"https://test.outofthebox.pl/product/plecak-washpapa/"

products.product_image

Link to a photograph of the product. Formats preferable: png, jpg (recommendation: png without background)

string

O

"product_image":"https://test.outofthebox.pl/img/2022/10/INPOST_aranzacje-z-modelami25-1.jpg"

Formats preferable: png, jpg (recommendation: png without background)

products.base_price

Product's base price

object

Y

products.base_price.net

Net price

number ($decimal) (10,2)

Y

"base_price":{"net":"161.79","gross":"199.00","vat":"37.21"}

products.base_price.gross

Gross Price (net + VAT)

number ($decimal) (10,2)

Y

products.base_price.vat

VAT

number ($decimal) (10,2)

Y

products.promo_price

Promotional price of the product

object

O

products.promo_price.net

Net price

number ($decimal) (10,2)

Y

"promo_price":{"net":"160.98","gross":"198.00","vat":"37.02"}

products.promo_price.gorss

Gross Price (net + VAT)

number ($decimal) (10,2)

Y

products.promo_price.vat

VAT

number ($decimal) (10,2)

Y

products.lowest_price

Object intended to transfer the lowest price of the product over the previous 30 days. Required in order to handle the Omibus directive. Object required to be transferred if the product's promotional price was provoded (obiekt promo_price).

object

O

products.lowest_price.net

Net price

number ($decimal) (10,2)

Y

"lowest_price ":{"net":"160.98","gross":"198.00","vat":"37.02"}

products.lowest_price.gorss

Gross Price (net + VAT)

number ($decimal) (10,2)

Y

products.lowest_price.vat

VAT

number ($decimal) (10,2)

Y

products.quantity

Object for reporting the product quantity

object

Y

products.quantity.quantity

product quantity

number ($decimal)

Y

"quantity":1

products.quantity.quantity_type

Field type quantity. Available values: Enum: [DECIMAL, INTEGER]

string

Y

"quantity_type":"INTEGER"

products.quantity.quantity_unit

Quantity unit of the product

string

O

"quantity_unit":"pcs"

products.quantity.available_quantity

The quantity available at the store

number ($decimal)

O

"available_quantity":26

products.quantity.max_quantity

The maximum number of the product a Customer can order e.g. at one order

number ($decimal)

O

"max_quantity":26

products.product_attributes

Object intended to determine the product's attributes

array

O

products.product_attributes.attribute_name

Attribute name

string

Y

"product_attributes ": [{ "attribute_name ": "Dimensions/Capacity", "attribute_value ":"54 cm x 38 cm x 10 cm "}, { "attribute_name ": "Material", "attribute_value": "Washable paper standard + kodura + woven cotton straps"}]

products.product_attributes.attribute_value

Attribute value

string

Y

products.variants

Object intended to transfer products' variants. Object currently not used. The functionality shall be implemented in the app's subsequent versions.

object

O

products.variants.variant_id

Version's Id

string

Y

-

products.variants.variant_name

Version's name

string

Y

-

products.variants.variant_description

Version's detailed description

string

O

-

products.variants.variant_type

Version's type

string

O

-

products.variants.variant_values

Version's value

string

O

-

related_products

Object intended to transfer the list of products suggested for a given basket that the customer can add from the level of the InPost Pay app

array

O

related_products.product_id

Product ID assigned by the merchant

string

Y

"product_id": 26

related_products.product_category

Product category assigned by the merchant

string

O

"product_category":20

related_products.ean

Ean

string

O

"ean":"0"

related_products.product_name

Product name

string

Y

"product_name": "washpapa backpack"

related_products.product_description

Product description

string

O

"product_description": "  \r\n\r\nSometimes you just want to leave everything, pack your bags and go to Bieszczady? It's a good plan for holidays. And during the year, simply discover your city again.\r\n\r\ Exploration cannot be successful without a reliable backpack with foldable closings and made of high quality materials, such as our.\r\n\r\nThe cotton straps ensure the convenience of carrying, and washpapa will express your devotion to the nature. Remember! Behind each adventure, there is a good backpack."

related_products.product_link

Link to the product on the merchant's website

string

O

"product_link":"https://test.outofthebox.pl/product/plecak-washpapa/"

related_products.product_image

Link to a photograph of the product. Formats preferable: png, jpg (recommendation: png without background)

string

"product_image":"https://test.outofthebox.pl/img/2022/10/INPOST_aranzacje-z-modelami25-1.jpg"

Formats preferable: png, jpg (recommendation: png without background)

related_products.base_price

Product's base price

object

Y

related_products.base_price.net

Net price

number ($decimal) (10,2)

Y

"base_price":{"net":"161.79","gross":"199.00","vat":"37.21"}

related_products.base_price.gross

Gross Price (net + VAT)

number ($decimal) (10,2)

Y

related_products.base_price.vat

VAT

number ($decimal) (10,2)

Y

related_products.promo_price

Promotional price of the product

object

O

related_products.promo_price.net

Net price

number ($decimal) (10,2)

Y

"promo_price":{"net":"160.98","gross":"198.00","vat":"37.02"}

related_products.promo_price.gross

Gross Price (net + VAT)

number ($decimal) (10,2)

Y

related_products.promo_price.vat

VAT

number ($decimal) (10,2)

Y

related_products.lowest_price

Object intended to transfer the lowest price of the product over the previous 30 days. Required in order to handle the Omibus directive. Object required to be transferred if the product's promotional price was provoded (obiekt promo_price).

object

O

related_products.lowest_price.net

Net price

number ($decimal) (10,2)

Y

"lowest_price ":{"net":"160.98","gross":"198.00","vat":"37.02"}

related_products.lowest_price.gorss

Gross Price (net + VAT)

number ($decimal) (10,2)

Y

related_products.lowest_price.vat

VAT

number ($decimal) (10,2)

Y

related_products.quantity

Object for reporting the product quantity

object

Y

related_products.quantity.quantity

product quantity

number ($decimal)

Y

"quantity":1

related_products.quantity.quantity_type

Field type quantity. Available values: Enum: [DECIMAL, INTEGER]

string

Y

"quantity_type":"INTEGER"

related_products.quantity.quantity_unit

Quantity unit of the product

string

O

"quantity_unit":"pcs"

related_products.quantity.available_quantity

The quantity available at the store

number ($decimal)

O

"available_quantity":26

related_products.quantity.max_quantity

The maximum number of the product a Customer can order e.g. at one order

number ($decimal)

O

"max_quantity":26

related_products.product_attributes

Object intended to determine the product's attributes

array

O

related_products.product_attributes.attribute_name

Attribute name

string

Y

"product_attributes ": [{ "attribute_name ": "Dimensions/Capacity", "attribute_value ":"54 cm x 38 cm x 10 cm "}, { "attribute_name ": "Material", "attribute_value": "Washable paper standard + kodura + woven cotton straps"}]

related_products.product_attributes.attribute_value

Attribute value

string

Y

related_products.variants

Object intended to transfer products' variants

object

O

 Object currently not used. The functionality shall be implemented in the app's subsequent versions.

related_products.variants.variant_id

Version's Id

string

Y

-

related_products.variants.variant_name

Version's name

string

Y

-

related_products.variants.variant_description

Version's detailed description

string

O

-

related_products.variants.variant_type

Version's type

string

O

-

related_products.variants.variant_values

Version's value

string

O

-

consents

Object intended to transfer the list of consents for a given basket

array

 Y

consents.consent_id

Consent IDs assigned by the merchant

string

 Y

"consent_id":3

consents.consent_link

The link which redirects to the full content of a consent eg. to the merchant's website

string

 Y

"consent_link":"https://test.outofthebox.pl/zwroty-i-reklamacje/"

consents.consent_description

Description of the consent, not more than 500 characters

string

 Y

"consent_description": "zwroty i reklamacje"

consents.consent_version

Consent version

string

 Y

"consent_version":1

consents.requirement_type

Consent type. Available values: Enum: [OPTIONAL, REQUIRED_ONCE, REQUIRED_ALWAYS]

OPTIONAL-- Consent optional

REQUIRED_ONCE - required once. A consent of such a type and version will be included in the user's profile, with information that the customer has consented, and, in the case of further baskets, will be checked by default.

REQUIRED_ALWAYS - required always. A consent of such a type and version is saved to the user's profile. The customer must consent each time.

string

 Y

"requirement_type":"OPTIONAL"