Versions Compared
Version | Old Version 1 | New Version 2 |
---|---|---|
Changes made by | ||
Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
The method for downloading the details of an order through the InPost Pay app from the Merchant.
Status | ||||
---|---|---|---|---|
|
/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 | |
| Street | string | O | |
| Building number | string | O | |
| Apartment number | string | O | |
| Postal code | string | O | |
| string | O | ||
| Registration date | string | O | |
| Additional information | string | O | |
| Delivery Information | object | Y | |
| Delivery form Enum:[ APM, COURIER ] | string | Y |
|
| Delivery date | string($date-time) | Y |
|
| The options selected for a delivery | array | O | |
| Name | string | Y |
|
| Option code | string | Y | |
| Delivery option amount | object | Y | |
| Net | number ($decimal) | Y | |
| Gross | number ($decimal) | Y | |
| VAT | number ($decimal) | Y | |
| string | O |
| |
| Delivery phone number | object | O | |
| Prefix | string | Y |
|
| Telephone number | string | Y | |
| Automatic parcel locker delivery site | string | O |
|
| Delivery address | object | O | |
| Name | string | Y |
|
| Country code | string | Y | |
| Address | string | Y | |
| City | string | Y | |
| Postal code | string | 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 | |
| Notes for the courier | string | O |
|
| List of the products in an order | 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 |
|
| Base price for the product | 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 for reporting the product quantity | object | Y | |
| product quantity | number ($decimal) | Y |
|
| Field type quantity. Available values: [DECIMAL, INTEGER] | string | 0 |
|
| Quantity unit of the product | string | O |
|
| Object intended to determine the product's attributes | array | O | |
| Attribute name | string | Y |
|
| Attribute value | string | Y | |
| Object intended to transfer products' variants. Object currently not used. The functionality shall be implemented in the app's subsequent versions. | object | O | |
| Version's Id | string | Y |
|
| Version's name | string | Y |
|
| Version's detailed description | string | O |
|
| Version's type | string | O |
|
| Version's value | string | O |
|
| An object intended to transfer information related to the consents expressed by the customer for a given order | array | Y | |
| consent Id | string | Y |
|
| Consent version | string | O |
|
| Info, whether or not the consent has been expressed | boolean | Y |
|
ResponseExample response
Code Block | ||
---|---|---|
| ||
{ "order_details": { "order_comments":"Uwagi", "order_id":"xxx", "pos_id":"xxx", "order_creation_date":"2023-08-18T13:22:00.000Z", "basket_id":"xxx", "order_merchant_status_description":"Oczekiwanie na płatność", "currency":"PLN", "order_base_price": { "net":135.63, "gross":166.83, "vat":31.2 }, "payment_type":"BLIK_CODE" }, "account_info": { "name":"<secret>", "surname":"<secret>", "phone_number": { "country_prefix":"+48", "phone":"5xxxxxxxx" }, "mail":"<secret>", "client_address": { "country_code":"<secret>", "address":"<secret>", "city":"<secret>", "postal_code":"<secret>" } }, "invoice_details": { "legal_form":"COMPANY", "country_code":"<secret>", "tax_id":"<secret>", "company_name":"<secret>", "city":"<secret>", "street":"<secret>", "building":"<secret>", "flat":"<secret>", "postal_code":"<secret>", "mail":"<secret>", "registration_data_edited":"<secret>", "additional_information":"Adnotacje" }, "delivery": { "delivery_type":"COURIER", "delivery_date":"2023-08-25T10:00:00.000Z", "mail":"<secret>", "phone_number": { "country_prefix":"+48", "phone":"5xxxxxxxx" }, "delivery_address": { "name":"<secret>", "country_code":"<secret>", "address":"<secret>", "city":"<secret>", "postal_code":"<secret>" }, "delivery_price": { "net":10.56, "gross":12.99, "vat":2.43 }, "courier_note":"" }, "products": [ { "product_id":"1552", "product_name":"Produkt 1", "base_price": { "net":45.37, "gross":55.81, "vat":10.44 }, "quantity": { "quantity":1, "quantity_type":"INTEGER" } }, { "product_id":"1551", "product_name":"Produkt 2", "base_price": { "net":90.26, "gross":111.02, "vat":20.76 }, "quantity": { "quantity":1, "quantity_type":"INTEGER" } } ], "consents": [ { "consent_id":"Polityka prywatności", "consent_version":"1678260494", "is_accepted":true }, { "consent_id":"Regulamin", "consent_version":"1678260494", "is_accepted":true } ] } |