- Created by anagorski, last modified by Michał Machowski on Nov 29, 2021
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 4
Lista książek adresowych
Wyszukiwanie książek adresowych odbywa się poprzez podanie jednego lub więcej z poniższych kryteriów
GET /v1/organizations/:organization_id/address_books |
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 |
| String | 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. | ?email=magazyn1@http://firma.com ,magazyn2@http://firma.com |
| 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 |
| Boolean | Wyszukuje książki adresowe, których nadawca przesyłek paczkomatowych jest identyczny jak wskazany ciąg. | ?sender_parcel=true |
| Boolean | Wyszukuje książki adresowe, których nadawca przesyłek kurierskich jest identyczny jak wskazany ciąg. | ?sender_courier=true |
| Boolean | Wyszukuje książki adresowe, których nadawca przesyłek listowych jest identyczny jak wskazany ciąg. | ?sender_letter=true |
| 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 |
| 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 |
| String | Wyszukuje książki adresowe, w których nazwa firmy zawiera wskazany ciąg. | ?company_name=TestCompanyName |
| String | Wyszukuje 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_by | Działanie | Przykład |
---|---|---|
| Sortuje książki adresowe po identyfikatorze. | ?sort_by=id |
| Sortuje książki adresowe po nazwie. | ?sort_by=name |
| Sortuje książki adresowe po imieniu. | ?sort_by=first_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 |
| Sortuje książki adresowe po nadawcy przesyłek paczkomatowych. | ?sort_by=sender_parcel |
| Sortuje książki adresowe po nadawcy przesyłek kurierskich. | ?sort_by=sender_courier |
| Sortuje książki adresowe po nadawcy przesyłek listowych. | ?sort_by=sender_letter |
| Sortuje książki adresowe po rodzaju. | ?sort_by=kind |
| Sortuje książki adresowe po dacie utworzenia. | ?sort_by=created_at |
| Sortuje książki adresowe po nazwie firmy. | ?sort_by=company_name |
| Sortuje książki 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
. Domyślnie wyniki sortowane są malejąco (desc
) wg daty utworzenia punktu odbioru (created_at)
Wartość sort_order | Działanie | Przykład |
---|---|---|
| Sortuje punkty odbioru rosnąco. | ?sort_order=asc&sort_by=id |
| Sortuje punkty odbioru malejąco. | ?sort_order=desc&sort_by=id |
Przykładowe zapytanie
curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1/address_books?sort_order=asc&sort_by=last_name&sender_letter=true -H 'Authorization: Bearer token' -H 'Content-Type: application/json' |
Odpowiedź
HTTP/1.1 200 OK Content-Type: application/json { "href":"https://api-shipx-pl.easypack24.net/v1/address_books?sender_letter=true\u0026sort_by=last_name\u0026sort_order=asc", "count":1, "page":1, "per_page":30, "items":[ { "id":5, "first_name":"Jan", "last_name":"Nowak", "email":"jan@nowak.pl", "phone":"123456789", "created_at":"2016-02-24T09:22:27.212+01:00", "updated_at":"2016-02-24T09:22:27.212+01:00", "organization_id":1, "name":"Nowak Corp", "sender_parcel":false, "sender_courier":false, "sender_letter":true, "kind": "sender", "company_name": "MyCompanyName", "preferred_dropoff_point": "KRA120", "main_address":{ "id": "123", "street": "Malborska", "building_number": "130", "city":"Warsaw","id": "123", "post_code":"33-666", "country_code":"PO" }, "delivery_address":{ "id": "123", "street": "Malborska", "building_number": "140", "city":"Cracow", "post_code":"66-666", "country_code":"AZ" } } ] } |
- No labels