[1.2.0] Wyszukiwanie szablonów przesyłek

Wyszukiwanie szablonów przesyłek 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 szablonów przesyłek:

/v1/organizations/:organization_id/shipment_templates

Przykładowe zapytanie

curl https://api-shipx-pl.easypack24.net/v1/organizations/1/shipment_templates?name=template_1 -H "Authorization: Bearer ..."

Kryteria wyszukiwania

Parametr	Typ	Działanie	Przykład
`name`	String	Wyszukuje szablony, których nazwa zawiera wskazany ciąg.	?name=mag
`status`	String	Wyszukuje szablony, których status zawiera wskazany ciąg.	?status=suspended

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

Wartość sort_by	Działanie	Przykład
`id`	Sortuje szablony po identyfikatorze.	?sort_by=id
`name`	Sortuje szablony po nazwie.	?sort_by=name
`status`	Sortuje szablony po statusie.	?sort_by=status
`created_at`	Sortuje szablony po dacie utworzenia.	?sort_by=created_at
`updated_at`	Sortuje szablony po dacie edycji.	?sort_by=updated_at

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

Wartość sort_order	Działanie	Przykład
`asc`	Sortuje zlecenia odbioru rosnąco	?sort_order=asc&sort_by=id
`desc`	Sortuje zlecenia odbioru malejąco	?sort_order=desc&sort_by=id

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

Developer Documentations

[1.2.0] Wyszukiwanie szablonów przesyłek

Analytics

Przykładowe zapytanie

Kryteria wyszukiwania

Sortowanie wyników

Related content