[1.2.0] Wyszukiwanie książek adresowych
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
Host: api-shipx-pl.easypack24.net
Content-Type: application/json
Authorization: Bearer lkfjasd9f70y43ohriw...[ommited for brevity]...
Kryteria wyszukiwania
Parametr | Typ | Działanie | Przykład |
|---|---|---|---|
| Integer Array | Wyszukuje książki adresowe o podanym id. Wyszukuje książki adresowe o podanych id. | ?id=12 ?id=12,17 |
| Integer | Wyszukuje książki adresowe, których nazwa zawiera wskazany ciąg. | ?name=mag |
| String | Wyszukuje książki adresowe, których imię zawiera wskazany ciąg. | ?first_name=jan |
| String | Wyszukuje książki adresowe, których nazwisko zawiera wskazany ciąg. | ?last_name=kowal |
| 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. | |
| 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_parcel | Boolean | Wyszukuje książki adresowe, których nadawca przesyłek paczkomatowych jest identyczny jak wskazany ciąg. | ?sender_parcel=true |
sender_courier | Boolean | Wyszukuje książki adresowe, których nadawca przesyłek kurierskich jest identyczny jak wskazany ciąg. | ?sender_courier=true |
sender_letter | Boolean | Wyszukuje książki adresowe, których nadawca przesyłek listowych jest identyczny jak wskazany ciąg. | ?sender_letter=true |
kind | String | Wyszukuje książki adresowe, których rodzaj jest nadawca (sender), albo odbiorca (receiver). | ?kind=sender |
| Date | Wyszukuje zlecenia odbioru utworzone w danym dniu. | ?created_at=2016-01-07 |
| Time | 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 |
| Time | 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_street | String | Wyszukuje książki adresowe, w których pierwsza linia adresu głównego (street) zawiera wskazany ciąg. | ?main_address_street=Zaw |
| String | Wyszukuje książki adresowe, w których pierwsza linia adresu dostawy (street) zawiera wskazany ciąg. | ?delivery_address_street=Zaw |
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_by | Działanie | Przykład |
|---|---|---|
| Sortuje książki adresowe po identyfikatorze. | ?sort_by=id |
| Sortuje książki adresowe po nazwie. | ?sort_by=name |
first_name | Sortuje książki adresowe po imieniu. | ?sort_by=first_name |
last_name | Sortuje książki adresowe po nazwisku. | ?sort_by=last_name |
| Sortuje książki adresowe po adresie e-mail. | ?sort_by=email |
| Sortuje książki adresowe po numerze telefonu. | ?sort_by=phone |
sender_parcel | Sortuje książki adresowe po nadawcy przesyłek paczkomatowych. | ?sort_by=sender_parcel |
sender_courier | Sortuje książki adresowe po nadawcy przesyłek kurierskich. | ?sort_by=sender_courier |
sender_letter | Sortuje książki adresowe po nadawcy przesyłek listowych. | ?sort_by=sender_letter |
kind | Sortuje książki adresowe po rodzaju. | ?sort_by=kind |
| Sortuje książki adresowe po dacie utworzenia. | ?sort_by=created_at |
Sortowanie może odbywać się w dwóch kierunkach, poprzez użycie parametru sort_order:
Wartość sort_order | Działanie | Przykład |
|---|---|---|
| Sortuje zlecenia odbioru rosnąco | ?sort_order=asc&sort_by=id |
| Sortuje zlecenia odbioru malejąco | ?sort_order=desc&sort_by=id |
Domyślnie wyniki sortowane są malejąco (desc) wg daty utworzenia zlecenia odbioru (created_at).