You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 6 Next »
Zasób Organization reprezentuje firmę, która posiada podpisaną umowę na świadczenie usług.
Organization
W ramach organizacji użytkownik ma możliwość zarządzania przesyłkami.
Na tej stronie
Dostęp do zasobu wymaga podania prawidłowego i aktualnego access tokenu.
Zasób Organization posiada następujące atrybuty:
Atrybut
Typ
Opis
id
integer
ID Organizacji
owner_id
ID Właściciela organizacji
name
string
Nazwa organizacji (nazwa firmy)
tax_id
NIP
created_at
datetime
Data utworzenia organizacji
updated_at
Data ostatniej aktualizacji organizacji
services
Array[String]
Lista dostępnych dla organizacji usług
bank_account_number
Numer konta bankowego organizacji
address
Address
Obiekt zawierający adres organizacji.
Struktura obiektu Address:
Identyfikator obiektu adres
line1
Ulica
line2
Numer budynku
street
building_number
city
Miasto
post_code
Kod pocztowy
country_code
Kod kraju (2-3 znaki)
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" } }
Lista wszystkich organizacji, do których użytkownik ma dostęp.
Zasób jest stronicowany. Więcej informacji na stronie [1.3.0] API Informacje ogólne
GET /v1/organizations
Sortowanie wyników
Parametr
sort_by
Określa atrybut po którym mają zostać posortowane wyniki.Domyślnie: idMożliwe:
sort_order
Określa rodzaj sortowania - w kolejności malejącej (desc) lub rosnącej (asc).Domyślnie: rosnąco (asc)
desc
asc
Przykład zapytania
$ curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations -H "Authorization: Bearer token" -H 'Content-Type: application/json'
Odpowiedź
{ "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 ... ] }
Pobieranie informacji o określonej organizacji, do której dostęp ma użytkownik.
GET /v1/organizations/:id
$ curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1 -H "Authorization: Bearer token" -H 'Content-Type: application/json'
HTTP/1.1 200 OK Content-Type: application/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 istnieje
resource_not_found
token_invalid - użytkownik nie ma praw dostępu do określonej organizacji
token_invalid
Lista statystyk danej organizacji.
GET /v1/organizations/:organization_id/statistics
Kryteria wyszukiwania
to_send
Zwraca liczbę przesyłek organizacji do wysyłki.
Statusy przesyłek: created, offers_prepared, offer_selected, confirmed
in_logistics
Zwraca liczbę przesyłek organizacji w procesie logistycznym.
Statusy przesyłek: dispatched_by_sender, collected_from_sender, taken_by_courier, adopted_at_source_branch, sent_from_source_branch, adopted_at_sorting_center, sent_from_sorting_center, adopted_at_target_branch, out_for_delivery, ready_to_pickup, pickup_reminder_sent, pickup_time_expired, avizo, claimed, returned_to_sender
delivered
Zwraca liczbę dostarczonych przesyłek organizacji.
Statusy przesyłek: delivered
curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1/statistics -H 'Authorization: Bearer token' -H 'Content-Type: application/json'
{ "to_send": 23, "in_logistics": 31, "delivered": 58 }