METUS API Hub
Orders
Orders

Schemas

OrderSuccessResponse

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

OrderData

Order information from hybrid tables (logistics.orders + logistics.shipments)
orderNumber
​string · required

SAP order number (always included)

fulfillmentStatus
​string · required

SAP order status (e.g., OPEN, SHIPPED, DELIVERED)

​ShipmentInfo[] · required

Live shipment tracking data from CHR

purchaseOrderNumber
​string

Customer purchase order number

​SoldToParty

The corporate customer (billing entity)

​ShipToAddress

The delivery destination

SoldToParty

The corporate customer (billing entity)
id
​string · required

Sold-to customer number

name
​string

Customer name (PII - only included when requested via fields parameter)

ShipToAddress

The delivery destination
name
​string

Recipient name (PII - only included when requested via fields parameter)

street
​string

Street address (PII - only included when requested via fields parameter)

city
​string

City

state
​string

State or region

zip
​string

ZIP or postal code

country
​string

Country code

ShipmentInfo

Live shipment tracking details from CHR (synced every 1 minute)
id
​string

Internal shipment ID

carrierOrderNumber
​string

10-digit CHR carrier order number

trackingNumber
​string

Carrier tracking number

status
​string

Current shipment status from CHR

statusTimestamp
​string · date-time

When the status was last updated

carrier
​string

Shipping carrier name

weight
​number · float

Total shipment weight in pounds

pieces
​integer

Number of pieces in shipment

estimatedDelivery
​string · date-time

Estimated delivery date/time

lastUpdated
​string · date-time

When CHR last updated this shipment record

​ShipmentLineItem[]

Product line items within this shipment

ShipmentLineItem

A product line item within a shipment
sku
​string

Product SKU/material number

description
​string

Product description

quantity
​integer

Quantity of this item in the shipment

weight
​number · float

Item weight in pounds

pallets
​integer

Number of pallets for this item

purchaseOrderNumber
​string

Purchase order number (can differ per line item in consolidated shipments)

freightClass
​string

NMFC freight classification code (50-500). Class 70 = Food/Machinery/Appliances (typical for HVAC)

ErrorResponse

Error response envelope (APIResponseV3 format)
success
​boolean · required

Always false for errors

data
​null · required

Always null for errors

​ErrorObject[] · required

ErrorObject

Error detail object
code
​string · required

Error code (e.g., validation, not_found, unauthorized)

message
​string · required

Human-readable error message