The attributes are available as in the simplified mode: Creating a shipment in the simplified mode
Differences in attributesStructure
Shipment
resource for Allegro SMART has the same attributes as Shipment simplified mode. The only difference is in cod
parameter:
Parameter | Type | Description | Validation |
---|---|---|---|
cod | CodForm |
Cash collection amount. | The attribute is |
optional. |
Authentication
Resource access requires an active access token.
Allegro parcels
For allegro shipments there is no longer the requirement to send thebefore
Allegro parcels no longer require custom_attributes
to include allegro_transaction_id
and allegro_user_id
parameters in custom_attributes and it is sufficient to send a complete , sending a full masked allegro email , the is sufficient. The e-mail will be in the form of stałykodnadawcy+identyfikatortransakcji@have the following structure permanentsendercode
+transactionidenntifier@allegromail.com
, for example: 8awgqyk6a5+cub31c122@allegromail.com
.
Creating Allegro SMART
parcelsParcels with SMART services mayshipments
SMART shipments can be created only for an email from emails within the allegro domain:
When an email from the allegro domain is provided and the In case of the given email reaching the SMART limit, the service will be automatically changed to the equivalent service without _smart
.
In case an allegro domain email and inpost_locker_standard
or inpost_locker_allegro
service, or when the client email has a an available SMART limit for the given email, the service will be automatically changed change to its the equivalent with _smart
Below are the services to use for the available delivery methods:
Delivery method service.
Beneath you can see which services should be used for each delivery option:
1.) Delivery Option - Paczkomaty 24/7:
- without Allegro
- SMART -
- use
- inpost_locker_standard
- with Allegro
- SMART -
- use
- inpost_locker_standard
- (service will be changed to
inpost_locker_standard_smart
- if the email has available SMART limit).
2.) Delivery Option - Allegro Paczkomaty 24/7 InPost:without
- with Allegro
- Smart -
- use
- inpost_locker_allegro
- without Allegro
- Smart -
- use
- inpost_locker_allegro
- (service will be changed to
inpost_locker_allegro_smart
- if the email has available SMART limit)
Info | ||
---|---|---|
| ||
If an inappropriate In case the wrong service is provided specified for the delivery deliver 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 for Delivery Option - Allegro Paczkomaty 24/7 InPost
Code Block |
---|
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_smartallegro" } |
In response the server will return status 201
Code Block |
---|
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_standardallegro_smart", "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" } } ] } |