- Created by anagorski, last modified by Michał Machowski on Dec 06, 2021
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 5 Next »
Na tej stronie
Lista przesyłek
Wyszukiwanie przesyłek odbywa się poprzez podanie jednego lub więcej z poniższych kryteriów
Nie zwracamy cen dla klientów debetowych. Atrybut rate
przyjmuje wartość null
GET /v1/organizations/:organization_id/shipments |
Kryteria wyszukiwania
Parametr | Typ | Działanie | Przykład |
---|---|---|---|
| Integer Array | Wyszukuje przesyłkę, o podanym id. Wyszukuje przesyłki o podanych id. |
|
| Date | Wyszukuje przesyłki utworzone w danym dniu. |
|
| Time | Wyszukuje przesyłki których czas stworzenia jest >= wskazany czas. Czas może być podany w formacie ISO 8601 lub podobnym, a także jako timestamp. |
|
| Time | Wyszukuje przesyłki utworzone wcześniej niż wskazany czas. Czas może być podany w formacie ISO 8601 lub podobnym, a także jako timestamp. |
|
| String | Wyszukuje przesyłki, których numer trackingowy jest identyczny jak wskazany ciąg. |
|
| String | Wyszukuje przesyłki, których numer trackingowy zawiera wskazany ciąg. |
|
| String Array | Wyszukuje przesyłki we wskazanym statusie. Wyszukuje przesyłki w jednym ze wskazanych statusów. |
|
| String Array | Wyszukuje przesyłki, dla których zakupiona została wskazana usługa. Wyszukuje przesyłki, dla których zakupiona została jedna ze wskazanych usług. |
|
| String Array | Wyszukuje przesyłki, dla których została zakupiona usługa wskazanego przewoźnika. Wyszukuje przesyłki, dla których została zakupiona usługa jednego ze wskazanych przewoźników. |
|
| Number | Wyszukuje przesyłki ubezpieczone na kwotę równą lub większą niż wskazana. |
|
| Number | Wyszukuje przesyłki ubezpieczone na kwotę mniejszą lub równą niż wskazana. |
|
| Number | Wyszukuje przesyłki z wartością pobrania większą lub równą wskazanej. |
|
| Number | Wyszukuje przesyłki z wartością pobrania mniejszą lub równą wskazanej. |
|
| String | Wyszukuje przesyłki, w których imię, nazwisko lub nazwa firmy odbiorcy rozpoczyna się od wskazanego ciągu. |
|
| String | Wyszukuje przesyłki, w których adres odbiorcy ( |
|
| String | Wyszukuje przesyłki, w których miejscowość odbiorcy jest identyczna jak wskazany ciąg. |
|
| String | Wyszukuje przesyłki, w których kod pocztowy odbiorcy zaczyna się od wskazanego ciągu. |
|
| String | Wyszukuje przesyłki, w których kod kraju odbiorcy jest identyczny jak wskazany ciąg. |
|
| String | Wyszukuje przesyłki, w których numer telefonu odbiorcy jest identyczny jak wskazany ciąg. |
|
| String | Wyszukuje przesyłki, w których adres e-mail odbiorcy rozpoczyna się od wskazanego ciągu. |
|
| String | Wyszukuje przesyłki, w których imię, nazwisko lub nazwa firmy nadawcy rozpoczyna się od wskazanego ciągu. |
|
| String | Wyszukuje przesyłki, w których adres nadawcy ( |
|
| String | Wyszukuje przesyłki, w których miejscowość nadawcy jest identyczna jak wskazany ciąg. |
|
| String | Wyszukuje przesyłki, w których kod pocztowy nadawcy zaczyna się od wskazanego ciągu. |
|
| String | Wyszukuje przesyłki, w których kod kraju nadawcy jest identyczny jak wskazany ciąg. |
|
| String | Wyszukuje przesyłki, w których numer telefonu nadawcy jest identyczny jak wskazany ciąg. |
|
| String | Wyszukuje przesyłki, w których adres e-mail nadawcy rozpoczyna się od wskazanego ciągu. |
|
| String | Wyszukuje przesyłki, których status jest na liście: dispatched_by_sender, collected_from_sender, taken_by_courier, adopted_at_source_branch, sent_from_source_branch, |
|
| String | Wyszukiwanie przesyłek nadanych przez broker'a, którego id jest identyczne jak wskazany ciąg. | ?external_customer_id=broker10 |
| String Array | Wyszukuje przesyłki mające wskazany sposób nadania. Wyszukuje przesyłki mające jeden ze wskazanych sposobów nadania. |
|
| Boolean | Wyszukuje przesyłki, które posiadają flagę 'only_choice_of_offer' ustawioną na true oraz nie wygaśnięte oferty. |
|
| String | Wyszukuje przesyłki posiadające oferty o wskazanym statusie. |
|
Sortowanie wyników
Wyniki wyszukiwania można sortować przekazujący parametr sort_by
, który może przyjmować następujące wartości:
Wartość sort_by | Działanie | Przykład |
---|---|---|
| Sortuje przesyłki po identyfikatorze |
|
| Sortuje przesyłki po czasie utworzenia |
|
| Sortuje przesyłki po numerze trackingowym |
|
| Sortuje przesyłki po nazwie usługi |
|
| Sortuje przesyłki po statusie |
|
| Sortuje przesyłki po kwocie ubezpieczenia |
|
| Sortuje przesyłki po kwocie pobrania |
|
| Sortuje przesyłki po id broker'a |
|
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 przesyłki (created_at).
Wartość sort_order | Działanie | Przykład |
---|---|---|
| Sortuje przesyłki rosnąco |
|
| Sortuje przesyłki malejąco |
|
- No labels