[1.9.0] Zlecenia odbioru

Transkrypt

1 [1.9.0] Zlecenia odbioru Zlecenia odbioru pozwalaj na zamówienie podjazdu kuriera w celu odebrania wczeniej przygotowanych przesyek. Kade zlecenie odbioru posiada status, który okrela jest stan. Obsugiwane statusy to: new - nowe zlecenie odbioru, które nie zostao jeszcze przekazane do realizacji, sent - zlecenie odbioru zostao przekazane do realizacji, ale nie jest jeszcze przyjte, accepted - zlecenie zostao przyjte do realizacji przez kuriera, done - zlecenie odbioru zostao zrealizowane, rejected - zlecenie odbioru zostao odrzucone przez kuriera, canceled - zlecenie zostao anulowane, Na tej stronie Uwierzytelnianie Tworzenie nowego zlecenia odbioru Pobieranie informacji o zleceniu odbioru Usuwanie zlecenia odbioru Lista zlece odbioru Przykadowe zapytanie Tworzenie komentarza do zlecenia odbioru Przykadowe zapytanie Aktualizacja komentarza do zlecenia odbioru Przykadowe zapytanie Usunicie komentarza do zlecenia odbioru Przykadowe zapytanie Zasób DispatchOrder posiada nastpujce atrybuty: Atrybut Typ Opis href string URI do zasobu. id string ID Zlecenia Odbioru. Tylko do odczytu. status string Status zlecenia odbioru. created_at Time Czas utworzenia zlecenia odbioru. address Object Adres, z które ma nastpi odbiór. shipments Array[Shipment] Tablica przesyek, których dotyczy zlecenie odbioru. Obiekt Shipment zawiera atrybuty: href - adres uri przesyki, id - id przesyki, tracking_number - numer trackingowy przesyki. comment string Opcjonalny komentarz do zlecenia odbioru Przykad zasobu DispatchOrder w formacie JSON:

