Page tree
Skip to end of metadata
Go to start of metadata

Warning!

Resource available only in the following countries: PL, IT

Tworzenie przesyłek przez klientów Brokerów w obrębie Organizacji(Brokera) dokonywane jest za pomocą pola external_customer_id w momencie tworzenia przesyłki 

Shipment creation for Broker clients within an organisation(Broker) is available through external_customer_id attribute during shipment creation



On this page

 

Authentication

Access to the resource requires a valid access token.




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.

POST /v1/organizations/:organization_id/shipments 

Example request

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"
}'



Brokers shipment list

GET /v1/organizations/:organization_id/shipments?external_customer_id=34123

Example request

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'



  • No labels