[1.2.0]Wyszukiwanie szablonów przesyłek

Owned by anagorski (Unlicensed)
Last updated: Dec 18, 2023 by Michał Machowski
1 min read

 

Lista szablonów przesyłek

Wyszukiwanie punktów odbioru odbywa się poprzez podanie jednego lub więcej z poniższych kryteriów

GET /v1/organizations/:organization_id/shipment_templates

Kryteria wyszukiwania

Parametr

Typ

Działanie

Przykład

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

Działanie

Przykład

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. Domyślnie wyniki sortowane są malejąco (desc) wg daty utworzenia punktu odbioru (created_at).

Wartość sort_order

Działanie

Przykład

Wartość sort_order

Działanie

Przykład

asc

Sortuje punkty odbioru rosnąco.

?sort_order=asc&sort_by=id

desc

Sortuje punkty odbioru malejąco.

?sort_order=desc&sort_by=id