Uwierzytelnianie
Dostęp do zasobu wymaga podania prawidłowego i aktualnego access tokenu.
Pobieranie informacji o Organizacji
Pobieranie informacji o określonej organizacji, do której dostęp ma użytkownik:
GET /v1/organizations/:id
Zasób Organization
posiada następujące atrybuty:
Atrybut | Typ | Opis | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
href | string | Bezwzględny adres URL do zasobu | |||||||||||||||||||||||||||
id | integer | ID Organizacji | |||||||||||||||||||||||||||
owner_id | integer | ID Właściciela organizacji | |||||||||||||||||||||||||||
name | string | Nazwa organizacji (nazwa firmy) | |||||||||||||||||||||||||||
tax_id | string | NIP | |||||||||||||||||||||||||||
created_at | datetime | Data utworzenia organizacji | |||||||||||||||||||||||||||
updated_at | datetime | Data ostatniej aktualizacji organizacji | |||||||||||||||||||||||||||
services | Array[String] | Lista dostępnych dla organizacji usług | |||||||||||||||||||||||||||
bank_account_number | string | Numer konta bankowego organizacji | |||||||||||||||||||||||||||
address | Address | Obiekt zawierający adres organizacji. Struktura obiektu Address:
|
Przykład zasobu Organization
w formacie JSON:
{ "href": "https://api.shipx.pl.easypack24.net/v1/organizations/34", "id": 34, "owner_id": 1, "tax_id": "3973902075", "name": "Random org name39739020755741", "created_at": "2016-10-04T10:36:49.631+02:00", "updated_at": "2016-10-04T10:36:49.631+02:00", "services": [ "inpost_locker_standard", "inpost_courier_standard" ], "address": { "id": 808, "line1": null, "line2": null, "street": "Ulica jakaś39739020755741", "building_number": "Budynek39739020755741", "city": "Szczecin39739020755741", "post_code": "22-100", "country_code": "PL" } }
Informacje o błędach
Serwer może zwrócić następujące błędy
resource_not_found
- w przypadku gdy organizacja nie istniejetoken_invalid
- użytkownik nie ma praw dostępu do określonej organizacji
List all organizations
Lista wszystkich organizacji, do których użytkownik ma dostęp
GET /v1/organizations
Zasób jest stronicowany.
Parametry
Parametr | Opis |
---|---|
sort_by | Określa atrybut po którym mają zostać posortowane wyniki.
|
sort_order | Określa rodzaj sortowania - w kolejności malejącej (desc ) lub rosnącej (asc ).Domyślnie: rosnąco ( asc ) |
Przykład zapytania
$ curl https://api-shipx-pl.easypack24.net/v1/organizations -H "Authorization: Bearer lkfjasd9f70y43ohriw...[ommited for brevity]..."
Odpowiedź
W odpowiedzi serwer zwróci kolekcje z kodem odpowiedzi 200 OK:
{ "href": "https://api-shipx-pl.easypack24.net/v1/organizations", "count": 100, "page": 1, "per_page": 30, "items": [ { "href": "https://api-shipx-pl.easypack24.net/v1/organizations/1", "id": 1, ... other organization's attributes omitted for brevity ... }, ... other collection's items omitted for brevity ... ] }
Statystyki organizacji
Lista statystyk danej organizacji.
GET /v1/organizations/:organization_id/statistics
Przykład zapytania
GET /v1/organizations/1/statistics
Odpowiedź
W odpowiedzi serwer zwróci dane:
{ "to_send": 23, "in_logistics": 31, "delivered": 58 }
Parametry statystyk
Parametr | Opis |
---|---|
to_send |
|
in_logistics |
|
delivered |
|