Uwierzytelnianie
Dostęp do zasobu wymaga podania aktualnego i ważnego access token.
Struktura
Zasób DispatchPoint
posiada następujące atrybuty:
Atrybut | Typ | Opis | Poprawne wartości |
---|---|---|---|
href | string | Adres URI do zasobu | |
id | integer | ID punktu odbioru | |
name | string | Nazwa punktu odbioru | |
office_hours | string | Godziny funkcjonowania punktu | |
phone | string | Numer telefonu do punktu | |
email | string | Adres e-mail punktu | |
comments | string | Dodatkowe informacje | |
address | Object | Adres | |
status | String | Status | created , activated , suspended
|
Przykład zasobu DispatchPoint
w formacie JSON:
{ "href": "https://api-shipx-pl.easypack24.net/v1/dispatch_points/1", "id": 1, "name": "My dispatch point", "office_hours": "8-16", "phone": "777888999", "email": null, "comments": null, "status": "created", "address": { "id": 230, "street": "Długa", "building_number": "24", "city": "Krakow", "post_code": "30-624", "country_code": "PL" } }
Pobieranie informacji o punkcie
GET /v1/dispatch_points/:id
Przykład zapytania
GET /v1/dispatch_points/1 HTTP/1.1 Host: api-shipx-pl.easypack24.net Content-Type: application/json Authorization: Bearer lkfjasd9f70y43ohriw...[ommited for brevity]...
Odpowiedź
HTTP/1.1 200 OK Content-Type: application/json { "href": "https://test.api.shipx.pl.easypack24.net/v1/dispatch_points/1", "id": 1, "name": "My dispatch point", "office_hours": "8-16", "phone": "777888999", "email": null, "comments": null, "status": "created", "address": { "id": 230, "street": "Długa", "building_number": "24", "city": "Krakow", "post_code": "30-624", "country_code": "PL" } }
Błedy:
resource_not_found
- punkt odbioru o podanym ID nie istnieje,
Lista punktów odbioru
Listę punktów odbioru w ramach określonej organizacji można pobrać pod adresem:
GET /v1/organizations/:organization_id/dispatch_points
Uprawnienia
Aby pobrać listę punktów odbioru dla określonej organizacji użytkownik musi być jej członkiem.
Przykładowe zapytanie
GET /v1/organizations/12345/dispatch_points HTTP/1.1 Host: api-shipx-pl.easypack24.net Content-Type: application/json Authorization: Bearer lkfjasd9f70y43ohriw...[ommited for brevity]...
W odpowiedzi na poprawnie przesłane zapytanie, serwer zwróci odpowiedź z kodem HTTP 200 OK:
HTTP/1.1 200 OK Content-Type: application/json { "href": "https://api-shipx-pl.easypack24.net/v1/organizations/1/dispatch_points", "count": 15, "per_page": 30, "page": 1, "items": [ { "href": "https://api-shipx-pl.easypack24.net/v1/dispatch_points/3", "id": 123, ... other attribute omitted for brevity .... } ... other items omitted for brevity ... ] }
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 do pobrania listy zleceń odbioru dla wybranej organizacji.