Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Zasób Organization
reprezentuje firmę, która posiada podpisaną umowę na świadczenie usług z określonymi spółkami (InPost S.A., InPost Paczkomaty Sp. z o.o. lub InPost Express Sp. z o.o.) w ramach Grupy Kapitałowej Integer.
Organizacja jest tworzona na podstawie podpisanej umowy, przez wyznaczone osoby po stronie Grupy Kapitałowej Integer. Zmian w organizacji może dokonywać jedynie pracownik GK Integer.
W ramach organizacji użytkownik ma możliwość zarządzania przesyłkami.
Na tej stronie
Table of Contents |
---|
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:
Code Block |
---|
GET /v1/organizations/:id |
Organization
posiada Struktura
Zasób Organization
posiada następujące atrybuty:
Atrybut | Typ | Opis |
---|
href
| integer | ID Organizacji |
| integer | ID Właściciela organizacji |
| string | Nazwa organizacji (nazwa firmy) |
| string | NIP |
| datetime | Data utworzenia organizacji |
| datetime | Data ostatniej aktualizacji organizacji |
| Array[String] | Lista dostępnych dla organizacji usług |
| string | Numer konta bankowego organizacji |
| Address | Obiekt zawierający adres organizacji. |
Struktura obiektu Address
:
Atrybut | Typ | Opis |
---|---|---|
| string | Identyfikator obiektu adres |
| string | Ulica |
| string | Numer budynku |
| string | Ulica |
| string | Numer budynku |
| string | Miasto |
| string | Kod pocztowy |
| string | Kod kraju (2-3 znaki) |
Przykład zasobu Organization
w formacie JSON:
|
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 organizacji
Lista wszystkich organizacji, do których użytkownik ma dostęp.
Info |
---|
Zasób jest stronicowany. Więcej informacji na stronie [1.3.0] API Informacje ogólne |
|
Zasób jest stronicowany.
Sortowanie wyników
Parametr | Opis |
---|---|
| Określa atrybut po którym mają zostać posortowane wyniki.
|
| Określa rodzaj sortowania - w kolejności malejącej ( |
Przykład zapytania
|
Odpowiedź
W odpowiedzi serwer zwróci kolekcje z kodem odpowiedzi 200 OK:
code
|
Odpowiedź
|
Szczegóły organizacji
Pobieranie informacji o określonej organizacji, do której dostęp ma użytkownik.
|
|
Przykład zapytania
|
|
Odpowiedź
W odpowiedzi serwer zwróci dane:
Code Block |
---|
{
"to_send": 23,
"in_logistics": 31,
"delivered": 58
} |
Parametry statystyk
|
Warning |
---|
Informacje o błędach Serwer może zwrócić następujące błędy
|
Statystyki organizacji
Lista statystyk danej organizacji.
|
Kryteria wyszukiwania
Parametr | Opis |
---|---|
|
|
|
|
|
|
Przykład zapytania
|
Odpowiedź
|