List Orders Details
GET {{base_url}}/v1/delivery/store/{{store_id}}/orders?expand=<string>&state=<string>&status=<string>&start_time=<string>&end_time=<string>&next_page_token=<string>&page_size=<number>
A list with detailed information regarding Uber Eats orders for a chosen restaurant
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
expand | string | Comma-separated list of fields to expand. Expected values 'carts','deliveries' and/or 'payment'. By default, these fields in the MerchantOrder are omitted from the response unless specified. For example ‘carts,payment’ returns an order with the ‘carts’ and ‘payment’ field included. | |
state | string | Comma-separated list of states. If omitted, orders in all states are returned. For example, ‘OFFERED,ACCEPTED’ filters orders down to orders with these 2 states. Expected values: | |
| Name | Description | ||
| -------------------------- | --------------------------------------- | ||
CREATED | Order has been created | ||
OFFERED | Order has been offered to the merchant | ||
ACCEPTED | Merchant has accepted the order | ||
HANDED_OFF | Order has been fully handed off to delivery partners. If there are multiple delivery partners, an order will only transition to this state only when all delivery partners have picked up the order. | ||
SUCCEEDED | Order was successfully delivered | ||
FAILED | Order failed for any reason | ||
UNKNOWN | Catch-all for unrecognized states | ||
status | string | Comma-separated list of statuses. If omitted, orders in all statuses are returned. For example, ‘SCHEDULED,ACTIVE’ filters orders down to orders with these 2 statuses. Expected values: | |
| Name | Description | ||
| -------------------------- | --------------------------------------- | ||
SCHEDULED | Order is scheduled for a future time | ||
ACTIVE | Order is active | ||
COMPLETED | Order is completed | ||
UNKNOWN | Catch-all for unrecognized statuses | ||
start_time | string | Timestamp in RFC3339 format. Filters down to orders created after this time. Must be before end_time if specified. If both start_time and end_time are not specified, all orders will be returned. Note that only orders within 60 days are returned. | |
end_time | string | Timestamp in RFC3339 format. Filters down to orders created before this time. Must be after start_time if specified. If start_time is not specified, it is defaulted to 60 days ago. | |
next_page_token | string | Pagination information - token to retrieve the next page. This token is provided in the pagination_data field if the response is paginated | |
page_size | string | Pagination information - Number of orders in a single page. Only a maximum of 50 can be specified. If omitted, defaults to 50. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
User-Agent | string |
RESPONSES
status: OK
{"data":[{"id":"\u003cstring\u003e","display_id":"\u003cstring\u003e","external_id":"\u003cstring\u003e","state":"OFFERED","status":"ACTIVE","preparation_status":"OUT_OF_ITEM_PENDING_CUSTOMER_RESPONSE","ordering_platform":"UBER_EATS","fulfillment_type":"DELIVERY_BY_MERCHANT","scheduled_order_target_delivery_time_range":{"start_time":"\u003cdate\u003e","end_time":"\u003cdate\u003e"},"store":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","partner_identifiers":[{"id":"\u003cstring\u003e","type":"INTEGRATOR_BRAND_ID"}]},"customers":[{"id":"\u003cstring\u003e","name":{"display_name":"\u003cstring\u003e","first_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e"},"order_history":{"past_order_count":"\u003cinteger\u003e"},"contact":{"phone":{"number":"\u003cstring\u003e","pin_code":"\u003cstring\u003e","country_iso2":"\u003cstring\u003e"}},"is_primary_customer":"\u003cboolean\u003e","tax_profile":{"tax_ids":"\u003cstring\u003e","tax_id_type":"CORPORATE_TAX_ID","customer_full_name":"\u003cstring\u003e","email":"\u003cstring\u003e","legal_entity_name":"\u003cstring\u003e","billing_address":"\u003cstring\u003e","country":"\u003cstring\u003e","encrypted_tax_id":{"key":"\u003cstring\u003e","cipher_text":"\u003cstring\u003e"}},"can_respond_to_fulfillment_issues":"\u003cboolean\u003e"}],"deliveries":[{"id":"\u003cstring\u003e","delivery_partner":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","vehicle":{"type":"PEDESTRIAN","make":"\u003cstring\u003e","model":"\u003cstring\u003e","color":"\u003cstring\u003e","license_plate":"\u003cstring\u003e","is_autonomous":"\u003cboolean\u003e","handoff_instructions":"\u003cstring\u003e","passcode":"\u003cstring\u003e"},"picture_url":"\u003cstring\u003e","contact":{"phone":{"number":"\u003cstring\u003e","pin_code":"\u003cstring\u003e","country_iso2":"\u003cstring\u003e"}},"current_location":{"latitude":"\u003cstring\u003e","longitude":"\u003cstring\u003e"}},"status":"COMPLETED","location":{"type":"\u003cstring\u003e","id":"\u003cstring\u003e","street_address_line_one":"\u003cstring\u003e","street_address_line_two":"\u003cstring\u003e","latitude":"\u003cstring\u003e","longitude":"\u003cstring\u003e","unit_number":"\u003cstring\u003e","business_name":"\u003cstring\u003e","city":"\u003cstring\u003e","country":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","location_type_value":"\u003cstring\u003e","client_provided_street_address_line_one":"\u003cstring\u003e"},"estimated_pick_up_time":"\u003cstring\u003e","interaction_type":"DOOR_TO_DOOR","delivery_partner_marked_not_ready_time":"\u003cdate\u003e","instructions":"\u003cstring\u003e"}],"carts":[{"id":"\u003cstring\u003e","items":[{"id":"\u003cstring\u003e","cart_item_id":"\u003cstring\u003e","title":"\u003cstring\u003e","external_data":"\u003cstring\u003e","customer_id":"\u003cstring\u003e","quantity":{"amount":"\u003cinteger\u003e","unit":"POUND"},"default_quantity":{"amount":"\u003cinteger\u003e","unit":"POUND"},"customer_requests":{"allergy":{"allergens":["\u003cstring\u003e"],"instructions":"\u003cstring\u003e"},"special_instructions":"\u003cstring\u003e"},"selected_modifier_groups":[{"id":"\u003cstring\u003e","title":"\u003cstring\u003e","external_data":"\u003cstring\u003e","selected_items":[{"value":"\u003cCircular reference to #/components/schemas/item detected\u003e"}],"removed_items":[{"value":"\u003cCircular reference to #/components/schemas/item detected\u003e"}]}],"picture_url":"\u003cstring\u003e"}],"fulfillment_issues":[{"issue_type":"OUT_OF_ITEM","action_type":"ASK_CUSTOMER","root_item":{"id":"\u003cstring\u003e","cart_item_id":"\u003cstring\u003e","title":"\u003cstring\u003e","external_data":"\u003cstring\u003e","customer_id":"\u003cstring\u003e","quantity":{"amount":"\u003cinteger\u003e","unit":"POUND"},"default_quantity":{"amount":"\u003cinteger\u003e","unit":"PIECE"},"customer_requests":{"allergy":{"allergens":["\u003cstring\u003e"],"instructions":"\u003cstring\u003e"},"special_instructions":"\u003cstring\u003e"},"selected_modifier_groups":[{"id":"\u003cstring\u003e","title":"\u003cstring\u003e","external_data":"\u003cstring\u003e","selected_items":[{"value":"\u003cCircular reference to #/components/schemas/item detected\u003e"}],"removed_items":[{"value":"\u003cCircular reference to #/components/schemas/item detected\u003e"}]}],"picture_url":"\u003cstring\u003e"},"item_availability":{"items_requested":{"amount":"\u003cinteger\u003e","unit":"PIECE"},"items_available":{"amount":"\u003cinteger\u003e","unit":"POUND"}},"item_substitute":{"id":"\u003cstring\u003e","cart_item_id":"\u003cstring\u003e","title":"\u003cstring\u003e","external_data":"\u003cstring\u003e","customer_id":"\u003cstring\u003e","quantity":{"amount":"\u003cinteger\u003e","unit":"KILOGRAM"},"default_quantity":{"amount":"\u003cinteger\u003e","unit":"KILOGRAM"},"customer_requests":{"allergy":{"allergens":["\u003cstring\u003e"],"instructions":"\u003cstring\u003e"},"special_instructions":"\u003cstring\u003e"},"selected_modifier_groups":[{"id":"\u003cstring\u003e","title":"\u003cstring\u003e","external_data":"\u003cstring\u003e","selected_items":[{"value":"\u003cCircular reference to #/components/schemas/item detected\u003e"}],"removed_items":[{"value":"\u003cCircular reference to #/components/schemas/item detected\u003e"}]}],"picture_url":"\u003cstring\u003e"},"suspend_until":"\u003cdate\u003e","store_response":"\u003cstring\u003e"}],"special_instructions":"\u003cstring\u003e","include_single_use_items":"\u003cboolean\u003e","revision_id":"\u003cstring\u003e","restricted_items":{"alcohol":{"contain_alcoholic_item":"\u003cboolean\u003e"},"tobacco":{"contain_tobacco_product":"\u003cboolean\u003e"}}}],"payment":{"payment_detail":{"order_total":{"display_amount":"\u003cstring\u003e","net":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"tax":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"gross":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"is_tax_inclusive":"\u003cboolean\u003e"},"item_charges":{"total":{"display_amount":"\u003cstring\u003e","net":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"tax":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"gross":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"is_tax_inclusive":"\u003cboolean\u003e"},"subtotal_including_promos":{"display_amount":"\u003cstring\u003e","net":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"tax":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"gross":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"is_tax_inclusive":"\u003cboolean\u003e"},"price_breakdown":{"cart_item_id":"\u003cstring\u003e","price_type":"\u003cstring\u003e","quantity":{"amount":"\u003cinteger\u003e","unit":"KILOGRAM"},"total":{"display_amount":"\u003cstring\u003e","net":{"display_amount":"\u003cstring\u003e","net":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"tax":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"gross":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"is_tax_inclusive":"\u003cboolean\u003e"},"tax":{"display_amount":"\u003cstring\u003e","net":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"tax":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"gross":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"is_tax_inclusive":"\u003cboolean\u003e"},"gross":{"display_amount":"\u003cstring\u003e","net":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"tax":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"gross":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"is_tax_inclusive":"\u003cboolean\u003e"},"is_tax_inclusive":{"display_amount":"\u003cstring\u003e","net":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"tax":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"gross":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"is_tax_inclusive":"\u003cboolean\u003e"}},"discount":{"total":{"display_amount":"\u003cstring\u003e","net":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"tax":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"gross":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"is_tax_inclusive":"\u003cboolean\u003e"},"quantity":{"amount":"\u003cinteger\u003e","unit":"GRAM"}},"unit":{"display_amount":"\u003cstring\u003e","net":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"tax":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"gross":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"is_tax_inclusive":"\u003cboolean\u003e"}}},"fees":{"total":{"display_amount":"\u003cstring\u003e","net":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"tax":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"gross":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"is_tax_inclusive":"\u003cboolean\u003e"},"details":[{"id":"BAG_FEE","amount":{"display_amount":"\u003cstring\u003e","net":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"tax":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"gross":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"is_tax_inclusive":"\u003cboolean\u003e"}}]},"tips":{"total":{"display_amount":"\u003cstring\u003e","net":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"tax":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"gross":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"is_tax_inclusive":"\u003cboolean\u003e"}},"promotions":{"total":{"display_amount":"\u003cstring\u003e","net":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"tax":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"gross":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"is_tax_inclusive":"\u003cboolean\u003e"},"details":{"external_promotion_id":"\u003cstring\u003e","type":"\u003cstring\u003e","discount_value":"\u003cstring\u003e","discount_percentage":"\u003cstring\u003e","discount_delivery_fee_value":"\u003cstring\u003e","discount_items":[{"external_id":"\u003cstring\u003e","discounted_quantity":"\u003cinteger\u003e","discount_amount_applied":"\u003cinteger\u003e"}]},"order_total_excluding_promos":{"display_amount":"\u003cstring\u003e","net":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"tax":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"gross":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"is_tax_inclusive":"\u003cboolean\u003e"}},"adjustment":{"total":{"display_amount":"\u003cstring\u003e","net":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"tax":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"gross":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"is_tax_inclusive":"\u003cboolean\u003e"},"details":{"amount":{"display_amount":"\u003cstring\u003e","net":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"tax":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"gross":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"is_tax_inclusive":"\u003cboolean\u003e"},"reason":"\u003cstring\u003e"}},"currency_code":"\u003cstring\u003e","cash_amount_due":{"display_amount":"\u003cstring\u003e","net":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"tax":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"gross":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"is_tax_inclusive":"\u003cboolean\u003e"}},"tax_reporting":{"breakdown":{"items":[{"instance_id":"\u003cstring\u003e","description":"SMALL_ORDER_FEE","gross_amount":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"net_amount":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"}}],"fees":[{"instance_id":"\u003cstring\u003e","description":"DELIVERY_FEE","gross_amount":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"net_amount":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"}}],"promotions":[{"instance_id":"\u003cstring\u003e","description":"SMALL_ORDER_FEE","gross_amount":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"},"net_amount":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"}}]},"origin":{"id":"\u003cstring\u003e","country_iso2":"\u003cstring\u003e","postal_code":"\u003cstring\u003e"},"destination":{"id":"\u003cstring\u003e","country_iso2":"\u003cstring\u003e","postal_code":"\u003cstring\u003e"},"remittance_info":[{"entity":"DELIVERY_PARTNER","type":"DELIVERY_FEE","amount":{"amount_e5":"\u003cnumber\u003e","currency_code":"\u003cstring\u003e","formatted":"\u003cstring\u003e"}}]}},"is_order_accuracy_risk":"\u003cboolean\u003e","store_instructions":"\u003cstring\u003e","preparation_time":{"ready_for_pickup_time_secs":"\u003cinteger\u003e","source":"PREDICTED_BY_UBER","ready_for_pickup_time":"\u003cdate\u003e"},"completed_time":"\u003cdate\u003e","eligible_actions":{"adjust_ready_for_pickup_time":{"is_eligible":"\u003cboolean\u003e","reason":"\u003cstring\u003e"},"mark_out_of_item":{"is_eligible":"\u003cboolean\u003e","reason":"\u003cstring\u003e"},"cancel":{"is_eligible":"\u003cboolean\u003e","reason":"\u003cstring\u003e"},"mark_cannot_fulfill":{"is_eligible":"\u003cboolean\u003e","reason":"\u003cstring\u003e"},"adjust_etd_time":{"is_eligible":"\u003cboolean\u003e","reason":"\u003cstring\u003e"},"customer_request_etd":{"is_eligible":"\u003cboolean\u003e","reason":"\u003cstring\u003e"}},"failure_info":{"reason":"ACCEPT_TIMED_OUT","failure_attributed_to_party":"MERCHANT","will_merchant_be_paid":"\u003cboolean\u003e","description":"\u003cstring\u003e"},"created_time":"\u003cstring\u003e","has_membership_pass":"\u003cboolean\u003e","retailer_loyalty_info":{"loyalty_number":"\u003cstring\u003e"}}],"pagination_data":{"next_page_token":"\u003cstring\u003e","page_size":"\u003cnumber\u003e"}}