Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Info |
---|
Warning! Resource available only in the following countries: PL, IT |
On this page
Table of Contents |
---|
Shipment creation in simplified mode
Info |
---|
In order to create a shipment within an organization the user has to be its member. |
Note |
---|
Warning! Debit clients! After creating a shipment we do not return prices for debit clients. The |
Note |
---|
Warning! Asynchronous action. After creating a shipment an asynchronous offer, manifestation and offer purchase process will be started. |
Code Block |
---|
POST /v1/organizations/:organization_id/shipments |
Parameters
All the following attributes should be included in the shipment
object.
Parameter | Type | Description | Validation | Availability |
---|---|---|---|---|
| Receiver | Receiver details | The attribute is required.
| PL, IT |
| Sender | Sender details. | The attribute is optional.
| PL, IT |
| Array[ParcelsSimple] | Details of parcels in the shipment. | The attribute is required.
| PL, IT |
| CustomAttributes | Additional shipment attributes, e.g.
| The attribute is optional.
| PL, IT |
| Cod | Cash collection amount. | The attribute is optional.
| PL |
| Insurance | Shipment insurance amount. | The attribute is optional.
| PL, IT |
| String | Additional shipment description, e.g. order number. | The attribute is optional.
| PL, IT |
| Bool | Determines whether the shipment is a return shipment. | The attribute is optional.
| PL, IT |
| String | Selected service. Available services: [1.23.0] Shipment sizes and services | The attribute is required. | PL, IT |
| Array[String] | Additional services. Available additional services: | The attribute is optional.
| PL, IT |
| String | ID of the broker generating shipments within a different organization. | The attribute is optional. | PL, IT |
| Bool | Setting the parameter to | The attribute is optional.
| PL, IT |
| String | Name of cost center. | The attribute is optional.
The cost center must first be added to the organization in order to assign it to the shipment. | PL, IT |
| String | Any comment | The attribute is optional.
| PL, IT |
Example requests
Single parcel for courier delivery
Code Block | ||
---|---|---|
| ||
curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{ "receiver": { "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "receiver@example.com", "phone": "888000000", "address": { "street": "Cybernetyki", "building_number": "10", "city": "Warszawa", "post_code": "02-677", "country_code": "PL" } }, "parcels": [ { "id": "small package", "dimensions": { "length": "80", "width": "360", "height": "640", "unit": "mm" }, "weight": { "amount": "25", "unit": "kg" }, "is_non_standard": false } ], "insurance": { "amount": 25, "currency": "PLN" }, "cod": { "amount": 12.50, "currency": "PLN" }, "service": "inpost_courier_standard", "additional_services": ["email", "sms"], "reference": "Test", "comments": "dowolny komentarz", "external_customer_id": "8877xxx", "mpk": "Nazwa miejsca powstania kosztów" }' |
Response
Code Block | ||
---|---|---|
| ||
HTTP/1.1 201 CREATED Content-Type: application/json { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/1", "id": 1234567890, "status": "created", "tracking_number": null, "service": "inpost_courier_standard", "reference": "Test", "is_return": false, "application_id": 123, "created_by_id": null, "external_customer_id": "8877xxx", "sending_method": null, "mpk": { "id": 1, "name": "Nazwa miejsca powstania kosztów" }, "comments": "dowolny komentarz", "additional_services": [ "email", "sms" ], "custom_attributes": {}, "cod": { "amount": 12.5, "currency": "PLN" }, "insurance": { "amount": 25.0, "currency": "PLN" }, "sender": { "id": "123", "name": "Nazwa", "company_name": "InPost S.A.", "first_name": "Jan", "last_name": "Nowak", "email": "sender@email.com", "phone": "888000000", "address": { "id": "123", "street": "Malborska", "building_number": "130", "line1": null, "line2": null "city": "Kraków", "post_code": "30-624", "country_code": "PL" } }, "receiver": { "id": 123, "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "receiver@example.com", "phone": "888000000", "address": { "id": 123, "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": 123, "tracking_number": null, "is_non_standard": false, "template": null, "dimensions": { "length": 80.0, "width": 360.0, "height": 640.0, "unit": "mm" }, "weight": { "amount": 25.0, "unit": "kg" } } ], "end_of_week_collection": false, "created_at": "2020-02-23T18:07:08.967+01:00", "updated_at": "2020-02-23T18:07:08.967+01:00" } |
Single parcel shipment and courier service on IT instance
Code Block | ||
---|---|---|
| ||
curl -X POST https:///api-shipx-it.easypack24.net/v1/organizations/1/shipments -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{ "service": "inpost_locker_standard", "custom_attributes": { "target_point": "AG018" }, "parcels":{ "template": "small" }, "receiver": { "company_name": "Roma", "email": "test2@test2.it", "phone": "00393666195247", "address": { "line1": "Roma-s", "city": "Roma", "post_code": "00171", "country_code": "IT" } } |
Response
Code Block | ||
---|---|---|
| ||
HTTP/1.1 201 CREATED Content-Type: application/json { "href": "http://api-shipx-it.easypack24.net/v1/shipments/107", "id": 107, "status": "created", "tracking_number": null, "service": "inpost_locker_standard", "reference": null, "is_return": false, "application_id": 11, "created_by_id": null, "external_customer_id": null, "sending_method": null, "end_of_week_collection": false, "comments": null, "mpk": null, "additional_services": [], "custom_attributes": { "target_point": "AG018" }, "insurance": { "amount": null, "currency": null }, "sender": { "id": 214, "name": null, "company_name": "Lipsky1", "first_name": "Karol", "last_name": "Lipa 1", "email": "k@inpost.pl", "phone": "00393666195247", "address": { "id": 228, "street": "Street", "building_number": "12", "line1": null, "line2": null, "city": "Roma", "post_code": "00171", "country_code": "IT" } }, "receiver": { "id": 213, "name": null, "company_name": "Roma", "first_name": null, "last_name": null, "email": "test2@test2.it", "phone": "00393666195247", "address": { "id": 227, "street": null, "building_number": null, "line1": "Roma-s", "line2": null, "city": "Roma", "post_code": "00171", "country_code": "IT" } }, "selected_offer": null, "offers": [], "transactions": [], "parcels": [ { "id": 107, "tracking_number": null, "is_non_standard": false, "template": "small", "dimensions": { "length": 380.0, "width": 640.0, "height": 80.0, "unit": "mm" }, "weight": { "amount": 25.0, "unit": "kg" } } ], "created_at": "2021-04-29T14:07:58.493+02:00", "updated_at": "2021-04-29T14:07:58.493+02:00" } |
Query with multiple packages (can only be created for inpost_courier)
Code Block | ||
---|---|---|
| ||
curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{ "receiver": { "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "receiver@example.com", "phone": "888000000", "address": { "street": "Cybernetyki", "building_number": "10", "city": "Warszawa", "post_code": "02-677", "country_code": "PL" } }, "parcels": [ { "id": "small package", "dimensions": { "length": "80", "width": "360", "height": "640", "unit": "mm" }, "weight": { "amount": "25", "unit": "kg" }, "is_non_standard": true }, { "id": "big package", "dimensions": { "length": "80", "width": "360", "height": "640", "unit": "mm" }, "weight": { "amount": "25", "unit": "kg" }, "is_non_standard": true } ], "insurance": { "amount": 25, "currency": "PLN" }, "cod": { "amount": 12.50, "currency": "PLN" }, "service": "inpost_courier_standard", "additional_services": ["email", "sms"], "reference": "Test", "comments": "dowolny komentarz", "external_customer_id": "8877xxx", "mpk": "Nazwa miejsca powstania kosztów" }' |
Response
Code Block | ||
---|---|---|
| ||
HTTP/1.1 201 CREATED Content-Type: application/json { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/1234567890", "id": 1234567890, "status": "created", "tracking_number": null, "service": "inpost_courier_standard", "reference": "Test", "is_return": false, "application_id": 123, "created_by_id": null, "external_customer_id": "8877xxx", "sending_method": null, "mpk": { "id": 1, "name": "Nazwa miejsca powstania kosztów" }, "comments": "dowolny komentarz", "additional_services": [ "email", "sms" ], "custom_attributes": {}, "cod": { "amount": 12.5, "currency": "PLN" }, "insurance": { "amount": 25.0, "currency": "PLN" }, "sender": { "id": "123", "name": "Nazwa", "company_name": "InPost S.A.", "first_name": "Jan", "last_name": "Nowak", "email": "sender@email.com", "phone": "888000000", "address": { "id": "123", "street": "Malborska", "building_number": "130", "line1": null, "line2": null "city": "Kraków", "post_code": "30-624", "country_code": "PL" } }, "receiver": { "id": 123, "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "receiver@example.com", "phone": "888000000", "address": { "id": 509576837, "street": "Cybernetyki", "building_number": "10", "line1": null, "line2": null, "city": "Warszawa", "post_code": "02-677", "country_code": "PL" } }, "selected_offer": null, "offers": [], "transactions": [], "parcels": [ { "id": 123, "tracking_number": null, "is_non_standard": true, "template": null, "dimensions": { "length": 80.0, "width": 360.0, "height": 640.0, "unit": "mm" }, "weight": { "amount": 25.0, "unit": "kg" } }, { "id": 123, "tracking_number": null, "is_non_standard": true, "template": null, "dimensions": { "length": 80.0, "width": 360.0, "height": 640.0, "unit": "mm" }, "weight": { "amount": 25.0, "unit": "kg" } } ], "end_of_week_collection": false, "created_at": "2020-02-23T18:22:57.378+01:00", "updated_at": "2020-02-23T18:22:57.378+01:00" } |
Courier service - InPost Courier C2C (service for retail customer - prepaid)
Code Block | ||
---|---|---|
| ||
curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{ "receiver": { "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "receiver@example.com", "phone": "888000000", "address": { "street": "Cybernetyki", "building_number": "10", "city": "Warszawa", "post_code": "02-677", "country_code": "PL" } }, "parcels": { "template": "small" }, "insurance": { "amount": 25, "currency": "PLN" }, "cod": { "amount": 12.50, "currency": "PLN" }, "custom_attributes": { "sending_method": "parcel_locker", "dropoff_point": "KRA012" }, "service": "inpost_courier_c2c", "reference": "Test" } |
Response
Code Block | ||
---|---|---|
| ||
HTTP/1.1 201 CREATED Content-Type: application/json { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/123", "id": 123, "status": "created", "tracking_number": null, "service": "inpost_courier_c2c", "reference": "Test", "is_return": false, "application_id": 25, "created_by_id": null, "external_customer_id": null, "sending_method": "parcel_locker", "end_of_week_collection": false, "comments": null, "mpk": null, "additional_services": [], "custom_attributes": { "dropoff_point": "KRA012", "sending_method": "parcel_locker" }, "cod": { "amount": 12.5, "currency": "PLN" }, "insurance": { "amount": 25.0, "currency": "PLN" }, "sender": { "id": "123", "name": "Nazwa", "company_name": "InPost S.A.", "first_name": "Jan", "last_name": "Nowak", "email": "sender@email.com", "phone": "888000000", "address": { "id": "123", "street": "Malborska", "building_number": "130", "line1": null, "line2": null "city": "Kraków", "post_code": "30-624", "country_code": "PL" } }, "receiver": { "id": 123, "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "receiver@example.com", "phone": "888000000", "address": { "id": 123, "street": "Cybernetyki", "building_number": "10", "line1": null, "line2": null, "city": "Warszawa", "post_code": "02-677", "country_code": "PL" } }, "selected_offer": null, "offers": [], "transactions": [], "parcels": [ { "id": 123, "tracking_number": null, "is_non_standard": false, "template": "small", "dimensions": { "length": 380.0, "width": 640.0, "height": 80.0, "unit": "mm" }, "weight": { "amount": 25.0, "unit": "kg" } } ], "created_at": "2021-12-13T12:32:57.987+01:00", "updated_at": "2021-12-13T12:32:57.987+01:00" } |
Courier service Standard pallet
Code Block | ||
---|---|---|
| ||
curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{ { "receiver": { "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "receiver@example.com", "phone": "888000000", "address": { "street": "Cybernetyki", "building_number": "10", "city": "Warszawa", "post_code": "02-677", "country_code": "PL" } }, "parcels": { "dimensions": { "length": "800", "width": "800", "height": "800", "unit": "mm" }, "weight": { "amount": "50", "unit": "kg" } }, "service": "inpost_courier_palette", "additional_services": ["email", "sms"], "reference": "Test", "comments": "dowolny komentarz", "external_customer_id": "8877xxx", "mpk": "Nazwa miejsca powstania kosztów" } |
Response
Code Block | ||
---|---|---|
| ||
HTTP/1.1 201 CREATED Content-Type: application/json { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/123", "id": 123, "status": "created", "tracking_number": null, "service": "inpost_courier_palette", "reference": "Test", "is_return": false, "application_id": 25, "created_by_id": null, "external_customer_id": "8877xxx", "sending_method": null, "end_of_week_collection": false, "comments": "dowolny komentarz", "mpk": { "id": 1, "name": "Nazwa miejsca powstania kosztów" }, "additional_services": [ "email", "sms" ], "custom_attributes": {}, "cod": { "amount": null, "currency": null }, "insurance": { "amount": null, "currency": null }, "sender": { "id": "123", "name": "Nazwa", "company_name": "InPost S.A.", "first_name": "Jan", "last_name": "Nowak", "email": "sender@email.com", "phone": "888000000", "address": { "id": "123", "street": "Malborska", "building_number": "130", "line1": null, "line2": null "city": "Kraków", "post_code": "30-624", "country_code": "PL" } }, "receiver": { "id": 123, "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "receiver@example.com", "phone": "888000000", "address": { "id": 123, "street": "Cybernetyki", "building_number": "10", "line1": null, "line2": null, "city": "Warszawa", "post_code": "02-677", "country_code": "PL" } }, "selected_offer": null, "offers": [], "transactions": [], "parcels": [ { "id": 123, "tracking_number": null, "is_non_standard": false, "template": null, "dimensions": { "length": 800.0, "width": 800.0, "height": 800.0, "unit": "mm" }, "weight": { "amount": 50.0, "unit": "kg" } } ], "created_at": "2021-12-13T12:42:29.071+01:00", "updated_at": "2021-12-13T12:42:29.071+01:00" } |
Parcel locker standard
Code Block | ||
---|---|---|
| ||
curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{ "receiver": { "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "test@inpost.pl", "phone": "111222333" }, "parcels": { "template": "small" }, "insurance": { "amount": 25, "currency": "PLN" }, "cod": { "amount": 12.50, "currency": "PLN" }, "custom_attributes": { "sending_method": "dispatch_order", "target_point": "KRA012" }, "service": "inpost_locker_standard", "reference": "Test", "external_customer_id": "8877xxx" }' |
Response
Code Block | ||
---|---|---|
| ||
HTTP/1.1 201 CREATED Content-Type: application/json { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/1234567890", "id": 1234567890, "status": "created", "tracking_number": null, "service": "inpost_locker_standard", "reference": "Test", "is_return": false, "application_id": 123, "created_by_id": null, "external_customer_id": "8877xxx", "sending_method": "dispatch_order", "mpk": null, "comments": null, "additional_services": [], "custom_attributes": { "sending_method": "dispatch_order", "target_point": "KRA012" }, "cod": { "amount": 12.5, "currency": "PLN" }, "insurance": { "amount": 25.0, "currency": "PLN" }, "sender": { "id": "123", "name": "Nazwa", "company_name": "InPost S.A.", "first_name": "Jan", "last_name": "Nowak", "email": "sender@email.com", "phone": "888000000", "address": { "id": "123", "street": "Malborska", "building_number": "130", "line1": null, "line2": null "city": "Kraków", "post_code": "30-624", "country_code": "PL" } }, "receiver": { "id": 123, "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "test@inpost.pl", "phone": "111222333", "address": null }, "selected_offer": null, "offers": [], "transactions": [], "parcels": [ { "id": 123, "tracking_number": null, "is_non_standard": false, "template": "small", "dimensions": { "length": 380.0, "width": 640.0, "height": 80.0, "unit": "mm" }, "weight": { "amount": 25.0, "unit": "kg" } } ], "end_of_week_collection": false, "created_at": "2020-02-23T18:17:40.073+01:00", "updated_at": "2020-02-23T18:17:40.073+01:00" } |
Parcel locker - Pass-Thru
Code Block | ||
---|---|---|
| ||
curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{ "receiver": { "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "test@inpost.pl", "phone": "111222333" }, "parcels": { "template": "large" }, "insurance": { "amount": 25, "currency": "PLN" }, "cod": { "amount": 12.50, "currency": "PLN" }, "custom_attributes": { "sending_method": "parcel_locker", "target_point": "KRA012", "dropoff_point":"KRA012" }, "service": "inpost_locker_pass_thru", "reference": "Test", "external_customer_id": "8877xxx" } |
Response
Code Block | ||
---|---|---|
| ||
HTTP/1.1 201 CREATED Content-Type: application/json { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/123", "id": 123, "status": "created", "tracking_number": null, "service": "inpost_locker_pass_thru", "reference": "Test", "is_return": false, "application_id": 25, "created_by_id": null, "external_customer_id": "8877xxx", "sending_method": "parcel_locker", "end_of_week_collection": false, "comments": null, "mpk": null, "additional_services": [], "custom_attributes": { "target_point": "KRA012", "dropoff_point": "KRA012", "sending_method": "parcel_locker" }, "cod": { "amount": 12.5, "currency": "PLN" }, "insurance": { "amount": 25.0, "currency": "PLN" }, "sender": { "id": 123, "name": null, "company_name": "ShpiX MM", "first_name": "Michał", "last_name": "Machowski", "email": "mmachowski@grupainteger.pl", "phone": "885887738", "address": { "id": 1011558443, "street": null, "building_number": null, "line1": "test", "line2": null, "city": "test", "post_code": "02-677", "country_code": "PL" } }, "receiver": { "id": 123, "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "test@inpost.pl", "phone": "111222333", "address": null }, "selected_offer": null, "offers": [], "transactions": [], "parcels": [ { "id": 123, "tracking_number": null, "is_non_standard": false, "template": "large", "dimensions": { "length": 380.0, "width": 640.0, "height": 410.0, "unit": "mm" }, "weight": { "amount": 25.0, "unit": "kg" } } ], "created_at": "2021-12-13T12:49:48.159+01:00", "updated_at": "2021-12-13T12:49:48.159+01:00" } |
Shipment Allegro
Paczkomaty24Paczkomat® 24/7 InPost
Code Block | ||
---|---|---|
| ||
curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{ "receiver": { "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "123abc+123abc@user.allegrogroup.pl", "phone": "111222333" }, "parcels": { "template": "small" }, "custom_attributes": { "target_point": "KRA012", "sending_method": "dispatch_order" }, "service": "inpost_locker_allegro" }' |
Response
Code Block | ||
---|---|---|
| ||
HTTP/1.1 201 CREATED Content-Type: application/json { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/1234567890", "id": 1234567890, "status": "created", "tracking_number": null, "service": "inpost_locker_allegro", "reference": null, "is_return": false, "application_id": 123, "created_by_id": null, "external_customer_id": null, "sending_method": "dispatch_order", "mpk": null, "comments": null, "additional_services": [], "custom_attributes": { "sending_method": "dispatch_order", "target_point": "KRA012" }, "cod": { "amount": null, "currency": null }, "insurance": { "amount": 5000, "currency": "PLN" }, "sender": { "id": "123", "name": "Nazwa", "company_name": "InPost S.A.", "first_name": "Jan", "last_name": "Nowak", "email": "sender@email.com", "phone": "888000000", "address": { "id": "123", "street": "Malborska", "building_number": "130", "line1": null, "line2": null "city": "Kraków", "post_code": "30-624", "country_code": "PL" } }, "receiver": { "id": 123, "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "123abc+123abc@user.allegrogroup.pl", "phone": "111222333", "address": null }, "selected_offer": null, "offers": [], "transactions": [], "parcels": [ { "id": 123, "tracking_number": null, "is_non_standard": false, "template": "small", "dimensions": { "length": 380.0, "width": 640.0, "height": 80.0, "unit": "mm" }, "weight": { "amount": 10.0, "unit": "kg" } } ], "end_of_week_collection": false, "created_at": "2020-02-23T18:52:25.100+01:00", "updated_at": "2020-02-23T18:52:25.100+01:00" } |
Shipment Allegro miniKurier24 InPost
Code Block | ||
---|---|---|
| ||
curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{ "receiver": { "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "123abc+123abc@user.allegrogroup.pl", "phone": "888000000", "address": { "street": "Cybernetyki", "building_number": "10", "city": "Warszawa", "post_code": "02-677", "country_code": "PL" } }, "parcels": { "template": "letter_a" }, "custom_attributes": { "sending_method": "dispatch_order" }, "service": "inpost_letter_allegro" }' |
Response
Code Block | ||
---|---|---|
| ||
HTTP/1.1 201 CREATED Content-Type: application/json { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/1234567890", "id": 1234567890 "status": "created", "tracking_number": null, "service": "inpost_letter_allegro", "reference": null, "is_return": false, "application_id": 123, "created_by_id": null, "external_customer_id": null, "sending_method": "dispatch_order", "mpk": null, "comments": null, "additional_services": [], "custom_attributes": { "sending_method": "dispatch_order" }, "cod": { "amount": null, "currency": null }, "insurance": { "amount": 5000, "currency": "PLN" }, "sender": { "id": "123", "name": "Nazwa", "company_name": "InPost S.A.", "first_name": "Jan", "last_name": "Nowak", "email": "sender@email.com", "phone": "888000000", "address": { "id": "123", "street": "Malborska", "building_number": "130", "line1": null, "line2": null "city": "Kraków", "post_code": "30-624", "country_code": "PL" } }, "receiver": { "id": 123, "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "123abc+123abc@user.allegrogroup.pl", "phone": "888000000", "address": { "id": 123, "street": "Cybernetyki", "building_number": "10", "line1": null, "line2": null, "city": "Warszawa", "post_code": "02-677", "country_code": "PL" } }, "selected_offer": null, "offers": [], "transactions": [], "parcels": [ { "id": 123, "tracking_number": null, "is_non_standard": false, "template": "letter_a", "dimensions": { "length": 380.0, "width": 640.0, "height": 80.0, "unit": "mm" }, "weight": { "amount": 10.0, "unit": "kg" } } ], "end_of_week_collection": false, "created_at": "2020-02-23T19:24:51.120+01:00", "updated_at": "2020-02-23T19:24:51.120+01:00" } |
Shipment Allegro Kurier24 InPost
Code Block | ||
---|---|---|
| ||
curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{ "receiver": { "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "gtcc1rh559+4fe361dc5@user.allegrogroup.pl", "phone": "888000000", "address": { "street": "Cybernetyki", "building_number": "10", "city": "Warszawa", "post_code": "02-677", "country_code": "PL" } }, "parcels": { "dimensions": { "length": "10", "width": "10", "height": "10", "unit": "mm" }, "weight": { "amount": "10", "unit": "kg" } }, "cod": { "amount": 12.50, "currency": "PLN" }, "custom_attributes": { "sending_method": "dispatch_order" }, "service": "inpost_courier_allegro" }' |
Response
Code Block | ||
---|---|---|
| ||
HTTP/1.1 201 CREATED Content-Type: application/json { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/1234567890", "id": 1234567890, "status": "created", "tracking_number": null, "service": "inpost_courier_allegro", "reference": null, "is_return": false, "application_id": 123, "created_by_id": null, "external_customer_id": null, "sending_method": "dispatch_order", "mpk": null, "comments": null, "additional_services": [], "custom_attributes": { "sending_method": "dispatch_order" }, "cod": { "amount": 12.5, "currency": "PLN" }, "insurance": { "amount": 5000, "currency": "PLN" }, "sender": { "id": "123", "name": "Nazwa", "company_name": "InPost S.A.", "first_name": "Jan", "last_name": "Nowak", "email": "sender@email.com", "phone": "888000000", "address": { "id": "123", "street": "Malborska", "building_number": "130", "line1": null, "line2": null "city": "Kraków", "post_code": "30-624", "country_code": "PL" } }, "receiver": { "id": 123, "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "123abc+123abc@user.allegrogroup.pl", "phone": "888000000", "address": { "id": 123, "street": "Cybernetyki", "building_number": "10", "line1": null, "line2": null, "city": "Warszawa", "post_code": "02-677", "country_code": "PL" } }, "selected_offer": null, "offers": [], "transactions": [], "parcels": [ { "id": 123, "tracking_number": null, "is_non_standard": false, "template": null, "dimensions": { "length": 10.0, "width": 10.0, "height": 10.0, "unit": "mm" }, "weight": { "amount": 10.0, "unit": "kg" } } ], "end_of_week_collection": false, "created_at": "2020-02-23T19:09:25.712+01:00", "updated_at": "2020-02-23T19:09:25.712+01:00" } |
Warning |
---|
Error informationErrors that may appear when creating a shipment (the following errors are returned as a response to the shipment creation request, not via webhooks):
|