[1.2.5] Wyszukiwanie punktów odbioru

 

Lista punktów odbioru

Wyszukiwanie punktów odbioru odbywa się poprzez podanie jednego lub więcej z poniższych kryteriów

GET /v1/organizations/:organization_id/dispatch_points

Kryteria wyszukiwania

Parametr

Typ

Działanie

Przykład

Parametr

Typ

Działanie

Przykład

id

Integer

Array

Wyszukuje punkt odbioru o podanym id.

Wyszukuje punkty odbioru o podanych id.

?id=12

?id=12,17

name

String

Wyszukuje punkty odbioru, których nazwa zawiera wskazany ciąg.

?name=mag

email

String

Array

Wyszukuje punkty odbioru, których adres e-mail jest identyczny jak wskazany ciąg.

Wyszukuje punkty odbioru ze wskazanymi adresami e-mail.

?email=magazyn1@firma.com

?email=magazyn1@firma.com,magazyn2@firma.com

phone

String

Array

Wyszukuje punkty odbioru, których numer telefonu jest identyczny jak wskazany ciąg.

Wyszukuje punkty odbioru ze wskazanymi numerami telefonów.

?phone=123123123

?phone=123123123,1231231234

address

String

Wyszukuje punkty odbioru, w których adres (street) rozpoczyna się od wskazanego ciągu.

?address=Zaw

post_code

String

Wyszukuje punkty odbioru, w których kod pocztowy zaczyna się od wskazanego ciągu.

?post_code=30-442

country_code

String

Wyszukuje punkty odbioru, w których kod kraju jest identyczny jak wskazany ciąg.

?country_code=PL

city

String

Wyszukuje punkty odbioru, w których miejscowość jest identyczna jak wskazany ciąg.

?city=Kraków

Sortowanie wyników

Wyniki wyszukiwania można sortować przekazując parametr sort_by, który może przyjmować przyjmować następujące wartości:

Wartość sort_by

Działanie

Przykład

Wartość sort_by

Działanie

Przykład

id

Sortuje punkty odbioru po identyfikatorze

?sort_by=id

name

Sortuje punkty odbioru po nazwie

?sort_by=name

email

Sortuje punkty odbioru po adresie e-mail.

?sort_by=email

phone

Sortuje punkty odbioru po numerze telefonu.

?sort_by=phone

address

Sortuje punkty odbioru po pierwszej linii adresu

?sort_by=address

post_code

Sortuje punkty odbioru po kodzie pocztowym

?sort_by=post_code

country_code

Sortuje punkty odbioru po kodzie kraju

?sort_by=country_code

Sortowanie może odbywać się w dwóch kierunkach, poprzez użycie parametru sort_order. Domyślnie wyniki sortowane są malejąco (desc) wg daty utworzenia punktu odbioru (created_at).

Wartość sort_order

Działanie

Przykład

Wartość sort_order

Działanie

Przykład

asc

Sortuje punkty odbioru rosnąco

?sort_order=asc&sort_by=id

desc

Sortuje punkty odbioru malejąco

?sort_order=desc&sort_by=id





Na tej stronie