Typeahead by order identifiers

Returns distinct order short ID, off-CHRT reference ID, and AWB values matching the query via case-insensitive regex. Searches visible non-draft orders and caller-created draft orders. | authz: allowed_org_types=[provider, shipper], min_org_role=operator | () -> (list[OrderTypeaheadResult])

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

querystringRequired

Typeahead search query

limitintegerOptional1-50Defaults to 10

Max results per field

Response

Successful Response

typeenum

valueslist of objects

Errors

422

Orders Typeahead V1request Unprocessable Entity Error

1	import { ChrtClient } from "@chrt-inc/typescript-sdk";
2
3	async function main() {
4	const client = new ChrtClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.shipping.orders.typeaheadV1({
8	query: "query",
9	limit: 1,
10	});
11	}
12	main();

1	[
2	{
3	"type": "off_chrt_reference_id",
4	"values": [
5	{
6	"order_ids": [
7	"order_ids"
8	],
9	"value": "value"
10	}
11	]
12	}
13	]