Skip to content

List Orders

Returns a list of orders filtered by the provided query parameters. Only orders where payment is completed (or cash-on-delivery / free) and at least one item has has_bag = 1 are returned.

HeaderRequiredValue
api-keyyesOrders API key

All parameters are optional.

ParameterTypeDescription
order_timestamp_fromintUNIX timestamp — orders created at or after this time
order_timestamp_tointUNIX timestamp — orders created at or before this time
status_timestamp_fromintUNIX timestamp — orders last updated at or after this time
status_timestamp_tointUNIX timestamp — orders last updated at or before this time
delivery_timestamp_fromintUNIX timestamp — orders delivered at or after this time
delivery_timestamp_tointUNIX timestamp — orders delivered at or before this time
ParameterTypeAllowed values
statusstringprocessing, sent, delivered, cancelled
payment_statusstringpaid_in_one, fully_paid, in_progress, failed
order_typestringnormal, manual
shipmentstringstandard, door_to_door, pickup
ParameterTypeDescription
order_idintFilter by order number
driver_idstringFilter by Uber provider ID (social account)
trackingstringFilter by tracking number (exact match)
countrystringISO country code (e.g. HU, AT)
citystringPartial city name match
ParameterTypeDescription
limitintResults per page. Min: 1, max: 200. Default: 200
pageintPage number. Default: 1
skipintNumber of records to skip (requires limit)
API valueInternal statuses
processingPROCESSING, PAID
sentFORWARDED, SENT
deliveredDELIVERED, MANUAL_DELIVERED
cancelledCANCELLED

HTTP 200 OK

[
{
"order_timestamp": 1748300000,
"driver_id": "abc123",
"addresses": [
{
"type": "shipping",
"first_name": "John",
"last_name": "Doe",
"country": "Hungary",
"zip": "1011",
"city": "Budapest",
"street": "Fő utca",
"house_number": "1",
"floor": "2",
"door": "5",
"phone": "+36201234567"
}
],
"status": "sent",
"status_timestamp": 1748350000,
"tracking": "TRACK123456",
"order_id": "100042",
"ordered_products": [
{
"category_name": "Grocery",
"is_branded": true,
"product_name": "Example Product",
"quantity": 2,
"has_bag": true
}
],
"payment_status": "Paid in 1",
"local_currency": "HUF",
"paid_in_local_currency": "4990.00",
"paid_in_eur": "12.50",
"shipment": "Standard",
"delivery_failures": [],
"delivery_date": 1748360000,
"has_bag": true
}
]
FieldTypeDescription
order_timestampintOrder creation time as UNIX timestamp
driver_idstringUber provider ID of the assigned driver
addressesarrayShipping/billing addresses
statusstringCurrent delivery status
status_timestampintUNIX timestamp of the last status change
trackingstringLatest tracking number
order_idstringOrder number
ordered_productsarrayItems with has_bag = 1
payment_statusstringPaid in 1, Pay later, Fully paid, In progress (x/y), Failed (x/y)
local_currencystringISO currency code (e.g. HUF)
paid_in_local_currencystringSum of bag items in local currency
paid_in_eurstringSum of bag items converted to EUR
shipmentstringAlways "Standard" currently
delivery_failuresarrayFailed delivery attempts
delivery_dateint|stringUNIX timestamp of delivery, or empty string if not delivered
has_bagboolWhether the order has at least one bag item
StatusDescription
401Missing api-key header
403Invalid api-key value
422Validation error