/shipping/order_templates_new

List

Lists order templates with filtering, sorting, pagination, full-text search, and party/account expansion. | authz: min_org_role=operator | () -> (OrderTemplateNewListRes)

get/shipping/order_templates_new/list/v1

Query parameters

sort_by'created_at_timestamp' | 'last_edited_at_timestamp' | 'last_used_at_timestamp' | 'name'

Field to sort by.

sort_order'asc' | 'desc'

Sort order for query results

Sort order (asc or desc).

pageinteger
page_sizeinteger
searchstring nullable

Full-text search query for template name or description.

Full-text search query for template name or description.

filter_archivedboolean

Include archived templates instead of active templates.

Include archived templates instead of active templates.

filter_owned_by_user_idstring nullable

Must be a string starting with user_

Filter by the user that created the template.

filter_coordinator_labelstring nullable

Filter by coordinator label.

Filter by coordinator label.

filter_executor_org_idstring nullable

Must be a string starting with org_

Filter by an on-CHRT executor organization ID.

filter_off_chrt_executor_org_data_idstring nullable

Filter by an off-CHRT executor organization data ID.

Filter by an off-CHRT executor organization data ID.

filter_shipper_org_idstring nullable

Must be a string starting with org_

Filter by an on-CHRT shipper organization ID.

filter_off_chrt_shipper_org_data_idstring nullable

Filter by an off-CHRT shipper organization data ID.

Filter by an off-CHRT shipper organization data ID.

filter_coordinator_shipper_account_idsstring[] nullable

Filter by coordinator shipper account ID(s) assigned to template tasks.

Filter by coordinator shipper account ID(s) assigned to template tasks.

filter_created_at_timestamp_gtestring date-time nullable

Filter created_at_timestamp >= value (inclusive).

Filter created_at_timestamp >= value (inclusive).

filter_created_at_timestamp_ltestring date-time nullable

Filter created_at_timestamp <= value (inclusive).

Filter created_at_timestamp <= value (inclusive).

filter_last_edited_at_timestamp_gtestring date-time nullable

Filter last_edited_at_timestamp >= value (inclusive).

Filter last_edited_at_timestamp >= value (inclusive).

filter_last_edited_at_timestamp_ltestring date-time nullable

Filter last_edited_at_timestamp <= value (inclusive).

Filter last_edited_at_timestamp <= value (inclusive).

filter_last_used_at_timestamp_gtestring date-time nullable

Filter last_used_at_timestamp >= value (inclusive).

Filter last_used_at_timestamp >= value (inclusive).

filter_last_used_at_timestamp_ltestring date-time nullable

Filter last_used_at_timestamp <= value (inclusive).

Filter last_used_at_timestamp <= value (inclusive).

Response

Successful Response

total_countinteger required

Changes

No recorded changes to this endpoint across all 1 revision of this API.