CHchrt
/shipping/order_templates_new

List

Changed on

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

get/shipping/order_templates_new/list/v1

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/shipping/order_templates_new/list/v1
  • Auth
    HTTP bearer

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.

filter_order_template_new_idsstring[] nullable

Filter by order template new IDs

filter_archivedboolean

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_labelsstring[] nullable

Filter by all supplied coordinator labels (exact matches).

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_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_coordinator_shipper_account_idsstring[] nullable

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_ltestring date-time nullable

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_ltestring date-time nullable

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_ltestring date-time nullable

Filter last_used_at_timestamp <= value (inclusive).

Response

Successful Response

total_countinteger required

Changes

  • 5e62049a1c19Revision changes
    • warning

      added the new AGC enum value to the ///// response property for the response status

    • warning

      added the new ALO enum value to the ///// response property for the response status

    • warning

      added the new AXA enum value to the ///// response property for the response status

    • warning

      added the new BSA enum value to the ///// response property for the response status

    • warning

      added the new CC enum value to the ///// response property for the response status

    • warning

      added the new COF enum value to the ///// response property for the response status

    • warning

      added the new COU enum value to the ///// response property for the response status

    • warning

      added the new CSL enum value to the ///// response property for the response status

    • warning

      added the new CUR enum value to the ///// response property for the response status

    • warning

      added the new DDX enum value to the ///// response property for the response status

    • warning

      added the new DGD enum value to the ///// response property for the response status

    • warning

      added the new DGR enum value to the ///// response property for the response status

    • warning

      added the new DIC enum value to the ///// response property for the response status

    • warning

      added the new DIR enum value to the ///// response property for the response status

    • warning

      added the new DNS enum value to the ///// response property for the response status

    • warning

      added the new EBI enum value to the ///// response property for the response status

    • warning

      added the new EBM enum value to the ///// response property for the response status

    • warning

      added the new EXC enum value to the ///// response property for the response status

    • warning

      added the new FRA enum value to the ///// response property for the response status

    • warning

      added the new FRC enum value to the ///// response property for the response status

    • warning

      added the new FTR enum value to the ///// response property for the response status

    • warning

      added the new GCR enum value to the ///// response property for the response status

    • warning

      added the new GLD enum value to the ///// response property for the response status

    • warning

      added the new GOB enum value to the ///// response property for the response status

    • warning

      added the new HNT enum value to the ///// response property for the response status

    • warning

      added the new HST enum value to the ///// response property for the response status

    • warning

      added the new IAT enum value to the ///// response property for the response status

    • warning

      added the new IBS enum value to the ///// response property for the response status

    • warning

      added the new IMP enum value to the ///// response property for the response status

    • warning

      added the new MDC enum value to the ///// response property for the response status

    • warning

      added the new MEX enum value to the ///// response property for the response status

    • warning

      added the new NST enum value to the ///// response property for the response status

    • warning

      added the new PAX enum value to the ///// response property for the response status

    • warning

      added the new PEB enum value to the ///// response property for the response status

    • warning

      added the new PED enum value to the ///// response property for the response status

    • warning

      added the new PEL enum value to the ///// response property for the response status

    • warning

      added the new PHY enum value to the ///// response property for the response status

    • warning

      added the new PPR enum value to the ///// response property for the response status

    • warning

      added the new PRI enum value to the ///// response property for the response status

    • warning

      added the new PRO enum value to the ///// response property for the response status

    • warning

      added the new PXD enum value to the ///// response property for the response status

    • warning

      added the new PXS enum value to the ///// response property for the response status

    • warning

      added the new QWT enum value to the ///// response property for the response status

    • warning

      added the new RCS enum value to the ///// response property for the response status

    • warning

      added the new SBU enum value to the ///// response property for the response status

    • warning

      added the new SEC enum value to the ///// response property for the response status

    • warning

      added the new SEN enum value to the ///// response property for the response status

    • warning

      added the new SMC enum value to the ///// response property for the response status

    • warning

      added the new SML enum value to the ///// response property for the response status

    • warning

      added the new SMU enum value to the ///// response property for the response status

    • warning

      added the new SSS enum value to the ///// response property for the response status

    • warning

      added the new SVC enum value to the ///// response property for the response status

    • warning

      added the new TRC enum value to the ///// response property for the response status

    • warning

      added the new TRU enum value to the ///// response property for the response status

    • warning

      added the new TTS enum value to the ///// response property for the response status

    • warning

      added the new TTT enum value to the ///// response property for the response status

    • warning

      added the new UCB enum value to the ///// response property for the response status

    • warning

      added the new UKS enum value to the ///// response property for the response status

    • warning

      added the new ULD enum value to the ///// response property for the response status

    • warning

      added the new UNKN enum value to the ///// response property for the response status

    • warning

      added the new VEH enum value to the ///// response property for the response status

    • warning

      added the new VIC enum value to the ///// response property for the response status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ////// to the response with the status

  • daee8cca7119Revision changes
    • warning

      added the new cargo_on_flight__cargo_manifested enum value to the /////// response property for the response status

    • warning

      added the new cargo_on_flight__cargo_manifested enum value to the //////// response property for the response status

    • warning

      added the new cargo_on_flight__cargo_recovered enum value to the /////// response property for the response status

    • warning

      added the new cargo_on_flight__cargo_recovered enum value to the //////// response property for the response status

    • info

      added the optional property //// to the response with the status