Update or adding a basket
The article contains a description of the method used to update a basket together with an example implementation of the method in PHP.
On this page:
Description of the method
A method used to update a basket in the InPost Pay App. If a customer uses a trusted browser, and has a basket not associated with the InPost Pay app, the method also used to create and link the basket to InPost Pay.
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 |
| Unique ID of the trusted browser assigned by the Inpost app. A field only used when the customer uses a trusted browser, and doesn't have a basket linked. In this case, after selecting "Kup z Inpost Pay", the PUT method should be called with the browser_id parameter. | string | O |
|
| 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 client selects the payment method. 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 intended to transfer information related to delivery methods preferred for the given basket | array | Y |
|
| Delivery method.. Enum:[APM, COURIER]. APM – parcel locker device, COURIER – Inpost 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: PWW – parcel on weekend COD – payment at delivery. When for a given basket the payment_type is CASH_ON_DELIVERY, it is required to enter COD as the additional delivery option
| array | O |
|
| Name of additional delivery option | string | Y |
|
| Additional delivery option code. Currently available, two codes: PWW – parcel on weekend COD – payment at delivery
| 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 |
|
| An object used to provide a list of available promotions for the cart. | array | O |
|
| Code type: ONLY_IN_APP - code available only in InPost Pay app (TYLKO W APCE). | string | Y | |
| Code value e.g. DOSTAWA | string | Y | |
| Code description Max: 60 characters | string | Y | |
| Start date from which the code is valid | string($date-time) | O | |
| End date until which the code is valid | string($date-time) | O | |
| Code priority | integer | O | |
| Code details | object | Y | |
| Link to code information details on the merchant's website | string | Y | |
| 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 |
Formats preferable: png, jpg (recommendation: png without background) |
| 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 |
|
| Type quantity. Available values: [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 | 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 |
|
| Object intended to determine the product's attributes | array | O |
|
| Attribute name | string | Y |
|
| Attribute value | string | Y | |
| An object used to provide information about available delivery methods for a product. If there is no | array | O |
|
| Delivery type | string | O |
|
| A flag indicating whether the delivery type is available. | boolean | O |
|
| Object intended to transfer the list of products suggested for a given basket that the customer can add from the Inpost Pay app level | 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 | O |
Formats preferable: png, jpg (recommendation: png without background) |
| 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 |
|
| Type quantity. Available values: [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 |
|
| An 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. | array | 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 | boolean | O |
|
| Object intended to transfer the list of consents for a given basket | array | Y |