Order
This chapter describes handling and performing orders with the InPost Pay service together with a list and description of the methods called by the Merchant to InPost, to update an order or download the list of orders.
List of methods
POST
/v1/izi/order/{order_id}/event
- Order updateGET
/v1/izi/orders
- Downloading the list of orders
On this page:
Order Processing with the InPost Pay service
After the user chooses the option "Kupuję i płacę (Buy and pay)" in the InPost Mobile app, before the actual commencement of the payment for the basket, InPost Pay verifies the status of the basket, by downloading the current basket from the Merchant and comparing it with the basket saved in InPost Pay. If the current basket downloaded from the Merchant is the same as the one saved in InPost Pay, then it is verified if the order can be placed. The validation of the order for correctness is performed on the Merchant's side. If the product is not available or another validation is not fulfilled, the order is not created. In such a case, the user sees the relevant message, and they may keep edit the basket.
After an order is created correctly, the basket cannot be edited anymore from the InPost Mobile level, and should not be available for editing on the Merchant's website.
When creating an order, InPost Mobile transfers to the Merchant:
The identifier of the basket, based on which the order is to be created
The final value of the basket with the delivery cost
The payment form chosen by the customer
The ordering party's data (first name, last name, email adres, phone number)
The ordering party's address (optional)
The form and address of the delivery
Invoice data
Comments to order
Information on the consents accepted
When the Customer pays for an order in the InPost Pay app, this information is transferred to the Merchant in order to begin the implementation of the order.
If the COD payment is selected, the order is considered paid immediately.
The Merchant updates the changes in the status of the order along with transferring the information regarding the shipments (one or several), used to send the order. The statuses handled when ordering:
Technical status - used to specify the authorizations that the customer may exercise for the order in the InPost Pay app. We can distinguish 3 technical statuses:
ORDER_COMPLETED
- the status assigned by the merchant, informing the InPost Pay app that the order was completed by the customer on the merchant store's website. An order with the status ORDER_COMPLETED cannot be paid and rejected in the InPost Pay app.ORDER_REJECTED
- the status assigned by the Merchant, or the customer in the InPost Pay app (in the InPost Pay App the customer has the option of rejecting the order before it is paid). The status means the order was rejected. An order with the status ORDER_REJECTED cannot be paid in the InPost Pay app.ORDER_PROCESSING
- the status assigned automatically by the InPost Pay app after being informed by the Merchant of creating an order. An order with theORDER_PROCESSING
status may be paid in the InPost Pay App.
A descriptive status presented to the customer in the InPost Pay app - each Merchant can name a status according to their own process, so that the statuses presented in InPost Mobile are compliant with the status on the Merchant's platform.
Payment statuses - within the payment handling for an order in InPost Pay (Basket App), the following payment statuses will be available:
UNPAID
- the status upon the creation of an order, unpaid. Assigned by InPost Pay (Basket App).STARTED
- the status initiates the customer's payment proces in the InPost Mobile app. Assigned by InPost Pay (Basket App), based on of information from the InPost Mobile app.PENDING
- process commencement. The status assigned by the InPost Pay (Basket App), on the basis of the information transferred from the InPost Mobile app.AUTHORIZED
- payment successful. The status assigned by InPost Pay (Basket App), on the basis of the information transferred from the payment system (payment gate).DECLINED
- payment denial. The status assigned by InPost Pay (Basket App), on the basis of the information transferred from the payment system (payment gate).CANCELLED
- transaction rejected. The status assigned by InPost Pay (Basket App), on the basis of the information transferred from the payment system (payment gate).ERROR
- error. The status assigned by InPost Pay (Basket App), on the basis of the information transferred from the payment system. or from the InPost Mobile app.COD
- cash on delivery.
The ability to pay for an order is available when it has the payment status UNPAID.
Repeating the payment is possible when an order has the payment status DECLINED, CANCELLED, or ERROR.
Payments - redirecting to the payment process at the InPost Mobile app level after placing an order. Available payment forms:
CARD
- payment with a debit/credit cardCARD_TOKEN
- payment with a tokenized cardGOOGLE_PAY
- payment using Google PayAPPLE_PAY
- payment using Apple PayBLIK_CODE
- BLIK paymentBLIK_TOKEN
- BLIK ONE-CLIK paymentPAY_BY_LINK
- PBL paymentSHOPPING_LIMIT
- payment with a limit request: (AION)DEFERRED_PAYMENT
- payment postponed (AION)CASH_ON_DELIVERY
- cash on delivery.