Downloading the details of an order
The method for downloading the details of an order through the InPost Pay app from the Merchant.
GET /v1/izi/order/{order_id}
Parameters
Field name | Description | Type | Requirement status | Additional remarks |
| Order's unique ID assigned by the Merchant | string | Y |
|
Request – none
Response
Field name | Description | Type | Requirement status | Additional remarks |
| Order details | object | Y |
|
| Comments to an order | string | O |
|
| An order ID assigned by the Merchant | string | Y |
|
| POS id | string | Y |
|
| The date of creating an order | string($date-time) | Y |
|
| The identifier of the basket, based on which the order has been created | string | Y |
|
| Selected payment type. Enum:[ CARD, CARD_TOKEN, GOOGLE_PAY, APPLE_PAY, BLIK_CODE, BLIK_TOKEN, PAY_BY_LINK, SHOPPING_LIMIT, DEFERRED_PAYMENT, CASH_ON_DELIVERY ] | string | Y |
|
| A descriptive status presented to the customer in the InPost Pay app - each Merchant may provide the status so that the statuses presented in InPost Mobile are compliant with the status presented to the client in the merchant's store. | string | Y |
|
| Order price without the delivery costs | object | Y |
|
| Net | number ($decimal) | Y |
|
| Gross | number ($decimal) | Y | |
| VAT | number ($decimal) | Y | |
| Order price with the delivery costs | object | Y |
|
| Net | number ($decimal) | Y |
|
| Gross | number ($decimal) | Y | |
| VAT | number ($decimal) | Y | |
| Order's currency (currently, PLN only) | string | Y |
|
| List of the numbers assigned to an order's shipments | array | O |
|
| Information about the account used | object | Y |
|
| First name | string | Y |
|
| Last name | string | Y | |
| Telephone number | object | Y | |
| Prefix | string | Y | |
| User's phone number | string | Y | |
| string | Y |
| |
| User's address | object | Y |
|
| Country code | string | Y |
|
| Address | string | Y | |
| City | string | Y | |
| Postal code | string | Y | |
| Invoice data | object | O |
|
| Legal Form Enum:[ PERSON, COMPANY ] | string | O |
|
| Country code | string | O | |
| Id prefix | string | O | |
| tax identifier | string | O | |
| Company name | string | O | |
| First name | string | O | |
| Last name | string | O | |
| City | string | O | |