Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Info |
|---|
Warning! |
The resource is available only in the following countries: PL, IT. |
The creation of shipments by Broker customers within an Organisation (Broker) is done using the external_customer_id field at the time of shipment creation.
On this page
| Table of Contents |
|---|
Shipment creation by a Broker
To create a Broker's shipment, it is sufficient to specify the Broker client's data (email, phone, address details) in the sender's data (sender field) and specify the Broker's client ID from the Broker's internal system in the external_customer_id field. The created shipment will have the Broker client's data on the shipping label, but the payment will be collected from the Broker's account.
| Code Block | ||
|---|---|---|
| ||
POST /v1/organizations/:organization_id/shipments |
Example request
| Code Block | ||
|---|---|---|
| ||
curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/batches -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{
"external_customer_id": "6531",
"sender":
{
"email": "kowal@example.com",
"phone": "111222111",
"first_name": "Adrian",
"last_name": "Kowalski",
"address":{
"street":"Ulica",
"building_number":"2",
"city":"Szczecin",
"post_code":"22-100",
"country_code":"PL"
}
},
"receiver":
{
"email": "receiverrro39901172490841@example.com",
"phone": "399011724",
"first_name": "John",
"last_name": "Wayne",
"address":{
"street":"Ulica",
"building_number":"2",
"city":"Łódź",
"post_code":"25-140",
"country_code":"PL"
}
},
"parcels": { "template": "medium" },
"service": "inpost_courier_standard"
}' |
List of Broker Shipments
| Code Block | ||
|---|---|---|
| ||
GET /v1/organizations/:organization_id/shipments?external_customer_id=34123 |
Example request
| Code Block | ||
|---|---|---|
| ||
curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments?external_customer_id=34123 -H 'Authorization: Bearer token' -H 'Content-Type: application/json' |