Get Orders
GET {{BASE_HABITAT_URL}}/api/v3/orders?limit=10&page=1
Required scope: orders:read
Returns a paginated list of orders for your operator.
Use this endpoint for programmatic order reads and reconciliation. For exports, prefer the async Create Order Export flow instead of passing format here.
Authentication
Section titled “Authentication”Requires admin, partner, or vendor role.
Query parameters
Section titled “Query parameters”| Parameter | Optional | Description |
|---|---|---|
limit |
Yes (default 20) | Page size. Max 250 in production. |
page |
Yes (default 0) | Page offset. |
since |
Yes | ISO8601 date — filter by created date. |
search |
Yes | Free-text search. |
filters |
Yes | JSON object with territories, status, date range, provider, partner, order source, runner, merchant, etc. |
sorting |
Yes | { "id": "created_at", "desc": true } |
active |
Yes | When true, limits to active orders. |
global |
Yes | Cross-operator list (master root operator only). |
format |
Yes | Legacy. If set to csv, json, or xlsx, returns a synchronous inline export instead of paginated JSON. See Export Orders (Legacy). |
Related endpoints
Section titled “Related endpoints”- Create Order Export — recommended async export for large datasets.
- Export Orders (Legacy) — synchronous
GET /v3/orders?format=export.
Examples
Section titled “Examples”curl --request GET '${BASE_HABITAT_URL}/api/v3/orders?limit=10&page=1'const response = await fetch("${BASE_HABITAT_URL}/api/v3/orders?limit=10&page=1", { "method": "GET", "headers": {}})const data = await response.json()import requests
response = requests.request( "GET", "${BASE_HABITAT_URL}/api/v3/orders?limit=10&page=1", headers={},)response.raise_for_status()Saved responses
Section titled “Saved responses”{ "type": "success", "data": [ { "id": "04391c00-49a0-11ed-bc25-1dc13eb202d3", "quote_id": "0437bc70-49a0-11ed-bc25-1dc13eb202d3", "external_order_id": "04070f80-49a0-11ed-bc25-1dc13eb202d3", "external_order_reference": null, "dsps_delivery_id": null, "_request_id": null, "dsps_name": null, "created_at": "2022-10-11T20:05:13.275Z", "status": "pending_assign", "method": "Delivery", "timezone": "America/Chicago", "partner_name": "snackpass", "pickup_name": "Adalina", "pickup_address": "912 N State St, Chicago, IL 60610, USA", "pickup_phone": "13128209000", "pickup_instructions": null, "pickup_lat": 41.8996995, "pickup_lng": -87.62853129999999, "dropoff_lat": 41.9270754, "dropoff_lng": -87.6306663, "route_distance_miles": 2.48, "crow_flies_distance_miles": 1.89, "dropoff_address": "2401 N Lake Shore Dr, Chicago, IL 60614", "dropoff_suite": null, "dropoff_instructions": "Veniam est sit rerum consequuntur minus et assumenda.", "customer_name": "Elenor Kihn", "customer_phone": "530-350-3620 x4223", "payment_type": "prepaid", "pickup_estimate": "2022-10-11T20:20:12.956Z", "dropoff_estimate": "2022-10-11T20:50:12.956Z", "runner_assigned_at": null, "runner_accepted_at": null, "runner_arrived_origin": null, "runner_picked_up": null, "runner_arrived_dropoff": null, "runner_dropped_off": null, "cancelled_at": null, "contents": null, "tip": null, "order_total": null, "runner": null, "merchant_id": "a42ff9d1-a7cb-11ec-b378-45e05d0a54f7", "runner_id": null, "skip_routing_strategy": false, "diner_delivery_fee": null, "runner_commission": 5, "billable_merchant_fee": null, "dsps_delivery_fee": null }, { "id": "04045060-49a0-11ed-bc25-1dc13eb202d3", "quote_id": "04007fd0-49a0-11ed-bc25-1dc13eb202d3", "external_order_id": "03d30732-49a0-11ed-bc25-1dc13eb202d3", "external_order_reference": null, "dsps_delivery_id": null, "_request_id": null, "dsps_name": null, "created_at": "2022-10-11T20:05:12.914Z", "status": "pending_assign", "method": "Delivery", "timezone": "America/Chicago", "partner_name": "lezzoo", "pickup_name": "Dog Haus", "pickup_address": "205 W Wacker Dr, Chicago, IL 60606, USA", "pickup_phone": "13125668081", "pickup_instructions": null, "pickup_lat": 41.8864436, "pickup_lng": -87.6342963, "dropoff_lat": 41.9215739, "dropoff_lng": -87.65305230000001, "route_distance_miles": 4.25, "crow_flies_distance_miles": 2.61, "dropoff_address": "953 W Webster Ave, Chicago, IL 60614", "dropoff_suite": null, "dropoff_instructions": "Minus perspiciatis reiciendis vitae error.", "customer_name": "Bryana Fahey", "customer_phone": "606-232-7632 x34256", "payment_type": "cash", "pickup_estimate": "2022-10-11T20:15:12.616Z", "dropoff_estimate": "2022-10-11T20:29:31.616Z", "runner_assigned_at": null, "runner_accepted_at": null, "runner_arrived_origin": null, "runner_picked_up": null, "runner_arrived_dropoff": null, "runner_dropped_off": null, "cancelled_at": null, "contents": null, "tip": null, "order_total": null, "runner": null, "merchant_id": "b6cb28d1-a7cb-11ec-b378-45e05d0a54f7", "runner_id": null, "skip_routing_strategy": false, "diner_delivery_fee": null, "runner_commission": 5, "billable_merchant_fee": null, "dsps_delivery_fee": null }, { "id": "03d0bd40-49a0-11ed-bc25-1dc13eb202d3", "quote_id": "03cc9e90-49a0-11ed-bc25-1dc13eb202d3", "external_order_id": "039f25f2-49a0-11ed-bc25-1dc13eb202d3", "external_order_reference": null, "dsps_delivery_id": null, "_request_id": null, "dsps_name": null, "created_at": "2022-10-11T20:05:12.575Z", "status": "pending_assign", "method": "Delivery", "timezone": "America/Chicago", "partner_name": "truckbux", "pickup_name": "The Cumin Bowl", "pickup_address": "831 N Sedgwick St, Chicago, IL 60610, USA", "pickup_phone": "17086287803", "pickup_instructions": null, "pickup_lat": 41.8973543, "pickup_lng": -87.6385033, "dropoff_lat": 41.9285718, "dropoff_lng": -87.6420413, "route_distance_miles": 2.35, "crow_flies_distance_miles": 2.16, "dropoff_address": "2521 N Clark St, Chicago, IL 60614", "dropoff_suite": null, "dropoff_instructions": "Omnis magni nihil ullam nesciunt optio ut et voluptatibus nostrum.", "customer_name": "Mittie Walsh", "customer_phone": "638-423-4323 x303", "payment_type": "catering", "pickup_estimate": "2022-10-11T20:25:12.276Z", "dropoff_estimate": "2022-10-11T20:37:42.276Z", "runner_assigned_at": null, "runner_accepted_at": null, "runner_arrived_origin": null, "runner_picked_up": null, "runner_arrived_dropoff": null, "runner_dropped_off": null, "cancelled_at": null, "contents": null, "tip": null, "order_total": null, "runner": null, "merchant_id": "9a3a6281-a7cb-11ec-b378-45e05d0a54f7", "runner_id": null, "skip_routing_strategy": false, "diner_delivery_fee": null, "runner_commission": 5, "billable_merchant_fee": null, "dsps_delivery_fee": null }, { "id": "039c66d0-49a0-11ed-bc25-1dc13eb202d3", "quote_id": "03982110-49a0-11ed-bc25-1dc13eb202d3", "external_order_id": "03730ce2-49a0-11ed-bc25-1dc13eb202d3", "external_order_reference": null, "dsps_delivery_id": null, "_request_id": null, "dsps_name": null, "created_at": "2022-10-11T20:05:12.229Z", "status": "pending_assign", "method": "Delivery", "timezone": "America/Chicago", "partner_name": "olo", "pickup_name": "Small Cheval - Wells", "pickup_address": "1345 N Wells St, Chicago, IL 60610, USA", "pickup_phone": "13128373860", "pickup_instructions": null, "pickup_lat": 41.9070414, "pickup_lng": -87.63400759999999, "dropoff_lat": 41.9328061, "dropoff_lng": -87.6550469, "route_distance_miles": 2.28, "crow_flies_distance_miles": 2.08, "dropoff_address": "1028 W Diversey Pkwy, Chicago, IL 60614", "dropoff_suite": null, "dropoff_instructions": "Quod deserunt tempora hic facilis.", "customer_name": "Anjali Jacobs", "customer_phone": "736.355.2731", "payment_type": "cash", "pickup_estimate": "2022-10-11T20:35:11.988Z", "dropoff_estimate": "2022-10-11T20:48:28.988Z", "runner_assigned_at": null, "runner_accepted_at": null, "runner_arrived_origin": null, "runner_picked_up": null, "runner_arrived_dropoff": null, "runner_dropped_off": null, "cancelled_at": null, "contents": null, "tip": null, "order_total": null, "runner": null, "merchant_id": "96252861-a7cb-11ec-b378-45e05d0a54f7", "runner_id": null, "skip_routing_strategy": false, "diner_delivery_fee": null, "runner_commission": 5, "billable_merchant_fee": null, "dsps_delivery_fee": null }, { "id": "036fffa0-49a0-11ed-bc25-1dc13eb202d3", "quote_id": "036b44b0-49a0-11ed-bc25-1dc13eb202d3", "external_order_id": "033e6852-49a0-11ed-bc25-1dc13eb202d3", "external_order_reference": null, "dsps_delivery_id": null, "_request_id": null, "dsps_name": null, "created_at": "2022-10-11T20:05:11.937Z", "status": "pending_assign", "method": "Delivery", "timezone": "America/Chicago", "partner_name": "eat24", "pickup_name": "Gussie's Handmade Italian", "pickup_address": "227 W North Ave, Chicago, IL 60610, USA", "pickup_phone": "13129293091", "pickup_instructions": null, "pickup_lat": 41.91085409999999, "pickup_lng": -87.6359523, "dropoff_lat": 41.9260399, "dropoff_lng": -87.6404781, "route_distance_miles": 1.21, "crow_flies_distance_miles": 1.07, "dropoff_address": "2413-15 N Clark St, Chicago, IL 60614", "dropoff_suite": null, "dropoff_instructions": "Quas nesciunt dolor explicabo sequi qui.", "customer_name": "Jairo Watsica", "customer_phone": "360-375-4401 x9328", "payment_type": "online", "pickup_estimate": "2022-10-11T20:35:11.642Z", "dropoff_estimate": "2022-10-11T20:41:54.642Z", "runner_assigned_at": null, "runner_accepted_at": null, "runner_arrived_origin": null, "runner_picked_up": null, "runner_arrived_dropoff": null, "runner_dropped_off": null, "cancelled_at": null, "contents": null, "tip": null, "order_total": null, "runner": null, "merchant_id": "921bfc31-a7cb-11ec-b378-45e05d0a54f7", "runner_id": null, "skip_routing_strategy": false, "diner_delivery_fee": null, "runner_commission": 5, "billable_merchant_fee": null, "dsps_delivery_fee": null }, { "id": "033b8220-49a0-11ed-bc25-1dc13eb202d3", "quote_id": "03376370-49a0-11ed-bc25-1dc13eb202d3", "external_order_id": "02fbe112-49a0-11ed-bc25-1dc13eb202d3", "external_order_reference": null, "dsps_delivery_id": null, "_request_id": null, "dsps_name": null, "created_at": "2022-10-11T20:05:11.595Z", "status": "pending_assign", "method": "Delivery", "timezone": "America/Chicago", "partner_name": "ninjas", "pickup_name": "Foxtrot", "pickup_address": "23 W Maple St, Chicago, IL 60610, USA", "pickup_phone": "13129293175", "pickup_instructions": null, "pickup_lat": 41.9016397, "pickup_lng": -87.62929319999999, "dropoff_lat": 41.9263409, "dropoff_lng": -87.64946049999999, "route_distance_miles": 2.44, "crow_flies_distance_miles": 2, "dropoff_address": "2429 N Lincoln Ave, Chicago, IL 60614", "dropoff_suite": null, "dropoff_instructions": "A ut qui totam quasi consequuntur autem doloribus porro animi.", "customer_name": "Porter Wuckert", "customer_phone": "746-790-8774 x075", "payment_type": "cash", "pickup_estimate": "2022-10-11T20:25:11.206Z", "dropoff_estimate": "2022-10-11T20:39:11.206Z", "runner_assigned_at": null, "runner_accepted_at": null, "runner_arrived_origin": null, "runner_picked_up": null, "runner_arrived_dropoff": null, "runner_dropped_off": null, "cancelled_at": null, "contents": null, "tip": null, "order_total": null, "runner": null, "merchant_id": "84d453b1-a7cb-11ec-b378-45e05d0a54f7", "runner_id": null, "skip_routing_strategy": false, "diner_delivery_fee": null, "runner_commission": 5, "billable_merchant_fee": null, "dsps_delivery_fee": null }, { "id": "02f8fae0-49a0-11ed-bc25-1dc13eb202d3", "quote_id": "02f4b520-49a0-11ed-bc25-1dc13eb202d3", "external_order_id": "02c76392-49a0-11ed-bc25-1dc13eb202d3", "external_order_reference": null, "dsps_delivery_id": null, "_request_id": null, "dsps_name": null, "created_at": "2022-10-11T20:05:11.158Z", "status": "pending_assign", "method": "Delivery", "timezone": "America/Chicago", "partner_name": "olo", "pickup_name": "Roots Handmade Pizza - Chicago", "pickup_address": "1610 N Wells St, Chicago, IL 60610, USA", "pickup_phone": "13122107788", "pickup_instructions": null, "pickup_lat": 41.9115057, "pickup_lng": -87.6350113, "dropoff_lat": 41.9328061, "dropoff_lng": -87.6550469, "route_distance_miles": 1.93, "crow_flies_distance_miles": 1.8, "dropoff_address": "1028 W Diversey Pkwy, Chicago, IL 60614", "dropoff_suite": null, "dropoff_instructions": "Ipsum ad nemo est.", "customer_name": "Josephine Ondricka", "customer_phone": "899-981-2468", "payment_type": "cash", "pickup_estimate": "2022-10-11T20:45:10.863Z", "dropoff_estimate": "2022-10-11T20:55:37.863Z", "runner_assigned_at": null, "runner_accepted_at": null, "runner_arrived_origin": null, "runner_picked_up": null, "runner_arrived_dropoff": null, "runner_dropped_off": null, "cancelled_at": null, "contents": null, "tip": null, "order_total": null, "runner": null, "merchant_id": "a567b681-a7cb-11ec-b378-45e05d0a54f7", "runner_id": null, "skip_routing_strategy": false, "diner_delivery_fee": null, "runner_commission": 5, "billable_merchant_fee": null, "dsps_delivery_fee": null }, { "id": "02c45650-49a0-11ed-bc25-1dc13eb202d3", "quote_id": "02bfc270-49a0-11ed-bc25-1dc13eb202d3", "external_order_id": "029249d2-49a0-11ed-bc25-1dc13eb202d3", "external_order_reference": null, "dsps_delivery_id": null, "_request_id": null, "dsps_name": null, "created_at": "2022-10-11T20:05:10.812Z", "status": "pending_assign", "method": "Delivery", "timezone": "America/Chicago", "partner_name": "doordash", "pickup_name": "Alpana", "pickup_address": "831 N State St, Chicago, IL 60610, USA", "pickup_phone": "0", "pickup_instructions": null, "pickup_lat": 41.8978021, "pickup_lng": -87.62809299999999, "dropoff_lat": 41.9326381, "dropoff_lng": -87.64215779999999, "route_distance_miles": 3.15, "crow_flies_distance_miles": 2.51, "dropoff_address": "521 W Diversey Pkwy, Chicago, IL 60614", "dropoff_suite": null, "dropoff_instructions": "Est eligendi debitis nulla distinctio et reiciendis dolor.", "customer_name": "Ulises Rolfson", "customer_phone": "1-647-377-3852", "payment_type": "credit_card", "pickup_estimate": "2022-10-11T20:45:10.514Z", "dropoff_estimate": "2022-10-11T20:55:42.514Z", "runner_assigned_at": null, "runner_accepted_at": null, "runner_arrived_origin": null, "runner_picked_up": null, "runner_arrived_dropoff": null, "runner_dropped_off": null, "cancelled_at": null, "contents": null, "tip": null, "order_total": null, "runner": null, "merchant_id": "b8a259d1-a7cb-11ec-b378-45e05d0a54f7", "runner_id": null, "skip_routing_strategy": false, "diner_delivery_fee": null, "runner_commission": 5, "billable_merchant_fee": null, "dsps_delivery_fee": null }, { "id": "028f8ab0-49a0-11ed-bc25-1dc13eb202d3", "quote_id": "028be130-49a0-11ed-bc25-1dc13eb202d3", "external_order_id": "025cbae2-49a0-11ed-bc25-1dc13eb202d3", "external_order_reference": null, "dsps_delivery_id": null, "_request_id": null, "dsps_name": null, "created_at": "2022-10-11T20:05:10.473Z", "status": "pending_assign", "method": "Delivery", "timezone": "America/Chicago", "partner_name": "slice", "pickup_name": "Kababish - BBQ & Grill", "pickup_address": "1554 N Larrabee St, Chicago, IL 60610, USA", "pickup_phone": "13122184443", "pickup_instructions": null, "pickup_lat": 41.910499, "pickup_lng": -87.643648, "dropoff_lat": 41.9267767, "dropoff_lng": -87.6409888, "route_distance_miles": 1.45, "crow_flies_distance_miles": 1.13, "dropoff_address": "2447 N Clark St, Chicago, IL 60614", "dropoff_suite": null, "dropoff_instructions": "Ex aut sed.", "customer_name": "Ernesto Considine", "customer_phone": "(878) 616-1394 x8256", "payment_type": "cash", "pickup_estimate": "2022-10-11T20:35:10.165Z", "dropoff_estimate": "2022-10-11T20:42:33.165Z", "runner_assigned_at": null, "runner_accepted_at": null, "runner_arrived_origin": null, "runner_picked_up": null, "runner_arrived_dropoff": null, "runner_dropped_off": null, "cancelled_at": null, "contents": null, "tip": null, "order_total": null, "runner": null, "merchant_id": "85e94621-a7cb-11ec-b378-45e05d0a54f7", "runner_id": null, "skip_routing_strategy": false, "diner_delivery_fee": null, "runner_commission": 5, "billable_merchant_fee": null, "dsps_delivery_fee": null }, { "id": "02567950-49a0-11ed-bc25-1dc13eb202d3", "quote_id": "024fe9a0-49a0-11ed-bc25-1dc13eb202d3", "external_order_id": "0215c6d1-49a0-11ed-bc25-1dc13eb202d3", "external_order_reference": null, "dsps_delivery_id": null, "_request_id": null, "dsps_name": null, "created_at": "2022-10-11T20:05:10.084Z", "status": "pending_assign", "method": "Delivery", "timezone": "America/Chicago", "partner_name": "mealpal", "pickup_name": "Can't Believe It's Not Meat", "pickup_address": "1143 N Wells St, Chicago, IL 60610, USA", "pickup_phone": "13126249986", "pickup_instructions": null, "pickup_lat": 41.9034979, "pickup_lng": -87.6341384, "dropoff_lat": 41.9200798, "dropoff_lng": -87.6626182, "route_distance_miles": 2, "crow_flies_distance_miles": 1.86, "dropoff_address": "2142 N Clybourn Ave, Chicago, IL 60614", "dropoff_suite": null, "dropoff_instructions": "Aliquam enim molestiae.", "customer_name": "Krystal Thompson", "customer_phone": "885-265-7597", "payment_type": "online", "pickup_estimate": "2022-10-11T20:15:09.700Z", "dropoff_estimate": "2022-10-11T20:25:45.700Z", "runner_assigned_at": null, "runner_accepted_at": null, "runner_arrived_origin": null, "runner_picked_up": null, "runner_arrived_dropoff": null, "runner_dropped_off": null, "cancelled_at": null, "contents": null, "tip": null, "order_total": null, "runner": null, "merchant_id": "8e1f7a31-a7cb-11ec-b378-45e05d0a54f7", "runner_id": null, "skip_routing_strategy": false, "diner_delivery_fee": null, "runner_commission": 5, "billable_merchant_fee": null, "dsps_delivery_fee": null } ], "total": 108268}