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

Wyszukiwanie punktów odbioru w API X odbywa się poprzez podanie jednego lub więcej z poniższych kryteriów jako parametr w zapytaniu GET wykonanym na adres URI kolekcji punktów odbioru:

  • /v1/organizations/:organization_id/dispatch_points

Przykładowe zapytanie

 

GET /v1/organizations/12345/dispatch_points?address=Zawiła&name=Punkt1 HTTP/1.1
Content-Type: application/json
Authorization: Bearer lkfjasd9f70y43ohriw...[ommited for brevity]...

Kryteria wyszukiwania

ParametrTypDziałaniePrzykł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

addressStringWyszukuje punkty odbioru, w których adres (street) rozpoczyna się od wskazanego ciągu.?address=Zaw
post_codeStringWyszukuje punkty odbioru, w których kod pocztowy zaczyna się od wskazanego ciągu.?post_code=30-442
country_codeStringWyszukuje punkty odbioru, w których kod kraju jest identyczny jak wskazany ciąg.?country_code=PL
cityStringWyszukuje 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_byDziałaniePrzykład
idSortuje punkty odbioru po identyfikatorze?sort_by=id
nameSortuje punkty odbioru po nazwie?sort_by=name
emailSortuje punkty odbioru po adresie e-mail.?sort_by=email
phoneSortuje punkty odbioru po numerze telefonu.?sort_by=phone
addressSortuje punkty odbioru po pierwszej linii adresu?sort_by=address
post_codeSortuje punkty odbioru po kodzie pocztowym?sort_by=post_code
country_codeSortuje punkty odbioru po kodzie kraju?sort_by=country_code

Sortowanie może odbywać się w dwóch kierunkach, poprzez użycie parametru sort_order:

Wartość sort_orderDziałaniePrzykład
ascSortuje punkty odbioru rosnąco?sort_order=asc&sort_by=id
descSortuje punkty odbioru malejąco?sort_order=desc&sort_by=id

Domyślnie wyniki sortowane są malejąco (desc) wg daty utworzenia punktu odbioru (created_at).

 

  • No labels