Tworzenie przesyłki w trybie uproszczonym
Obiekt przesyłki wykorzystywany jest do uzyskania dostępnych ofert, a jednocześnie reprezentuje ona fizyczną paczkę (lub paczki), która będzie przesłana pomiędzy określonymi adresami.
Na tej stronie
- 1 Uwierzytelnianie
- 2 Tworzenie przesyłki w trybie uproszczonym
- 3 Przykładowe zapytania
- 3.1 Pojedyncza paczka dla przesyłki kurierskiej:
- 3.2 Zapytanie z wieloma paczkami (można tworzyć tylko dla inpost_courier)
- 3.3 Przesyłka kurierska - InPost Kurier C2C (usługa dla klienta detalicznego - prepaid)
- 3.4 Przesyłka kurierska Paleta Standard
- 3.5 Przesyłka Paczkomat® standard
- 3.6 Przesyłka Paczkomat® - Podaj Dalej
- 3.7 Przesyłka Allegro Paczkomat® 24/7 InPost
- 3.8 Przesyłka Allegro miniKurier24 InPost
- 3.9 Przesyłka Allegro Kurier24 InPost:
- 4 Informacje o błędach
Tworzenie przesyłki w trybie uproszczonym
Aby utworzyć przesyłkę w ramach określonej organizacji, użytkownik musi być jej członkiem.
Klienci debetowi
Po utworzeniu przesyłki nie zwracamy cen dla klientów debetowych. Atrybut rate
przyjmuje wartość null
Działanie asynchroniczne
Po utworzeniu przesyłki zostanie uruchomiony asynchroniczny proces przygotowywania ofert, manifestacji oraz kupienia oferty.
POST /v1/organizations/:organization_id/shipments
Parametry
Wszystkie poniższe parametry powinny być zawarte w obiekcie shipment
.
Parametr | Typ | Opis | Walidacja |
---|---|---|---|
| Receiver | Dane odbiorcy paczki | Atrybut jest wymagany.
|
| Sender | Dane nadawcy paczki. | Atrybut nie jest wymagany.
|
| Array[ParcelsSimple] | Dane paczek zawartych w przesyłce. | Atrybut jest wymagany.
|
| CustomAttributes | Dodatkowe atrybuty przesyłki, np.
| Atrybut nie jest wymagany.
|
| Cod | Wartość pobrania. | Atrybut nie jest wymagany.
|
| Insurance | Kwota ubezpieczenia przesyłki. | Atrybut jest wymagany dla poniższych serwisów:
|
| String | Dodatkowy opis przesyłki, np. numer zamówienia. | Atrybut nie jest wymagany.
|
| Bool | Określa przesyłkę jako zwrotną. | Atrybut nie jest wymagany.
|
| String | Wybrana przez klienta usługa. Dostępne wartości patrz Rozmiary i usługi dla przesyłek . | Atrybut jest wymagany. |
| Array[String] | Usługi dodatkowe. Dostępne usługi dodatkowe: | Atrybut nie jest wymagany.
|
| String | Identyfikator broker'a generującego przesyłki w ramach innej organizacji. | Atrybut nie jest wymagany. |
| Bool | Ustawienie parametru na | Atrybut nie jest wymagany. |
| String | Nazwa miejsca powstania kosztów. | Atrybut nie jest wymagany.
Miejsce powstania kosztów musi najpierw być dodane do organizacji, aby można je było przypisać do przesyłki, Miejsce powstania kosztów (MPK) |
| String | Dowolny komentarz | Atrybut nie jest wymagany
|
Przykładowe zapytania
Pojedyncza paczka dla przesyłki kurierskiej:
curl --location 'https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5c...' \
--header 'Content-Type: application/json' \
--data-raw '{
"sender": {
"company_name": "Company_name",
"first_name": "first_name",
"last_name": "last_name",
"email": "test@grupainteger.pl",
"phone": "321321321",
"address": {
"street": "Czerniakowska",
"building_number": "87A",
"city": "Warszawa",
"post_code": "00-718",
"country_code": "PL"
}
},
"receiver": {
"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"
}'
Odpowiedź
HTTP/1.1 201 CREATED
Content-Type: application/json
{
"href": "https://api-shipx-pl.easypack24.net/v1/shipments/1234",
"id": 1234,
"status": "created",
"tracking_number": null,
"return_tracking_number": null,
"service": "inpost_courier_standard",
"reference": "Test",
"is_return": false,
"application_id": 25,
"created_by_id": null,
"external_customer_id": null,
"sending_method": null,
"end_of_week_collection": false,
"comments": "dowolny komentarz",
"mpk": null,
"additional_services": [
"email",
"sms"
],
"custom_attributes": {},
"cod": {
"amount": 12.5,
"currency": "PLN"
},
"insurance": {
"amount": 25.0,
"currency": "PLN"
},
"sender": {
"id": 2798153592,
"name": null,
"company_name": "Company_name",
"first_name": "first_name",
"last_name": "last_name",
"email": "test@grupainteger.pl",
"phone": "321321321",
"address": {
"id": 1970664224,
"street": "Czerniakowska",
"building_number": "87A",
"line1": null,
"line2": null,
"city": "Warszawa",
"post_code": "00-718",
"country_code": "PL"
}
},
"receiver": {
"id": 2798153591,
"name": null,
"company_name": "Company name",
"first_name": "Jan",
"last_name": "Kowalski",
"email": "receiver@example.com",
"phone": "888000000",
"address": {
"id": 1970664223,
"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": 1404043193,
"identify_number": "small package",
"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"
}
}
],
"created_at": "2023-12-18T23:52:42.375+01:00",
"updated_at": "2023-12-18T23:52:42.375+01:00"
}
Zapytanie z wieloma paczkami (można tworzyć tylko dla inpost_courier)
Odpowiedź
Przesyłka kurierska - InPost Kurier C2C (usługa dla klienta detalicznego - prepaid)
Odpowiedź
Przesyłka kurierska Paleta Standard
Odpowiedź
Przesyłka Paczkomat® standard
Odpowiedź
Przesyłka Paczkomat® - Podaj Dalej
Odpowiedź
Przesyłka Allegro Paczkomat® 24/7 InPost
Odpowiedź
Przesyłka Allegro miniKurier24 InPost
Odpowiedź
Przesyłka Allegro Kurier24 InPost:
Odpowiedź