The attributes are available as in the simplified mode: Creating a shipment in the simplified mode
Differences in attributes:
Parameter | Type | Description | Validation |
---|---|---|---|
cod | CodForm | Collection amount. | The attribute is not required. |
Previous allegro parcels
For allegro shipments there is no longer the requirement to send the allegro_transaction_id and allegro_user_id parameters in custom_attributes and it is sufficient to send a complete masked allegro email, the e-mail will be in the form of stałykodnadawcy+identyfikatortransakcji@allegromail.com
, for example 8awgqyk6a5+cub31c122@allegromail.com
.
Creating SMART parcels
Parcels with SMART services may be created only for an email from the allegro domain:
When an email from the allegro domain is provided and the inpost_locker_standard or inpost_locker_allegro service, or when the client has a SMART limit for the given email, the service will be automatically changed to its equivalent with _smart
Below are the services to use for the available delivery methods:
Delivery method - Paczkomaty 24/7:
without Allegro Smart - we use the inpost_locker_standard service
with Allegro Smart - we use the inpost_locker_standard service, the service will be changed to inpost_locker_standard_smart when the customer is entitled to a SMART limit for a given email
Delivery method - Allegro Paczkomaty 24/7 InPost:
without Allegro Smart - we use the inpost_locker_allegro service
with Allegro Smart - we use the inpost_locker_allegro service, the service will be changed to inpost_locker_allegro_smart when the customer is entitled to a SMART limit for a given email
Attention! Wrong service for the delivery method
If an inappropriate service is provided for the delivery method (e.g. the inpost_locker_standard service for the Allegro Paczkomaty 24/7 method), the SMART service will not be available.
Sample inquiries are available on the website Creating a shipment in the simplified mode
Sample request to create a parcel
POST /v1/organizations/123/shipments HTTP/1.1 Host: api-shipx-pl.easypack24.net Content-Type: application/json Authorization: Bearer lkfjasd9f70y43ohriw...[ommited for brevity]... { "comments": "dowolny komentarz", "receiver": { "first_name": "Jan", "last_name": "Kowalski", "name": "Nazwa", "email": "jinfq3pjv+4c5547c60@user.allegrogroup.pl", "phone": "888000000", "address": { "id": "123", "street": "Malborska", "building_number": "130", "city": "Kraków", "post_code": "30-624", "country_code": "PL" } }, "parcels": [ { "template": "medium" } ], "custom_attributes": { "target_point": "BBI01A" }, "service": "inpost_locker_standard_smart" }
In response the server will return status 201
HTTP/1.1 201 CREATED Content-Type: application/json { "href": "https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments/1234567890", "id": "1234567890", "status": "created", "tracking_number": null, "service": "inpost_locker_standard", "reference": null, "is_return": false, "application_id": 1, "created_by_id": null, "external_customer_id": null, "sending_method": null, "mpk": null, "comments": "dowolny komentarz", "additional_services": [], "custom_attributes": { "target_point": "BBI01A" }, "cod": { "amount": null, "currency": null }, "insurance": { "amount": null, "currency": null }, "sender": { "id": 2860, "name": null, "company_name": "Inittec Sp. z o.o. (API Tests)", "first_name": "Robert", "last_name": "Dzikowski", "email": "rdzikowski@grupainteger.pl", "phone": "121323123", "address": { "id": 2824, "street": "Zawiła", "building_number": "65 L", "line1": null, "line2": null, "city": "Kraków", "post_code": "30-390", "country_code": "PL" } }, "receiver": { "id": 2859, "name": "Nazwa", "company_name": null, "first_name": "Jan", "last_name": "Kowalski", "email": "jinfq3pjv+4c5547c60@user.allegrogroup.pl", "phone": "888000000", "address": { "id": 2823, "street": "Malborska", "building_number": "130", "line1": null, "line2": null, "city": "Kraków", "post_code": "30-624", "country_code": "PL" } }, "selected_offer": null, "offers": [], "transactions": [], "parcels": [ { "id": 1494, "tracking_number": null, "is_non_standard": false, "template": "medium", "dimensions": { "length": 380.0, "width": 640.0, "height": 190.0, "unit": "mm" }, "weight": { "amount": 25.0, "unit": "kg" } } ] }