Page Comparison

...

Code Block
POST /v1/organizations/:organization_id/shipments

Uprawnienia

Aby utworzyć przesyłkę w ramach określonej organizacji, użytkownik musi być jej członkiem.

Parametry

Wszystkie poniższe parametry powinny być zawarte w obiekcie shipment.

...

Dane odbiorcy paczki

...

Atrybut jest wymagany.

jeśli ma być przedstawiona oferta usługi kurierskiej (łącznie z inpost_courier_c2c), należy podać co najmniej receiver.company_name i/lub receiver.first_name i receiver.last_name oraz obiekt address
jeśli ma być przedstawiona oferta paczkomatowa należy podać receiver.phone_number i receiver.email
podanie wszystkich danych umożliwi przedstawienie ofert obu typów
jeśli zostanie przekazany atrybut is_return == true, atrybut receiver nie będzie wymagany

...

Atrybut nie jest wymagany.

Jeśli nie zostaną podane żadne dane, domyślnie zostaną użyte dane organizacji, w ramach której tworzona jest przesyłka.

...

Dane paczek zawartych w przesyłce.

...

Atrybut jest wymagany.

Kolekcja minimum 1, maksimum 1000

...

Dodatkowe atrybuty przesyłki, np.

"custom_attributes": {
"target_point": "KRA010"
}

...

Atrybut nie jest wymagany.

Lista dodatkowych atrybutów została opisana we wstępie.
Wymagane jest podanie paczkomatu w przypadku przesyłki paczkomatowej.

...

Atrybut nie jest wymagany.

Walidacja oraz wymagalność przekazania atrybutu występuje w momencie przekazania parametru.

...

Atrybut nie jest wymagany.

Walidacja oraz wymagalność przekazania atrybutu występuje w momencie przekazania parametru.

...

Atrybut nie jest wymagany.

Minimum 3 znaki, maksimum 100 znaków, możliwość przekazania pustego atrybutu.

...

Atrybut nie jest wymagany.

Dopuszczalne wartości (true, false)
Możliwość przekazania pustego atrybutu.
Jeśli ustawione na true, określa przesyłkę jako zwrotną. W takiej sytuacji dane nadawcy i odbiorcy zostaną automatycznie zamienione miejscami.

...

Wybrana przez klienta usługa.

Dostępne wartości patrz API X Rozmiary i usługi dla przesyłek

Atrybut jest wymagany.

...

Usługi dodatkowe.

Dostępne usługi dodatkowe: sms, email, saturday.

API X Rozmiary i usługi dla przesyłek

...

Atrybut nie jest wymagany.

Atrybut walidowany w momencie przekazania wartości.
Przekazując atrybut additional_services system sprawdza przekazanie atrybutu service, jeśli atrybut service nie zostanie przekazany lub przekazany atrybut additional_services nie mieści się w zakresie przekazanego serwisu, użytkownik otrzyma błąd.

...

external_customer_id

...

Atrybut nie jest wymagany.

...

Atrybut nie jest wymagany.

maksymalnie 255 znaków
jeśli atrybut jest podany, weryfikujemy czy przynależy do organizacji, z której wykonywane jest żądanie
możliwość przekazania pustego atrybutu

Miejsce powstania kosztów musi najpierw być dodane do organizacji, aby można je było przypisać do przesyłki.

...

Atrybut nie jest wymagany

maksymalnie 100 znaków
możliwość przekazania pustego atrybutu

Info

title	Uwaga! Klienci debetowi

Po utworzeniu przesyłki, nie zwracamy cen dla klientów debetowych.

Atrybut rate przyjmuje wartość null

Przykładowe zapytania

Przykładowe zapytanie dla przesyłki kurierskiej

...

Tworzenie przesyłki w trybie uproszczonym

Aby utworzyć przesyłkę w ramach określonej organizacji, użytkownik musi być jej członkiem.

Info

title	Uwaga! Klienci debetowi

Po utworzeniu przesyłki, nie zwracamy cen dla klientów debetowych. Atrybut rate przyjmuje wartość null

Info

title	Uwaga! Działanie asynchroniczne.

Po utworzeniu przesyłki zostanie uruchomiony asynchroniczny proces przygotowywania ofert, manifestacji oraz kupienia oferty.

Code Block
POST /v1/organizations/:organization_id/shipments

Parametry

Wszystkie poniższe parametry powinny być zawarte w obiekcie shipment.

