Tworzenie przesyłki w trybie ofertowym
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.
Tworzenie przesyłki w trybie ofertowym
Aby utworzyć przesyłkę w ramach określonej organizacji, użytkownik musi być jej członkiem.
Po utworzeniu przesyłki nie zwracamy cen dla klientów debetowych. Atrybut rate przyjmuje wartość null
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 |
|---|---|---|---|
| Dane odbiorcy paczki. | Atrybut jest wymagany.
| |
| Dane nadawcy paczki. | Atrybut nie jest wymagany.
| |
| Array[ParcelsSimpleForm] | Dane paczek zawartych w przesyłce. | Atrybut jest wymagany.
|
| Dodatkowe atrybuty przesyłki. | Atrybut nie jest wymagany.
| |
| Wartość pobrania. | Atrybut nie jest wymagany.
| |
| 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.
|
| Array[String] | Usługi dodatkowe. Dostępne usługi dodatkowe: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/11731062 | Atrybut nie jest wymagany.
|
| String | Identyfikator broker'a generującego przesyłki w ramach innej organizacji | Atrybut nie jest wymagany. |
|
| 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. |
| String | Dowolny komentarz | Atrybut nie jest wymagany.
|
Przykładowe zapytanie
Przykładowe zapytanie z jedną paczką:
curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{
"mpk":"miejsce_powstania_kosztow",
"comments": "dowolny komentarz",
"external_customer_id": "8877xxx",
"receiver": {
"first_name": "Jan",
"last_name": "Kowalski",
"name": "Nazwa",
"email": "receiver@example.com",
"phone": "888000000",
"address": {
"id": "123",
"street": "Malborska",
"building_number": "130",
"city": "Kraków",
"post_code": "30-624",
"country_code": "PL"
}
},
"parcels": [
{
"id": "small package",
"template": "small",
"dimensions": {
"length": "80",
"width": "360",
"height": "640",
"unit": "mm"
},
"weight": {
"amount": "25",
"unit": "kg"
},
"tracking_number": null,
"is_non_standard": false
}
],
"custom_attributes": {
"target_point": "KRA010"
},
"insurance": {
"amount": 25,
"currency": "PLN"
},
"cod": {
"amount": 12.50,
"currency": "PLN"
},
"additional_services": ["email", "sms"]
}' |
Odpowiedź
HTTP/1.1 201 CREATED
Content-Type: application/json
{
"href": "https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments/1234567890",
"id": "1234567890",
"status": "created",
"parcels": [
{
"id": "small package",
"template": "small",
"dimensions": {
"length": "80",
"width": "360",
"height": "640",
"unit": "mm"
},
"weight": {
"amount": "25",
"unit": "kg"
},
"tracking_number": null,
"is_non_standard": false
}
],
"external_customer_id": "8877xxx",
"mpk": {
"id": 1,
"name": "miejsce_powstania_kosztow"
},
"comments": "dowolny komentarz",
"custom_attributes": {
"target_point": "KRA010",
"open_code": null,
"dropoff_point": null,
"sending_method": "parcel_locker"
},
"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,
"city": "Kraków",
"post_code": "30-624",
"country_code": "PL"
}
},
"receiver": {
"id": "1234",
"name": "Nazwa",
"company_name": null,
"first_name": "Jan",
"last_name": "Kowalski",
"email": "sender@email.com",
"phone": "888000000",
"address": null
},
"created_at": "2015-09-06T19:21:00.000+02:00",
"created_by_id": 3,
"cod_amount": {
"amount": 12.50,
"currency": "PLN"
},
"insurance": {
"amount": 25,
"currency": "PLN"
},
"additional_services": ["email", "sms"],
"reference": "Order No. 12345",
"is_return": false,
"tracking_number": null,
"offers": [],
"selected_offer": null,
"transactions": [],
"mpk": {
"id": 1,
"name": "Nazwa miejsca powstania kosztów."
}
} |
Przykładowe zapytanie z wieloma paczkami (można tworzyć tylko dla inpost_courier):
Informacje o błędach
Błędy, jakie mogą wystąpić podczas tworzenia przesyłki:
validation_failed- przesyłane parametry są niepoprawne. Szczegóły zawarte w poludetails,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.
Asynchroniczne przygotowanie ofert
Po utworzeniu przesyłki zostanie uruchomiony asynchroniczny proces przygotowywania ofert. Przygotowane oferty ważne są przez 5 minut. Po tym czasie oferty zmienią swój status na expired i nie będzie możliwy ich zakup. Aby przygotować nowe oferty, należy wysłać żądanie edycji przesyłki nie podając żadnych danych.
Aby otrzymać informację o zakończeniu przygotowywania ofert dla przesyłki, należy zdefiniować w konfiguracji organizacji adres url, pod który mają być wysyłane informacje dla zdarzenia offers_prepared. Dzięki temu aplikacja ShipX wyśle na podany adres następujące informacje: