Creating an eSmartMIX shipment
eSmartMIX - a service combining the delivery of goods with electronic document circulation. A service dedicated to the delivery of goods that require by hand-delivering with confirmation of the recipient's data. The delivery process requires verification of the addressee using such data as name, surname, age of majority and, if the delivery of a given category of goods requires the sobriety of the recipient of the shipment, this will also be verified. The document confirming the completion of the activity together with the delivery confirmation is returned in the form of a PDF document after the delivery process is completed.
A dedicated contract is required to create a shipment, if you do not have one, please contact smartcourier@inpost.pl.
Shipping dimensions and weight
weight up to 25kg
sum of dimmenssions less then 180cm
max dimmenssion less or equal 80cm
Authentication
Access to the resource requires a valid access token.
The service is only available on a production environment.
Structure
The Shipment
resource for eSmartMIX shipments has the same attributes as in simplified mode. The only difference is that not all of them are supported. Below is a list of parameters that can be used.
Shipment
resource attributes
Attribute | Type | Description |
---|---|---|
| Peer | Recipient details. |
| Array[Parcel] | List of parcels within the shipment. |
| String |
|
| String | Additional shipment description, e.g. order or client ID |
| String | Any comment. |
Attributes of the receiver
object
Attribute | Typ | Description |
---|---|---|
| String | Attribute not required, (the specified value is not shown on the label) Maximum of 255 characters |
| String | Attribute is not required, it becomes required when maximum length 255. |
| String | Attribute is not required, it becomes required when |
| String | Attribute is not required, it becomes required when |
| String | Attribute is required |
| String | Attribute is required. Only 9 digits (333222111) |
| Address Form | Attribute is required |
Attributes of the address
object
Attribute | Type | Description |
---|---|---|
| String | Attribute is required, maximum length 255 |
| String | Attribute is required, maximum length 255 |
| String | Attribute is not required, minimum length 2, maximum length 3 |
| String | Attribute is required, maximum length 255 |
| String | Attribute is required, address format according to the address convention of the post office in the user's country |
Parcel
object attributes
Attribute | Type | Description |
---|---|---|
| String | Unique parcel ID within the shipment that allows for validation errors to be returned in connection to a specific parcel. ID is not persisted in the database and is not returned as an attribute of an already created shipment. |
| Object | Shipment dimensions.
|
| Object | Shipment weight
|
Example query
curl --location 'https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token' \
--data-raw '{
"receiver": {
"name": "InPost",
"company_name": "InPost",
"first_name": "test",
"last_name": "test",
"email": "testi@inpost.pl",
"phone": "885887738",
"address": {
"street": "Czerniakowska",
"building_number": "87A",
"city": "Warszawa",
"post_code": "02-677",
"country_code": "PL"
}
},
"parcels": {
"dimensions": {
"length": "10",
"width": "10",
"height": "10",
"unit": "mm"
},
"weight": {
"amount": "10",
"unit": "kg"
}
},
"service": "inpost_courier_alcohol",
"reference": "numer_zamówienia",
"comments": "komentarz"
}'
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"href": "https://api-shipx-pl.easypack24.net/v1/shipments/12345",
"id": 12345,
"status": "confirmed",
"tracking_number": "999106411340100000011272",
"return_tracking_number": null,
"service": "inpost_courier_alcohol",
"reference": "numer_zamówienia",
"is_return": false,
"application_id": 12,
"created_by_id": 12,
"external_customer_id": null,
"sending_method": null,
"end_of_week_collection": null,
"comments": "komentarz",
"mpk": null,
"additional_services": null,
"custom_attributes": {},
"cod": {
"amount": null,
"currency": null
},
"insurance": {
"amount": null,
"currency": null
},
"sender": {
"id": 123,
"name": null,
"company_name": "sender",
"first_name": "first_name",
"last_name": "last_name",
"email": "inpost@example.com",
"phone": "321321321",
"address": {
"id": 123,
"street": "Zawiła",
"building_number": "65 L",
"line1": null,
"line2": null,
"city": "Kraków",
"post_code": "30-390",
"country_code": "PL"
}
},
"receiver": {
"id": 123,
"name": "InPost",
"company_name": "InPost",
"first_name": "test",
"last_name": "test",
"email": "test@inpost.pl",
"phone": "885887738",
"address": {
"id": 123,
"street": "Czerniakowska",
"building_number": "87A",
"line1": null,
"line2": null,
"city": "Warszawa",
"post_code": "02-677",
"country_code": "PL"
}
},
"selected_offer": {
"id": 123,
"status": "bought",
"expires_at": null,
"rate": null,
"currency": null,
"additional_services": null,
"carrier": {
"id": "inpost_courier",
"name": "InPost Kurier",
"description": "InPost Express - Przesyłki kurierskie"
},
"service": {
"id": "inpost_courier_alcohol",
"name": "eSmartMIX",
"description": "Przesyłka kurierska eSmartMix z elektronicznym obiegiem dokumentów i potwierdzeniem danych odbiorcy"
},
"unavailability_reasons": null
},
"offers": [
{
"id": 123,
"status": "bought",
"expires_at": null,
"rate": null,
"currency": null,
"additional_services": null,
"carrier": {
"id": "inpost_courier",
"name": "InPost Kurier",
"description": "InPost Express - Przesyłki kurierskie"
},
"service": {
"id": "inpost_courier_alcohol",
"name": "eSmartMIX",
"description": "Przesyłka kurierska eSmartMix z elektronicznym obiegiem dokumentów i potwierdzeniem danych odbiorcy"
},
"unavailability_reasons": null
}
],
"transactions": [
{
"id": 123,
"status": "success",
"offer_id": 123,
"details": null,
"created_at": "2024-04-15T11:34:46.247+02:00",
"updated_at": "2024-04-15T11:34:46.247+02:00"
}
],
"parcels": [
{
"id": 712403579,
"identify_number": null,
"tracking_number": "999106411340100000011272",
"is_non_standard": false,
"template": null,
"dimensions": {
"length": 10.0,
"width": 10.0,
"height": 10.0,
"unit": "mm"
},
"weight": {
"amount": 10.0,
"unit": "kg"
}
}
],
"created_at": "2024-04-15T11:34:46.210+02:00",
"updated_at": "2024-04-15T11:34:46.262+02:00"
}
Error information
Errors that may occur during the creation of the shipment (the following errors are sent to the application that sent the request, not to the webhook):
"service": "unavailable" - The error will occur if the organization does not have an available service in its account.
"carrier": "carrier_inpost_courier_unavailable". - The error will occur if the organization does not have a courier service available.
company_data_missing - The error will occur if the organization does not have a signed contract for the eSmartMIX service.
"dimensions": "invalid" - An error will be returned if the dimensions are given incorrectly / exceed the allowed values.
"weight": "invalid". - An error will be returned if the maximum weight is exceeded
validation_failed - transmitted parameters are invalid. Details contained in the details field