Basket Update
A method used to pass basket updates made by the customer in the InPost Pay app. Upon receiving an event informing the Merchant of a change in the basket, the Merchant in response should send the entire updated basket.
For this method, we require the implementation of all the fields listed in the table, as they make up the entirety of the InPost Pay service. Some of the following fields in the 'Required' column are marked as 'O', i.e. optional, due to the fact that not all products/baskets in online stores have all parameters assigned, so a basket can be created and an order placed without them. However, the implementation/deployment of all fields is REQUIRED from a business perspective.
POST /v1/izi/basket/{basket_id}/event
Parameters
Field name | Description | Type | Requirement status | Additional remarks |
| Unique basket identifier assigned by the merchant | string | Y |
|
Request
Field name | Description | Type | Requirement status | Additional remarks |
| Event ID | string | Y |
|
| Date and time when the event occurred | string($date-time) | Y |
|
| Event type. Enum:
| string | Y |
|
| Information about the user number to which the basket is linked | object | O |
|
| Prefix | string | Y |
|
| Phone number | string | Y |
|
| An object that returns details of the |
| O |
|
| Product identifier assigned by the merchant | string | Y |
|
| An object used to pass information about the quantity of the product | object | Y |
|
| Product quantity | number ($decimal) | Y |
|
| Type of quantity field. Available values If the · Example 1) We have 5 shirts at a price of PLN 10 per piece. In this case · Example 2) We have 0.35 kg of flour at a price of PLN 5. In this case, | string | O |
|
| Product quantity unit | string | O |
|
| Quantity of the product available in the store | number ($decimal) | O |
|
| The maximum quantity of a product that a customer can order, e.g. in a single order | number ($decimal) | O |
|
| An object that returns details of | object | O |
|
| Code name. This field is not required in the next version of the application. | string | Y |
|
| Promo code | string | Y |
|
| Object that returns the details of the | object | O |
|
| Product identifier assigned by the merchant | string | Y |
|
| Ean | string | O |
|
| An object used to pass information about the quantity of the product | object | Y |
|
| Product quantity | number ($decimal) | Y |
|
| Type of quantity field . available values | string | O |
|
| Product quantity unit | string | O |
|
| Quantity of the product available in the store | number ($decimal) | O |
|
| The maximum quantity of a product that a customer can order, e.g. in a single order | number ($decimal) | O |
|
Response
Field name | Description | Type | Requirement status | Additional remarks |
| Object used to provide basic details about the basket | object | Y |
|
| Object used to pass the base price for the basket without 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 | |
| An object used to pass the final price of a basket with a promotion and discount code included on the basket, without 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 | |
| The flag indicating whether the basket without delivery costs is free. | boolean | O |
|
| An object for passing the price of a basket with a promotion included for the basket, but without an applied discount code and without 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 currency. The only currency currently supported is PLN | string | Y |
|
| Basket expiration/validity date. This is the date after which the basket will be automatically removed from the InPost Pay app (will expire). The date cannot be a past date. | string($date-time) | O |
|
| This field is used to provide additional information about the basket that, from the merchant's point of view, may be relevant to the customer | string | O |
|
| Preferred payment method for the basket. The merchant passs a list of preferred payment methods for the basket from which the customer can then select payment methods when creating an order. If an empty list is passed, the customer will be presented with a default list of payments according to the merchant's configuration in the payment gateway and CASH_ON_DELIVERY when List with possible payment types: | object | Y |
|
| An object with additional information about the basket that the merchant wants to provide to the customer in the InPost Pay app | object | O |
|
| Type of information. There are two types of information based on which the application will present the appropriate format of the message Enum: [
| string | Y |
|
| The contents of the message presented to the customer in the InPost Pay app for the relevant notice.type | string | Y |
|
| An object used to pass additional basket parameters that are saved in the basket details during basket creation/update. The Merchant can use this object, for example, to save parameters that will enable identification/association of the basket with a campaign. Additional parameters are not displayed in the application. | array | O |
|
| Key | string | Y |
|
| Value | string | Y |
|
| An object used to provide information about the preferred delivery options for the relevant basket | array | Y |
|
| Delivery option. Enum:[ APM, COURIER, DIGITAL ]. APM – automated parcel machine, COURIER – InPost courier service | string | Y |
|
| Suggested delivery date | string($date-time) | Y |
|
| An object used for passing additional delivery options. Currently, two additional delivery options are available:
|
|