get_order
Updated May 21, 20261 min read
Get a single order by Carriyo order ID or partner_order_reference via GET /orders/{reference}. If using partner_order_reference, pass key=partner_order_reference. Use select with json-mask syntax to return only required fields.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
order_id | string | Yes | Carriyo order ID or partner_order_reference. |
tenantId | string | Yes | — |
key | string | No | Values: order_id, partner_order_reference. |
select | string | No | json-mask expression to filter response fields. |
Example agent prompt
"Look up the order for me."
get_order( tenantId="…", order_id="ORD-2025-0001" )