Orders Model
An order records the commercial, customer, product, payment, fulfillment, and delivery state of a transaction.
Representative identifiers and money fields include id, uuid, paymethod_id, business_id, customer_id, delivery_zone_id, offer_id, service_fee, tax, delivery_zone_price, discount, driver_tip, cash, and currency. Lifecycle and logistics fields include delivery_type, delivery_datetime, status, driver_id, driver_company_id, order_group_id, priority, ETA fields, and timestamps.
Preorder status 13 is accepted on update and can also be system-managed.
Orders can load products, payment method, customer, business, driver, reviews, attachments, metafields, taxes, fees, payment events, cart, and other relations. Request only necessary data; order responses can contain sensitive personal and payment context. See Order relation expansion.
Schema properties
Schema: Order
| Name | Type | Description |
|---|---|---|
agent_id | integer | null | — |
ai_agent_id | integer | null | — |
app_id | string | null | — |
business_id | integer | null | — |
cart_group_id | integer | null | — |
cash | number | null | — |
cloned_order_id | integer | null | — |
comment | any | — |
conversation_id | integer | null | — |
country_code | string | null | — |
coupon | string | null | — |
created_at | string | null | — |
currency | string | null | — |
currency_rates | object | array | null | — |
customer_id | integer | null | — |
delivered_in | integer | null | — |
delivery_datetime | string | null | — |
delivery_datetime_utc | string | null | — |
delivery_option_id | integer | null | — |
delivery_position | integer | null | — |
delivery_type | integer | null | — |
delivery_zone_id | integer | null | — |
delivery_zone_price | number | null | — |
discount | number | null | — |
driver_company_id | integer | null | — |
driver_group_id | integer | null | — |
driver_id | integer | null | — |
driver_tip | number | null | — |
eta_drive_time | integer | null | — |
eta_preparation_time | integer | null | — |
eta_status_times | object | null | — |
eta_time | integer | null | — |
eta_variation_time | integer | null | — |
expired_at | string | null | — |
external_driver_id | integer | null | — |
external_id | string | null | — |
fraud_message | string | null | — |
fraud_status | string | null | — |
has_items | boolean | null | — |
id | integer | null | — |
language_id | integer | null | — |
last_direct_message_at | string | null | — |
last_driver_assigned_at | string | null | — |
last_general_message_at | string | null | — |
last_logistic_assign_at | string | null | — |
last_logistic_attempted_at | string | null | — |
last_manual_assign_at | string | null | — |
last_message_at | string | null | — |
locked | boolean | null | — |
locked_at | string | null | — |
logistic_attemps | integer | null | — |
logistic_status | integer | null | — |
manual_driver_assignment_author_id | integer | null | — |
manual_driver_assignment_comment | any | — |
offer | number | null | — |
offer_id | integer | null | — |
offer_rate | number | null | — |
offer_type | integer | null | — |
on_behalf_of | string | null | — |
order_group_id | integer | null | — |
pay_data | string | null | — |
paymethod_data | object | null | — |
paymethod_id | integer | null | — |
place_id | integer | null | — |
prepared_in | integer | null | — |
priority | integer | null | — |
refund_data | string | null | — |
reject_reason | string | null | — |
reporting_data | object | null | — |
reservation | object | null | — |
resolved_at | string | null | — |
service_fee | number | null | — |
site_id | integer | null | — |
spot_number | integer | null | — |
status | integer | null | — |
student_id | integer | null | — |
summary | object | null | — |
summary_version | integer | null | — |
tax | number | null | — |
tax_type | integer | null | — |
time_status | string | null | — |
to_print | boolean | null | — |
track_url | any | — |
updated_at | string | null | — |
uuid | string | null | — |
vehicle | object | null | — |