[1.6.0] Organizacje

Zasób Organization reprezentuje firmę, która posiada podpisaną umowę na świadczenie usług.

W ramach organizacji użytkownik ma możliwość zarządzania przesyłkami.

Uwierzytelnianie

Dostęp do zasobu wymaga podania prawidłowego i aktualnego access tokenu.

 

Struktura

Zasób Organization posiada następujące atrybuty:

Atrybut

Typ

Opis

Atrybut

Typ

Opis

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:

Atrybut

Typ

Opis

Atrybut

Typ

Opis

id

string

Identyfikator obiektu adres

line1

string

Ulica

line2

string

Numer budynku

street

string

Ulica

building_number

string

Numer budynku

city

string

Miasto

post_code

string

Kod pocztowy

country_code

string

Kod kraju (2-3 znaki)

Przykład zasobu Organization w formacie JSON:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 { "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 organizacji

Lista wszystkich organizacji, do których użytkownik ma dostęp.

Zasób jest stronicowany. Więcej informacji na stronie https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/11731055

1 GET /v1/organizations

Sortowanie wyników

Parametr

Opis

Parametr

Opis

sort_by

Określa atrybut po którym mają zostać posortowane wyniki.
Domyślnie: id
Możliwe:

  • id

  • name

  • tax_id

  • address

  • created_at 

sort_order

Określa rodzaj sortowania - w kolejności malejącej (desc) lub rosnącej (asc).
Domyślnie: rosnąco (asc)

Przykład zapytania

1 $ curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations -H "Authorization: Bearer token" -H 'Content-Type: application/json'

Odpowiedź

1 2 3 4 5 6 7 8 9 10 11 12 13 14 { "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 ... ] }

 

Szczegóły organizacji

Pobieranie informacji o określonej organizacji, do której dostęp ma użytkownik.

1 GET /v1/organizations/:id

Przykład zapytania

1 $ curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1 -H "Authorization: Bearer token" -H 'Content-Type: application/json'

Odpowiedź

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 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

  • token_invalid - użytkownik nie ma praw dostępu do określonej organizacji


 

Statystyki organizacji

Lista statystyk danej organizacji.

1 GET /v1/organizations/:organization_id/statistics

Kryteria wyszukiwania

Parametr

Opis

Parametr

Opis

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

Przykład zapytania

1 curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1/statistics -H 'Authorization: Bearer token' -H 'Content-Type: application/json'

Odpowiedź

1 2 3 4 5 { "to_send": 23, "in_logistics": 31, "delivered": 58 }