2 "href": " "id": 1, "status": "sent", "address": "id": "123", "street": "Malborska", "building_number": "130", "post_code": "30-624", "city": "Kraków", "country_code": "PL",, "shipments": [ "href": " "id": 8, "tracking_number": " " "comments": [ "comment": "Some Test Comment", "created_at": " T11:37: :00" "created_at": " T11:37: :00", "updated_at": " T11:37: :00" Uwierzytelnianie Dostp do zasobu i jego metod wymaga podania aktualne i wanego access token. Uwaga! Klienci debetowi Po utworzeniu zlecenia odbioru, nie zwracamy cen dla klientów debetowych. Atrybut price przyjmuje warto null Tworzenie nowego zlecenia odbioru POST /v1/organizations/:org_id/dispatch_orders Parametry Parametr Typ Opis Walidacja dispatch_ point_id integer Identyfikator punktu odbioru, z którego przesyka ma by odebrana (adres punkty odbioru stanie si adresem zlecenia odbioru). Atrybut jest wymagany. shipments Array Lista ID przesyek, dla których ma zosta utworzone zlecenia odbioru. Atrybut jest wymagany. Paczki musz by w statusie confirmed i nie mog by przypisane do innego zlecenia odbioru w statusie new, sent, accepted lub done. Dodatkowo musza byc to paczki tego samego carriera. Nie ma moliwoci utworzenia jednego zlecenia odbioru dla przesyek allegro i innych. Przesyki mog by albo dla allegro, albo kade inne. Identyfikatory musz si mieci w zakresie typu Integer comment string Opcjonalny komentarz do zlecenia odbioru Atrybut nie jest wymagany do tworzenia zlecenia odbioru. Wymagalno pojawia si z chwil tworzenia komentarza do ju istniejcego zlecenia odbioru.

3 address Addre ssform Adres zlecenia odbioru Atrybut nie jest wymagany. Wymagalno pojawia si w momencie kiedy nie zostanie przekazany atrybut dispatch_point_id Przykad zapytania POST /v1/organizations/:org_id/dispatch_orders HTTP/1.1 "dispatch_point_id": 1, "shipments": ["1", "2" "comment": "Dowolny komentarz do zlecenia odbioru" Odpowied HTTP/ Created "href": " "id": 1, "status": "sent", "address": "id": "123", "street": "Malborska", "building_number": "130", "post_code": "30-624", "city": "Kraków", "country_code": "PL",, "shipments": [ "href": " "id": 8, "tracking_number": " " "comments": [ "comment": "Dowolny komentarz do zlecenia odbioru", "created_at": " T11:37: :00" "created_at": " T11:37: :00", "updated_at": " T11:37: :00" Zlecenie odbioru przesyek na adres Generowanie zlecenia na adres wymusza przekazanie adresu poprzez atrybut address System generuje sum kontroln z przekazanych informacji, naley zwróci uwag aby adres by dokadny i bez bdów (tzw. literówek) Na podstawie sumy kontrolnej system sprawdza, czy istnieje w bazie punkt odbioru o takim samym adresie, jeli nie istnieje, automatycznie generowany jest nowy punkt odbioru ( dotyczy wycznie przesyek paczkomatowych). Na nowo wygenerowany punkt odbioru ( DipstachPoint) realizowane jest zlecenie odbioru ( DispatchOrder). Bdy validation_failed - przesane dane s niepoprawne, np. podany punkt odbioru lub która z przesyek ma niepoprawny status invalid_range - podano nieprawidowy zakres identyfikatora przesyki, zakres nie mieci si w zakresie typu Integer dispatch_point_and_address_cannot_be_mixed - Nie mona jednoczenie nadawa zlecenia odbioru na adres oraz id punktu odbioru

4 Pobieranie informacji o zleceniu odbioru GET /v1/dispatch_orders/:order_id Przykad zapytania GET /v1/dispatch_orders/1 HTTP/1.1 Odpowied HTTP/ OK "href": " "id": 1, "status": "sent", "address": "id": "123", "street": "Malborska", "building_number": "130", "post_code": "30-624", "city": "Kraków", "country_code": "PL",, "shipments": [ "href": " "id": 8, "tracking_number": " " "comments": [ "comment": "Dowolny komentarz do zlecenia odbioru", "created_at": " T11:37: :00" "created_at": " T11:37: :00", "updated_at": " T11:37: :00" Bdy resource_not_found - w przypadku gdy zlecenie o podanym ID nie zostanie odnalezione, Usuwanie zlecenia odbioru Zlecenie odbioru mona usun jeli jest ono w statusie new lub sent. DELETE /v1/dispatch_orders/1 Przykad zapytania DELETE /v1/dispatch_orders/1 HTTP/1.1

5 Odpowied HTTP/ No Content Bdy resource_not_found - w przypadku gdy zlecenie o podanym ID nie zostanie odnalezione, invalid_status - w przypadku gdy zlecenie o podanym ID bdzie w statusie innym ni new lub sent, Lista zlece odbioru List zlece odbioru w ramach okrelonej organizacji mona pobra pod adresem: GET /v1/organizations/:organization_id/dispatch_orders Przykadowe zapytanie GET /v1/organizations/12345/dispatch_orders HTTP/1.1 W odpowiedzi na poprawnie przesane zapytanie, serwer zwróci odpowied z kodem HTTP 200 OK: HTTP/ OK "href": " "count": 15, "per_page": 30, "page": 1, "created_at": " T10:13: :00", "items": [ "href": " "id": 123,... other attribute omitted for brevity other items omitted for brevity... ] Tworzenie komentarza do zlecenia odbioru Tworzc zlecenie odbioru, umoliwiamy przekazanie opcjonalnego komentarza. Dodatkowo umoliwiamy dodawanie innych komentarzy do ju istniejcego zlecenia odbioru. POST /v1/organizations/:organization_id/dispatch_orders/:dispatch_order_id/comment Przykadowe zapytanie

6 POST /v1/organizations/:organization_id/dispatch_orders/:dispatch_order_id/comment HTTP/1.1 "comment": "Dodatkowy dowolny komentarz do zlecenia odbioru" W odpowiedzi na poprawnie przesane zapytanie, serwer zwróci odpowied z kodem HTTP 201 Created: HTTP/ Created "id": 37, "href": " "comment": "To jest jakis nastepny testowy komentarz", "created_at": " T10:32: :00" Aktualizacja komentarza do zlecenia odbioru Do istniejcego zlecenia odbioru, umoliwiamy przekazanie dodatkowych komentarzy. Dodatkowo umoliwiamy aktualizacje komentarza przynalenego do konkretnego zlecenia odbioru. PUT /v1/organizations/:organization_id/dispatch_orders/:dispatch_order_id/comment Przykadowe zapytanie PUT /v1/organizations/:organization_id/dispatch_orders/:dispatch_order_id/comment HTTP/1.1 "id": 37, "comment": "Aktualizacja komentarza" W odpowiedzi na poprawnie przesane zapytanie, serwer zwróci odpowied z kodem HTTP 201 Created: HTTP/ Created "id": 37, "href": " "comment": "Aktualizacja komentarza", "created_at": " T10:32: :00" Bdy jakie mog wystpi podczas pobierania listy zlece odbioru: resource_not_found - organizacja, dla której uytkownik chce pobra list zlece odbioru nie istnieje, forbidden - token nie uprawnia do do pobrania listy zlece odbioru dla wybranej organizacji. Usunicie komentarza do zlecenia odbioru

7 Do istniejcego zlecenia odbioru, umoliwiamy usunicie komentarza lub ich kolekcji. DELETE /v1/organizations/:organization_id/dispatch_orders/:dispatch_order_id/comment Przykadowe zapytanie DELETE /v1/organizations/:organization_id/dispatch_orders/:dispatch_order_id/comment HTTP/1.1 "comment_ids": [20,21] W odpowiedzi na poprawnie przesane zapytanie, serwer zwróci odpowied z kodem HTTP 200 Created:

8 HTTP/ Created "href": " "id": 2, "status": "sent", "external_id": , "price": null, "address": "id": 211, "street": "Malborska", "building_number": "130", "line1": null, "line2": null, "city": "Krakow", "post_code": "31-209", "country_code": "PL", "statuses": [ "shipments": [ "href": " "id": 103, "tracking_number": " " "comments": [ "id": 24, "comment": "Test 22", "created_at": " T11:34: :00", "id": 23, "comment": "Test 21", "created_at": " T11:34: :00", "id": 22, "comment": "Test 20", "created_at": " T11:34: :00" "created_at": " T09:19: :00", "updated_at": " T09:19: :00"