METUS API Hub
Orders

Get order by ID

GET
https://api.metahvac.com
/orders/v1.2/:id

Lookup order information by order number using hybrid tables (logistics.orders + logistics.shipments) for sub-200ms queries with live CHR shipment tracking data. Use the fields parameter to control which data is returned and manage PII exposure.

Get order by ID › path Parameters

id
​string · required

The order number to look up.

Get order by ID › query Parameters

fields
​string

Comma-separated list of fields to include in the response. Use '*' or omit for all fields. Supports dot notation for nested fields (e.g., 'soldTo.name', 'shipTo.street'). Examples: 'orderNumber,purchaseOrderNumber,shipments' or 'orderNumber,soldTo.name,shipTo.name,shipTo.street'.

Default: *

Get order by ID › Headers

Authorization
​string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get order by ID › Responses

Successful order lookup

Successful order response envelope (APIResponseV3 format)
success
​boolean · required

Whether the request was successful

​OrderData · required

Order information from hybrid tables (logistics.orders + logistics.shipments)

​ErrorObject[] · required

Search orders by customer PO

GET
https://api.metahvac.com
/orders/v1.2/search

Search for orders by customer purchase order number (po) using hybrid tables for sub-200ms queries with live CHR shipment tracking data. Use the fields parameter to control which data is returned and manage PII exposure. To search by order number, use GET /orders/v1.2/{id} instead.

Search orders by customer PO › query Parameters

po
​string · required

The customer purchase order number to search for.

fields
​string

Comma-separated list of fields to include in the response. Use '*' or omit for all fields. Supports dot notation for nested fields (e.g., 'soldTo.name', 'shipTo.street'). Examples: 'orderNumber,purchaseOrderNumber,shipments' or 'orderNumber,soldTo.name,shipTo.name,shipTo.street'.

Default: *

Search orders by customer PO › Headers

Authorization
​string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Search orders by customer PO › Responses

Successful order lookup

Successful order response envelope (APIResponseV3 format)
success
​boolean · required

Whether the request was successful

​OrderData · required

Order information from hybrid tables (logistics.orders + logistics.shipments)

​ErrorObject[] · required