- Created by Joanna Wołosz, last modified on Sept 27, 2024
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 2 Next »
A Method of Transferring Basket Updates Made by a Customer in the InPost Pay App. In their response to an event informing the Merchant of a change in the basket, the Merchant should submit the whole updated basket.
POST /v1/izi/basket/{basket_id}/event
Parameters
Field name | Description | Type | Requirement status | Additional remarks |
| Basket's unique ID assigned by the merchant | string | Y |
|
Request
Field name | Description | Type | Requirement status | Additional remarks |
| Event's ID | string | Y | |
| Event's date and time | string($date-time) | Y | |
| Event's Type. Enum:
| string | Y | |
| The user's number associated with the basket | object | O | |
| Prefix | string | Y | |
| Telephone number | string | Y | |
| Object which returns the event's details PRODUCTS_QUANTITY |
| O | |
| Product ID assigned by the merchant | string | Y |
|
| Object for reporting the product quantity | object | Y | |
| product quantity | number ($decimal) | Y |
|
| 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.
| string | O |
|
| Quantity unit of the product | string | O |
|
| The quantity available at the store | number ($decimal) | O |
|
| The maximum number of the product a Customer can order e.g. at one order | number ($decimal) | O |
|
| Object which returns the event's details PROMO_CODES | object | O | |
| Code name. In the app's next version the field not required | string | Y |
|
| Promotion code | string | Y |
|
| Object which returns the event's details RELATED_PRODUCTS | object | O | |
| Product ID assigned by the merchant | string | Y |
|
| Ean | string | O |
|
| Object for reporting the product quantity | object | Y | |
| product quantity | number ($decimal) | Y |
|
| Field type quantity. Values available Enum: [DECIMAL, INTEGER] | string | O |
|
| Quantity unit of the product | string | O |
|
| The quantity available at the store | number ($decimal) | O |
|
| The maximum number of the product a Customer can order e.g. at one order | number ($decimal) | O |
|
Response
Field name | Description | Type | Requirement status | Additional remarks |
| Object intended to transfer the basket's key data | object | Y | |
| Object intended to transfer the main price for the basket without the delivery costs | object | Y | |
| Net price | number ($decimal) (10,2) | Y |
|
| Gross Price (net + VAT) | number ($decimal) (10,2) | Y | |
| VAT | number ($decimal) (10,2) | Y | |
| Object intended to transfer the basket's final price with any promotion and discount code taken into account without the delivery costs. | object | O | |
| Net price | number ($decimal) (10,2) | Y |
|
| Gross Price (net + VAT) | number ($decimal) (10,2) | Y | |
| VAT | number ($decimal) (10,2) | Y | |
| 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 | |
| Net price | number ($decimal) (10,2) | Y |
|
| Gross Price (net + VAT) | number ($decimal) (10,2) | Y | |
| VAT | number ($decimal) (10,2) | Y | |
| Basket's currency. Currently, the only currency available PLN | string | Y |
|
| 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 |
|
| 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 |
|
| 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 |
|
| Object with additional information of the basket which the merchant wants to transfer to the customer in the InPost Pay App | object | O | |
| Information Type. We can distinguish two information types, based on which the app presents the relevant Enum message format: [ATTENTION, ERROR]:
| string | Y |
|
| The message presented to the customer in the InPost Pay app for the given notice.type | string | Y |
|
| Object intended to transfer information related to delivery methods preferred for the given basket | array | Y | |
| Delivery method.. Two forms available Enum:[APM, COURIER]
| string | Y |
|
| Suggested delivery date | string($date-time) | Y |
|
| Object intended to transfer additional description of the delivery. Currently two additional delivery options available:
|
| O | |
| Name of additional delivery option | string | Y |
|
| Additional delivery option code. Currently available, two codes:
| string | Y |
|
| Object intended to transfer information related to the cost of additional delivery options | object | Y | |
| Net price | number ($decimal) (10,2) | Y |
|
| Gross Price (net + VAT) | number ($decimal) (10,2) | Y | |
| VAT | number ($decimal) (10,2) | Y | |
| Object intended to transfer information related to the cost of delivery | object | Y | |
| Net price | number ($decimal) (10,2) | Y |
|
| Gross Price (net + VAT) | number ($decimal) (10,2) | Y | |
| VAT | number ($decimal) (10,2) | Y | |
| The minimum basket value from which the delivery cost will be PLN 0 | number ($decimal) (10,2) | O |
|
| Functionality using the object will be available in subsequent versions of the application Object used to provide information about the estimated delivery time in the event that the customer orders goods within a specified time. | array | O |
|
| Message presented to the customer in application | string | Y | |
| Days of the week on which the message is presented | array | O | |
| The time from which the message is presented | string | O | |
| The time until which the message is presented | string | O | |
| List of promotional codes applied for the basket | array | O | |
| Code name. In the app's next version, the field not required | string | Y |
|
| Promotion code | string | Y |
|
| Specifies the type of regulation or restriction that the promotional code is subject to. | string | O |
|
| Functionality using the object will be available in subsequent versions of the application. An object used to provide a list of available promotions for the cart. | array | O |
|
| Promotional code name | string | O | |
| Description of the promotion that will be presented in aplication | string | O | |
| Link to a photo or logo | string | O | |
| Promotion start date | string($date-time) | O | |
| Promotion end date | string($date-time) | O | |
| Priority of presenting the offer on the basket in application. | integer | O | |
| Object used to transfer promotion documents | array | O | |
| Document name | string | O | |
| Document link | string | O | |
| List for providing information of the products in the basket | array | Y | |
| Product ID assigned by the merchant | string | Y |
|
| Product category assigned by the merchant | string | O |
|
| ean | string | O |
|
| Product name | string | Y |
|
| Product description | string | O |
|
| Link to the product on the merchant's website | string | O |
|
| Link to a photograph of the product. Formats preferable: png, jpg (recommendation: png without background) | string | O |
|
| Object to pass additional product images (list) | object | O |
|
| Product image. | string | Y |
|
| Product image. | string | Y |
|
| Product's base price | object | Y | |
| Net price | number ($decimal) (10,2) | Y |
|
| Gross Price (net + VAT) | number ($decimal) (10,2) | Y | |
| VAT | number ($decimal) (10,2) | Y | |
| Promotional price of the product | object | O | |
| Net price | number ($decimal) (10,2) | Y |
|
| Gross Price (net + VAT) | number ($decimal) (10,2) | Y | |
| VAT | number ($decimal) (10,2) | Y | |
| 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 | |
| Net price | number ($decimal) (10,2) | Y |
|
| Gross Price (net + VAT) | number ($decimal) (10,2) | Y | |
| VAT | number ($decimal) (10,2) | Y | |
| Object for reporting the product quantity | object | Y |
|
| product quantity | number ($decimal) | Y |
|
| Field type quantity. Available values: Enum: [DECIMAL, INTEGER]
| string | Y |
|
| Quantity unit of the product | string | O |
|
| The quantity available at the store | number ($decimal) | O |
|
| The minimum number of the product a Customer can order e.g. at one order | number ($decimal)
| O |
|
| The maximum number of the product a Customer can order e.g. at one order | number ($decimal) | O |
|
| The quantity jump value in case of increase/decrease of product quantity by customer (e.g. 0.1 or 0.5 or 0.01) | number ($decimal) | O |
|
| Object intended to determine the product's attributes | array | O |
|
| Attribute name | string | Y |
|
| Attribute value | string | Y | |
| Object used to provide information about available delivery methods for a product. If there is no delivery_product object, it means that delivery is available in all types. | object | O |
|
| Delivery type | string | O |
|
| Flag indicating whether the delivery type is available. | string | O |
|
| 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 |
|
| Product ID assigned by the merchant | string | Y |
|
| Product category assigned by the merchant | string | O |
|
| Ean | string | O |
|
| Product name | string | Y |
|
| Product description | string | O |
|
| Link to the product on the merchant's website | string | O |
|
| Link to a photograph of the product. Formats preferable: png, jpg (recommendation: png without background)
| string |
|
|
| Object to pass additional product images (list) | object | O |
|
| Product image. Preferred size 360 x 352 | string | Y |
|
| Product image. Preferred size 360 x 504 | string | Y |
|
| Product's base price | object | Y |
|
| Net price | number ($decimal) (10,2) | Y |
|
| Gross Price (net + VAT) | number ($decimal) (10,2) | Y | |
| VAT | number ($decimal) (10,2) | Y | |
| Promotional price of the product | object | O | |
| Net price | number ($decimal) (10,2) | Y |
|
| Gross Price (net + VAT) | number ($decimal) (10,2)
| Y | |
| VAT | number ($decimal) (10,2)
| Y | |
| 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 | |
| Net price | number ($decimal) (10,2) | Y |
|
| Gross Price (net + VAT) | number ($decimal) (10,2) | Y | |
| VAT | number ($decimal) (10,2) | Y | |
| Object for reporting the product quantity | object | Y | |
| product quantity | number ($decimal) | Y |
|
| Field type quantity. Available values: Enum: [DECIMAL, INTEGER]
| string | Y |
|
| Quantity unit of the product | string | O |
|
| The quantity available at the store | number ($decimal) | O |
|
| The minimum number of the product a Customer can order e.g. at one order | number ($decimal) | O |
|
| The maximum number of the product a Customer can order e.g. at one order | number ($decimal) | O |
|
| The quantity jump value in case of increase/decrease of product quantity by customer (e.g. 0.1 or 0.5 or 0.01) | number ($decimal) | O |
|
| Object intended to determine the product's attributes | array | O | |
| Attribute name | string | Y |
|
| Attribute value | string | Y | |
| Object used to provide information about available delivery methods for a product. If there is no delivery_product object, it means that delivery is available in all types. | object | O | |
| Delivery type | string | O | |
| Flag indicating whether the delivery type is available. | boolean | O | |
| Object informing whether the customer will receive free shipping after adding the suggested product to the cart If if_delivery_free= true is on a given suggested product, the customer will be presented with an appropriate message on that product. | boolean | O | |
| Object intended to transfer the list of consents for a given basket | array | Y | |
| Consent IDs assigned by the merchant | string | Y |
|
| The link which redirects to the full content of a consent eg. to the merchant's website | string | Y |
|
| Label to the link passed in consent_link | string | O |
|
| Object used to provide an additional link to the consent/regulations | object | O |
|
| Consent ID assigned by the merchant | string | O |
|
| Link redirecting to the full content, e.g. to the merchant’s website | string | O |
|
| Label to the link passed in consent_link | string | O |
|
| Description of the consent, not more than 500 characters | string | Y |
|
| Consent version | string | Y |
|
| Consent type. Available values: Enum: [OPTIONAL, REQUIRED_ONCE, REQUIRED_ALWAYS]
| string | Y |
|
| Object used to pass the customer's shopping cart cookie in order to enable redirection from the application to the shopping cart in the merchant's store. | object | O |
|
| Url of the merchant shop | string | Y |
|
| Object used to pass the cookie | object | Y |
|
| The cookie domain represented by pair key-value | string | Y |
|
| Cookie key | string | Y |
|
| Cookie value | string | Y |
|
| Cookie path | string | O |
|
| Cookie expiration time or maxAge | string($date-time) | O |
|
| Cookie security information | string | O |
|
| Cookie http information | string | O |
|
| Cookie sameSite information [ STRICT, LAX, NONE ] | string | O |
|
| Cookie priority [ LOW, MEDIUM, HIGH ] | string | O |
|
| Cookie max age | number ($decimal) | O |
|
Example request
{
"event_id":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"event_data_time":"2023-08-23T11:14:33.973Z",
"event_type":"PRODUCTS_QUANTITY",
"phone_number": {
"country_prefix":"+48",
"phone":"5xxxxxxxx"
},
"quantity_event_data": [
{
"product_id":"549",
"quantity": {
"quantity":3
}
}
]
}
Response
{
"summary": {
"basket_base_price": {
"net":"249.59",
"gross":"307.00",
"vat":"57.41"
},
"basket_final_price": {
"net":"242.01",
"gross":"297.67",
"vat":"55.66"
},
"basket_promo_price": {
"net":"242.01",
"gross":"297.67",
"vat":"55.66"
},
"currency":"PLN",
"basket_expiration_date":"2023-08-25T11:09:29.000Z",
"basket_additional_information":"",
"payment_type": [
"CARD",
"CARD_TOKEN",
"APPLE_PAY",
"BLIK_CODE",
"BLIK_TOKEN",
"PAY_BY_LINK",
"SHOPPING_LIMIT",
"DEFERRED_PAYMENT",
"GOOGLE_PAY",
"CASH_ON_DELIVERY"
],
"basket_notice":null
},
"delivery": [
{
"delivery_type":"APM",
"delivery_date":"2023-08-25T12:00:00.000Z",
"delivery_options":[],
"delivery_price": {
"net":"0.00",
"gross":"0.00",
"vat":"0.00"
}
},
{
"delivery_type":"COURIER",
"delivery_date":"2023-08-25T12:00:00.000Z",
"delivery_options":[],
"delivery_price": {
"net":"0.00",
"gross":"0.00",
"vat":"0.00"
}
}
],
"promo_codes":[],
"products": [
{
"product_id":10678,
"product_category":53,
"ean":"wp-pennant-1",
"product_name":"Klocki Paczkomat InPost z samochodem eko",
"product_description":" \r\n\r\nA wiesz, że każdy jest kurierem własnego życia? Przecież gdy mówisz, to dostarczasz informacje, a jak się uśmiechasz to... dostarczasz radość. Jeszcze większą radość zobaczysz na twarzy dziecka, gdy dostarczysz mu zestaw klocków: paczkomat wraz z ekobusem.\r\n\r\nTo unikalny zestaw, dzięki któremu dzieci mogą wcielić się w rolę kuriera i poczuć jak to jest, gdy dostarcza się same dobre wiadomości czy prezenty. A co najlepsze, klocki pasują do innych klocków konstrukcyjnych co sprawia, że możliwości zabawy stają się nieograniczone.\r\n\r\nKlocki przeznaczone są dla dzieci od 8 lat, ale potrafią obudzić dziecko w człowieku do 80 lat i więcej. W końcu dobra zabawa nie zna wieku.",
"product_link":"https://outofthebox.pl/product/paczkomat-inpost-z-samochodem-eko/",
"product_image":"https://outofthebox.pl/app/uploads/2022/11/INPOST_aranzacje-z-modelami18.jpg",
"base_price": {
"net":"113.01",
"gross":"139.00",
"vat":"25.99"
},
"promo_price": {
"net":"113.01",
"gross":"139.00",
"vat":"25.99"
},
"quantity": {
"quantity":2,
"quantity_type":"INTEGER",
"quantity_unit":"pcs",
"available_quantity":7507,
"max_quantity":7507
},
"product_attributes": [
{
"attribute_name":"Wymiary/Pojemność",
"attribute_value":"344 cm x 60 cm x 240 cm"
}
],
"variants":[]
},
{
"product_id":549,
"product_category":20,
"ean":"0",
"product_name":"Paczkotorba bawełniana",
"product_description":" \r\n\r\nTa torba bawełniana lubi być czysta i wyprana. Lubi, bo jest z bawełny, tak jak wiele Twoich ubrań. Dlatego pralka nie robi jej krzywdy.\r\n\r\nTorba polecana jest szczególnie tym, którzy nie chcą za każdym razem wracać z zakupów z toną jednorazowych woreczków foliowych.\r\n\r\nTorba jest szyta lokalnie. W Polsce, a nie na końcu świata.\r\n\r\nMetr kwadratowy materiału, z którego stworzono torbę, waży 280 gramów. Gdyby miała ręce, włożyłaby sobie do środka spory ciężar i nic by się jej nie stało.\r\n\r\nUwaga: torba InPost ma wielkie uszy, żeby można było ją nosić w stylu out of the box.",
"product_link":"https://outofthebox.pl/product/paczkotorba-bawelniana/",
"product_image":"https://outofthebox.pl/app/uploads/2022/10/INPOST_aranzacje-z-modelami24-1.jpg",
"base_price": {
"net":"23.58",
"gross":"29.00",
"vat":"5.42"
},
"promo_price": {
"net":"15.99",
"gross":"19.67",
"vat":"3.68"
},
"quantity": {
"quantity":"1",
"quantity_type":"INTEGER",
"quantity_unit":"pcs",
"available_quantity":240,
"max_quantity":240
},
"product_attributes":[],
"variants":[]
}
],
"related_products": [
{
"product_id":606,
"product_category":17,
"ean":"0",
"product_name":"Paczkokurtka","product_description":" \r\n\r\nNormalne kurtki są normalne.\r\n\r\nPrzód i tył. Lewy rękaw i prawy rękaw. Kaptur i kieszenie.\r\n\r\nKurtki InPost -- są zawsze out of the box! Oprócz wszystkiego, co ma normalna kurtka -- mają jeszcze ogromną kieszeń, są wodoodporne i wiatroszczelne. Ta kieszeń jest tak duża, że może pomieścić w sobie na przykład paczkę. Albo coś innego, co tylko przyjdzie Ci do głowy.\r\nWierzchni materiał pokryty jest powłoką Water Repellent, dzięki czemu woda skrapla się na jego powierzchni\r\n\r\nBo wszystko, co najlepsze, zaczyna się od głowy.\r\nOd pomysłu, który jest inny.\r\n\r\nKtóry jest Out of the box!\r\n\r\nPaczkokurtka InPost dostępna jest w czterech rozmiarach: S, M, L, XL.",
"product_link":"https://outofthebox.pl/product/paczkokurtka-rozm-s/",
"product_image":"https://outofthebox.pl/app/uploads/2022/10/INPOST_aranzacje-z-modelami25-1.jpg",
"base_price": {
"net":"172.07",
"gross":"211.65",
"vat":"0.00"
},
"promo_price": {
"net":"172.07",
"gross":"211.65",
"vat":"0.00"
},
"quantity": {
"quantity":1,
"quantity_type":"INTEGER",
"quantity_unit":"pcs",
"available_quantity":999,
"max_quantity":999
},
"product_attributes":[],
"variants":[]
},
{
"product_id":452,
"product_category":53,
"ean":"0",
"product_name":"Klocki Sortownia",
"product_description":"sdadsadsadasdas",
"product_link":"https://outofthebox.pl/product/sortownia/",
"product_image":"https://outofthebox.pl/app/uploads/2022/10/INPOST_aranzacje-z-modelami17.jpg",
"base_price": {
"net":"186.18",
"gross":"229.00",
"vat":"0.00"
},
"promo_price": {
"net":"186.18",
"gross":"229.00",
"vat":"0.00"
},
"quantity": {
"quantity":1,
"quantity_type":"INTEGER",
"quantity_unit":"pcs",
"available_quantity":55844,
"max_quantity":55844
},
"product_attributes":[],
"variants":[]
}
],
"consents": [
{
"consent_id":3,
"consent_link":"https://outofthebox.pl/zwroty-i-reklamacje/",
"consent_description":"zwroty i reklamacje",
"consent_version":1,
"requirement_type":"OPTIONAL"
}
]
}
- No labels