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

Wyszukiwanie książek adresowych 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/address_books

Przykładowe zapytanie

 

GET /v1/organizations/12345/address_books HTTP/1.1
Content-Type: application/json
Authorization: Bearer lkfjasd9f70y43ohriw...[ommited for brevity]...

Kryteria wyszukiwania

ParametrTypDziałaniePrzykład
id

Integer

Array

Wyszukuje książki adresowe o podanym id.

Wyszukuje książki adresowe o podanych id.

?id=12

?id=12,17

name

String

Wyszukuje książki adresowe, których nazwa zawiera wskazany ciąg.

?name=mag
first_nameStringWyszukuje książki adresowe, których imię zawiera wskazany ciąg.?first_name=jan
last_nameStringWyszukuje książki adresowe, których nazwisko zawiera wskazany ciąg.?last_name=kowal
email

String

Array

Wyszukuje książki adresowe, których adres e-mail jest identyczny jak wskazany ciąg.

Wyszukuje książki adresowe ze wskazanymi adresami e-mail.

?email=magazyn1@firma.com

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

phone

String

Array

Wyszukuje książki adresowe, których numer telefonu jest identyczny jak wskazany ciąg.

Wyszukuje książki adresowe ze wskazanymi numerami telefonów.

?phone=123123123

?phone=123123123,1231231234

sender_parcelBooleanWyszukuje książki adresowe, których nadawca przesyłek paczkomatowych jest identyczny jak wskazany ciąg.?sender_parcel=true
sender_courierBooleanWyszukuje książki adresowe, których nadawca przesyłek kurierskich jest identyczny jak wskazany ciąg.?sender_courier=true
sender_letterBooleanWyszukuje książki adresowe, których nadawca przesyłek listowych jest identyczny jak wskazany ciąg.?sender_letter=true
kindStringWyszukuje książki adresowe, których rodzaj jest nadawca (sender), albo odbiorca (receiver).?kind=sender
created_atDateWyszukuje zlecenia odbioru utworzone w danym dniu.?created_at=2016-01-07
created_at_gteqTime

Wyszukuje zlecenia odbioru, których czas utworzenia jest >= wskazany czas.

Czas może być podany w formacie ISO 8601 lub podobnym, a także jako timestamp.

?created_at_gteq=2016-01-01T13:10+01:00

?created_at_gteq=1451650200

created_at_lteqTime

Wyszukuje zlecenia odbioru, których czas utworzenia jest <= wskazany czas.

Czas może być podany w formacie ISO 8601 lub podobnym, a także jako timestamp.

?created_at_lteq=2016-01-01T13:10+01:00

?created_at_lteq=1451650200

main_address_streetStringWyszukuje książki adresowe, w których pierwsza linia adresu głównego (street) zawiera wskazany ciąg.?main_address_street=Zaw
delivery_address_streetStringWyszukuje książki adresowe, w których pierwsza linia adresu dostawy (street) zawiera wskazany ciąg.?delivery_address_street=Zaw
company_nameStringWyszukuje książki adresowe, w których nazwa firmy zawiera wskazany ciąg.?company_name=TestCompanyName
preferred_dropoff_pointStringWyszukuje książki adresowe, w których preferowany punkt nadawczy zawiera wskazany ciąg.?preferred_dropoff_point=KRA120

Sortowanie wyników

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

Wartość sort_byDziałaniePrzykład
idSortuje książki adresowe po identyfikatorze.?sort_by=id
nameSortuje książki adresowe po nazwie.?sort_by=name
first_nameSortuje książki adresowe po imieniu.?sort_by=first_name
last_nameSortuje książki adresowe po nazwisku.?sort_by=last_name
emailSortuje książki adresowe po adresie e-mail.?sort_by=email
phoneSortuje książki adresowe po numerze telefonu.?sort_by=phone
sender_parcelSortuje książki adresowe po nadawcy przesyłek paczkomatowych.?sort_by=sender_parcel
sender_courierSortuje książki adresowe po nadawcy przesyłek kurierskich.?sort_by=sender_courier
sender_letterSortuje książki adresowe po nadawcy przesyłek listowych.?sort_by=sender_letter
kindSortuje książki adresowe po rodzaju.?sort_by=kind
created_atSortuje książki adresowe po dacie utworzenia.?sort_by=created_at
company_nameSortuje kasiazki adresowe po nazwie frmy.?sort_by=company_name
preferred_dropoff_pointSortuje kasiazki adresowe po preferowanym punkcie nadawczym.?sort_by=preferred_dropoff_point

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