Parametr	Typ	Opis	Walidacja
`receiver`	Receiver	Dane odbiorcy paczki	Atrybut jest wymagany. jeśli ma być przedstawiona oferta usługi kurierskiej (łącznie z `inpost_courier_c2c`), należy podać co najmniej `receiver.company_name` i/lub `receiver.first_name` i `receiver.last_name` oraz obiekt `address` jeśli ma być przedstawiona oferta paczkomatowa należy podać `receiver.phone_number` i `receiver.email` podanie wszystkich danych umożliwi przedstawienie ofert obu typów jeśli zostanie przekazany atrybut `is_return == true`, atrybut `receiver` nie będzie wymagany
`sender`	Sender	Dane nadawcy paczki.	Atrybut nie jest wymagany. Jeśli nie zostaną podane żadne dane, domyślnie zostaną użyte dane organizacji, w ramach której tworzona jest przesyłka.
`parcels`	Array[ParcelsSimple]	Dane paczek zawartych w przesyłce.	Atrybut jest wymagany. Kolekcja minimum 1, maksimum 1000
`custom_attributes`	CustomAttributes	Dodatkowe atrybuty przesyłki, np. `"custom_attributes": {` `"target_point": "KRA010"` `}`	Atrybut nie jest wymagany. Lista dodatkowych atrybutów została opisana we wstępie. Wymagane jest podanie paczkomatu w przypadku przesyłki paczkomatowej.
`cod`	Cod	Wartość pobrania.	Atrybut nie jest wymagany. Walidacja oraz wymagalność przekazania atrybutu występuje w momencie przekazania serwisu.
`insurance`	Insurance	Kwota ubezpieczenia przesyłki.	Atrybut nie jest wymagany. Walidacja oraz wymagalność przekazania atrybutu występuje w momencie przekazania serwisu.
`reference`	String	Dodatkowy opis przesyłki, np. numer zamówienia.	Atrybut nie jest wymagany. Minimum 3 znaki, maksimum 100 znaków, możliwość przekazania pustego atrybutu.
`is_return`	Bool	Określa przesyłkę jako zwrotną.	Atrybut nie jest wymagany. Dopuszczalne wartości (`true, false`) Możliwość przekazania pustego atrybutu. Jeśli ustawione na `true`, określa przesyłkę jako zwrotną. W takiej sytuacji dane nadawcy i odbiorcy zostaną automatycznie zamienione miejscami.
`service`	String	Wybrana przez klienta usługa. Dostępne wartości patrz Rozmiary i usługi dla przesyłek.	Atrybut jest wymagany.
`additional_services`	Array[String]	Usługi dodatkowe. Dostępne usługi dodatkowe: `sms`, `email`, `saturday`. Rozmiary i usługi dla przesyłek.	Atrybut nie jest wymagany. Atrybut walidowany w momencie przekazania wartości. Przekazując atrybut `additional_services` system sprawdza przekazanie atrybutu `service`, jeśli atrybut `service` nie zostanie przekazany lub przekazany atrybut `additional_services` nie mieści się w zakresie przekazanego serwisu, użytkownik otrzyma błąd.
`external_customer_id`	String	Identyfikator broker'a generującego przesyłki w ramach innej organizacji.	Atrybut nie jest wymagany.
`only_choice_of_offer`	Bool	Ustawienie parametru na `true` powoduje że oferta zostanie wybrana dla podanego serwisu, ale nie zostanie automatycznie opłacona. Taka przesyłkę trzeba opłacić przed końcem wygaśnięcia oferty wykonując operacje (Opłacanie przesyłki)	Atrybut nie jest wymagany.
`mpk`	String	Nazwa miejsca powstania kosztów.	Atrybut nie jest wymagany. maksymalnie 255 znaków jeśli atrybut jest podany, weryfikujemy czy przynależy do organizacji, z której wykonywane jest żądanie możliwość przekazania pustego atrybutu Miejsce powstania kosztów musi najpierw być dodane do organizacji, aby można je było przypisać do przesyłki.
`comments`	String	Dowolny komentarz	Atrybut nie jest wymagany maksymalnie 100 znaków możliwość przekazania pustego atrybutu

Przykładowe zapytania

Przykładowe zapytanie z pojedynczą paczką dla przesyłki kurierskiej:

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

...

W odpowiedzi serwer zwróci status 201 wraz z obiektem nowo utworzonej przesyłki.

Odpowiedź

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

Przykładowe zapytanie z wieloma paczkami (

...

można tworzyć tylko

...

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

...

Odpowiedź

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

Przykładowe zapytanie tworzenia przesyłki paczkomatowej standardowej

...

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

...

Odpowiedz

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

Przykładowe

...

zapytanie

...

dla

...

przesyłki

...

Allegro

...

Paczkomaty24/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"
}

...

Odpowiedz

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

Przykładowe

...

zapytanie

...

dla

...

przesyłki

...

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

...

Odpowiedz

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

Przykładowe

...

zapytanie

...

dla

...

przesyłki

...

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

...

Odpowiedz

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

Info

title	Uwaga! Działanie asynchroniczne.

Po utworzeniu przesyłki zostanie uruchomiony asynchroniczny proces przygotowywania ofert, manifestacji oraz kupienia oferty.

