Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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
Table of Contents |
---|
Tworzenie przesyłki w trybie ofertowym
Aby utworzyć przesyłkę w ramach określonej organizacji, użytkownik musi być jej członkiem.
Info |
---|
Po utworzeniu przesyłki nie zwracamy cen dla klientów debetowych. Atrybut |
Info |
---|
Po utworzeniu przesyłki zostanie uruchomiony asynchroniczny proces przygotowywania ofert, manifestacji oraz kupienia oferty. |
|
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: | 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ą:
|
Odpowiedź
|
Przykładowe zapytanie z wieloma paczkami (można tworzyć tylko dla inpost_courier):
|
Warning |
---|
Informacje o błędach Błędy, jakie mogą wystąpić podczas tworzenia przesyłki:
|
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:
|