Page tree
Skip to end of metadata
Go to start of metadata

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

 

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:

AtrybutTypOpis
hrefstringBezwzględny adres URL do zasobu
idintegerID Organizacji
owner_idintegerID Właściciela organizacji
namestringNazwa organizacji (nazwa firmy)
tax_idstringNIP
created_atdatetimeData utworzenia organizacji
updated_atdatetimeData ostatniej aktualizacji organizacji
servicesArray[String]Lista dostępnych dla organizacji usług
bank_account_number
stringNumer konta bankowego organizacji
addressAddress

Obiekt zawierający adres organizacji. Struktura obiektu Address:

AtrybutTypOpis
idstringIdentyfikator obiektu adres
line1
stringUlica
line2
stringNumer budynku
streetstringUlica
building_numberstringNumer budynku
city
stringMiasto
post_code
stringKod pocztowy
country_code
stringKod 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"
  }
}

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

List all organizations

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

GET /v1/organizations


(info) Zasób jest stronicowany. 

Parametry

ParametrOpis
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_orderOkreś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

ParametrOpis
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
  • No labels