...

Informacje o błędach

Błędy, jakie mogą wystąpić podczas tworzenia przesyłki (poniższe błędy są wysyłane do aplikacji która wysłała żądanie, nie na webhook):

validation_failed - przesyłane parametry są niepoprawne. Szczegóły zawarte w polu details,
resource_not_found - w przypadku gdy użytkownik próbuje utworzyć przesyłkę dla organizacji, która nie istnieje lub nie ma uprawnień do jej utworzenia,
no_carriers - w przypadku gdy organizacja nie ma podpisanej umowy z żadnym przewoźnikiem,
carrier_unavailable - w przypadku gdy organizacja nie ma podpisanej umowy z przewoźnikiem świadczącym wybraną usługę wskazaną w atrybucie service

...

Tworzenie rozmiaru przesyłki w trybie uproszczonym, na podtsawie przekazywanych parametrów

Na temat rozmiarów można przczytać w osobnym dokumencie

Aplikacja umożiwia wygenerowanie przesyłki z rozmiarem, bez podawania jego nazwy. Rozmiar generowany jest na podstawie przekazywanych parametrów,

poniżej został umieszczony przykład:

Code Block
"parcels": { "dimensions": { "length": "120", "width": "34", "height": "81", "unit": "mm" }, "weight": { "amount": "20", "unit": "kg" } }

Znalezienie odpowiedniego rozmiaru przesyłki, bez podawania jego nazwy, uwarunkowane jest przekazaniem wszystkich parametrów obiektów dimensions oraz weight

Poniższa tabela przedstawia warunki jakie należy spełnić, aby umożliwić wygenerowanie rozmiaru na podstawie przekazywanych parametrów.

...

inpost_letter_allegro

inpost_letter_ecommerce

...

lenght: 1 - 380

width: 1 - 640

height: 1 - 80

weight: 1 - 10

...

inpost_locker_standard

inpost_locker_allegro

inpost_locker_pass_thru

...

lenght: 1 - 380

width: 1 - 640

height: 1 - 80 (mniejsze lub równe 80)

weight: 0 - 25

...

inpost_locker_standard

inpost_locker_allegro

inpost_locker_pass_thru

...

lenght: 1 - 380

width: 1 - 640

height: 81 - 190 (mniejsze lub równe 190)

weight: 0 - 25

...

inpost_locker_standard

inpost_locker_allegro

inpost_locker_pass_thru

...

lenght: 1 - 380

width: 1 - 640

height: 191 - 410 (mniejsze lub równe 410)

weight: 0 - 25

...

lenght: 1 - 1800

width: 1 - 800

height: 1 - 1200

weight: 50 - 800

...

inpost_courier_standard

inpost_courier_express_1700

...

lenght: 1 - 2400

width: 1 - 2400

height: 411 - 3500 (mniejsze lub równe 3500)

weight: 0 - 50

...

lenght: 1 - 2400

width: 1 - 2400

height: 411 - 3500 (mniejsze lub równe 3500)

...

Versions Compared

Old Version 7

New Version 8

Key

Uprawnienia

Parametry

Przykładowe zapytania

Uwierzytelnianie

Tworzenie przesyłki w trybie uproszczonym

Przykładowe zapytania

Przykładowe zapytanie z pojedynczą paczką dla przesyłki kurierskiej:

Przykładowe zapytanie z wieloma paczkami (

można tworzyć tylko

dla inpost_courier):

Przykładowe zapytanie tworzenia przesyłki paczkomatowej standardowej

Code Block
curl -X POST https:/

Przykładowe

zapytanie

dla

przesyłki

Allegro

Paczkomaty24/7

InPost

Przykładowe

zapytanie

dla

przesyłki

Allegro

miniKurier24

InPost

:

Przykładowe

zapytanie

dla

przesyłki

Allegro

Kurier24

InPost:

Informacje o błędach

Page Comparison

Versions Compared

Old Version 7

New Version 8

Key

Uprawnienia

Parametry

Przykładowe zapytania

Uwierzytelnianie

Tworzenie przesyłki w trybie uproszczonym

Przykładowe zapytania

Przykładowe zapytanie z pojedynczą paczką dla przesyłki kurierskiej:

Przykładowe zapytanie z wieloma paczkami (

można tworzyć tylko

dla inpost_courier):

Przykładowe zapytanie tworzenia przesyłki paczkomatowej standardowej

Code Blockcurl -X POST https:/

Przykładowe

zapytanie

dla

przesyłki

Allegro

Paczkomaty24/7

InPost

Przykładowe

zapytanie

dla

przesyłki

Allegro

miniKurier24

InPost

:

Przykładowe

zapytanie

dla

przesyłki

Allegro

Kurier24

InPost:

Informacje o błędach

Code Block
curl -X POST https:/