Zlecenia odbioru pozwalają na zamówienie podjazdu kuriera w celu odebrania wcześniej przygotowanych przesyłek.
Każde zlecenie odbioru posiada status, który określa jego stan. Obsługiwane statusy to:
new
- nowe zlecenie odbioru, które nie zostało jeszcze przekazane do realizacji,
sent
- zlecenie odbioru zostało przekazane do realizacji, ale nie jest jeszcze przyjęte,
|
Zasób DispatchOrder
posiada następujące atrybuty:
Atrybut | Typ | Opis |
---|---|---|
| String | ID Zlecenia Odbioru. Tylko do odczytu. |
| String | Status zlecenia odbioru. |
| DateTime | Czas utworzenia zlecenia odbioru. |
| Address | Adres, z którego ma nastąpić odbiór. |
| Array[Shipment] | Tablica przesyłek, których dotyczy zlecenie odbioru. Obiekt
|
| String | Opcjonalny komentarz do zlecenia odbioru |
Przykład zasobu DispatchOrder
w formacie JSON:
{ "href": "https://api-shipx-pl.easypack24.net/v1/dispatch_orders/1", "id": 1, "status": "sent", "address": { "id": "123", "street": "Malborska", "building_number": "130", "post_code": "30-624", "city": "Kraków", "country_code": "PL", }, "shipments": [ { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/8", "id": 8, "tracking_number": "622111081631876319900026" } ], "comments": [ { "24", "comment": "Some Test Comment", "created_at": "2018-02-14T11:37:07.852+01:00" } ], "created_at": "2018-02-14T11:37:07.843+01:00", "updated_at": "2018-02-14T11:37:08.340+01:00" } |
Generowanie zlecenia na adres wymusza przekazanie adresu poprzez atrybut address
System generuje sumę kontrolną z przekazanych informacji, należy zwrócić uwagę, aby adres był dokładny i bez błędów (tzw. literówek)
Na podstawie sumy kontrolnej system sprawdza, czy istnieje w bazie punkt odbioru o takim samym adresie, jeśli nie istnieje, automatycznie generowany jest nowy punkt odbioru (dotyczy wyłącznie przesyłek paczkomatowych).
Na nowo wygenerowany punkt odbioru (DipstachPoint
) realizowane jest zlecenie odbioru (DispatchOrder
).
Po utworzeniu zlecenia odbioru nie zwracamy cen dla klientów debetowych.
Atrybut price
przyjmuje wartość null
|
Parametry
Parametr | Typ | Opis | Walidacja |
---|---|---|---|
| Array | Lista ID przesyłek, dla których ma zostać utworzone zlecenia odbioru. | Atrybut jest wymagany.
|
| String | Opcjonalny komentarz do zlecenia odbioru | Atrybut nie jest wymagany do tworzenia zlecenia odbioru. Wymagalność pojawia się z chwilą tworzenia komentarza do już istniejącego zlecenia odbioru. |
| Address | Adres zlecenia odbioru | Atrybut jest wymagany. |
| String | Godziny funkcjonowania punktu | Atrybut nie jest wymagany. Określa godziny funkcjonowania punktu, jeżeli tworzymy zlecenie odbioru na adres. |
| String | Nazwa punktu. Wykorzystywana do stworzenia dispatch_point. | Atrybut jest wymagany. |
| String | Kontakt telefoniczny. Wykorzystywany do stworzenia dispatch_point. | Atrybut jest wymagany. |
| String | Kontakt mailowy. Wykorzystywany do stworzenia dispatch_point. | Atrybut nie jest wymagany. |
Przykład zapytania
|
Odpowiedź
|
Informacje o błędach
validation_failed
- przesłane dane są niepoprawne, np. podany punkt odbioru lub któraś z przesyłek ma niepoprawny status
invalid_range
- podano nieprawidłowy zakres identyfikatora przesyłki, zakres nie mieści się w zakresie typu Integer
dispatch_point_and_address_cannot_be_mixed
- Nie można jednocześnie nadawać zlecenia odbioru na adres oraz id punktu odbioru
Zlecenie odbioru można usunąć jeśli jest ono w statusie new
lub sent
.
|
Przykład zapytania
|
Odpowiedź
|
Informacje o błędach
resource_not_found
- w przypadku gdy zlecenie o podanym ID nie zostanie odnalezione,
invalid_status
- w przypadku gdy zlecenie o podanym ID będzie w statusie innym niż new
lub sent
Listę zleceń odbioru w ramach określonej organizacji można pobrać pod adresem:
|
Odpowiedź
|
Informacja o błędach
Błędy jakie mogą wystąpić podczas pobierania listy zleceń odbioru:
resource_not_found
- organizacja, dla której użytkownik chce pobrać listę zleceń odbioru nie istnieje
forbidden
- token nie uprawnia do pobrania listy zleceń odbioru dla wybranej organizacji
|
Przykład zapytania
|
Odpowiedź
|
Informacje o błędach
resource_not_found
- w przypadku gdy zlecenie o podanym ID nie zostanie odnalezione
Tworząc zlecenie odbioru, umożliwiamy przekazanie opcjonalnego komentarza.
Dodatkowo umożliwiamy dodawanie innych komentarzy do już istniejącego zlecenia odbioru.
|
Przykładowe zapytanie
|
Odpowiedź
|
Do istniejącego zlecenia odbioru, umożliwiamy przekazanie dodatkowych komentarzy.
Dodatkowo umożliwiamy aktualizacje komentarza przynależnego do konkretnego zlecenia odbioru.
|
Przykładowe zapytanie
|
Odpowiedź
|
Informacje o błędach
Błędy jakie mogą wystąpić podczas pobierania listy zleceń odbioru:
resource_not_found
- organizacja, dla której użytkownik chce pobrać listę zleceń odbioru nie istnieje
forbidden
- token nie uprawnia do pobrania listy zleceń odbioru dla wybranej organizacji
Do istniejącego zlecenia odbioru, umożliwiamy usunięcie komentarza lub ich kolekcji.
|
Przykładowe zapytanie
|
Odpowiedź
|