[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 |
---|---|---|---|
| Integer Array | Wyszukuje punkt odbioru o podanym id. Wyszukuje punkty odbioru o podanych id. |
|
| String | Wyszukuje punkty odbioru, których nazwa zawiera wskazany ciąg. |
|
| String Array | Wyszukuje punkty odbioru, których adres e-mail jest identyczny jak wskazany ciąg. Wyszukuje punkty odbioru ze wskazanymi adresami e-mail. |
|
| String Array | Wyszukuje punkty odbioru, których numer telefonu jest identyczny jak wskazany ciąg. Wyszukuje punkty odbioru ze wskazanymi numerami telefonów. |
|
| String | Wyszukuje punkty odbioru, w których adres ( |
|
| String | Wyszukuje punkty odbioru, w których kod pocztowy zaczyna się od wskazanego ciągu. |
|
| String | Wyszukuje punkty odbioru, w których kod kraju jest identyczny jak wskazany ciąg. |
|
| String | Wyszukuje punkty odbioru, w których miejscowość jest identyczna jak wskazany ciąg. |
|
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ść | Działanie | Przykład |
---|---|---|
| Sortuje punkty odbioru po identyfikatorze |
|
| Sortuje punkty odbioru po nazwie |
|
| Sortuje punkty odbioru po adresie e-mail. |
|
| Sortuje punkty odbioru po numerze telefonu. |
|
| Sortuje punkty odbioru po pierwszej linii adresu |
|
| Sortuje punkty odbioru po kodzie pocztowym |
|
| Sortuje punkty odbioru po kodzie kraju |
|
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ść | Działanie | Przykład |
---|---|---|
| Sortuje punkty odbioru rosnąco |
|
| Sortuje punkty odbioru malejąco |
|