get_custom_attributes

List custom attributes configured for a tenant.

Custom attributes are tenant-defined fields attached to shipments (or orders) — anything that isn't part of Carriyo's core schema. The agent needs this list to know what it can filter on or set when working with shipments.

Parameters

Name	Type	Required	Description
tenantId	string	Yes	The tenant to look up.

Returns

An array of custom-attribute definitions — typically each entry has a key, a display name, and a value type.

Example agent prompt

"What custom attributes do we track on shipments?"

get_custom_attributes(tenantId="…")

"Filter shipments where the priority_tier custom attribute is gold."

The agent uses this lookup to confirm priority_tier exists, then calls get_shipment_list with the corresponding _priority_tier filter.

Related tools

• get_shipment_list accepts custom-attribute filters using the _* prefix convention (e.g. _priority_tier=gold).
• create_shipment and edit_draft_shipment accept custom-attribute values within the shipment.attributes block.

Notes

• Custom attribute keys vary per tenant. Always look them up — never hardcode.