List All Orders
curl --request GET \
--url 'https://api.example.com/{{micro_service_base_url}}/orders/'import requests
url = "https://api.example.com/{{micro_service_base_url}}/orders/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/{{micro_service_base_url}}/orders/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/{{micro_service_base_url}}/orders/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/{{micro_service_base_url}}/orders/"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/{{micro_service_base_url}}/orders/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/{{micro_service_base_url}}/orders/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"orders": [
{
"id": "<string>",
"original_subtotal": "<string>",
"tax_amount": "<string>",
"discount": "<string>",
"original_price": "<string>",
"createdAt": "<string>",
"partner": "<string>",
"special_instructions": "<string>",
"exclude_allergens_items": "<string>",
"is_include_disposables": true,
"store_id": "<string>",
"dsp_order_number": "<string>",
"customer": {},
"fulfillments": [
{}
],
"orderItems": [
{}
]
}
]
}Orders
List All Orders
Retrieve a comprehensive list of all orders for a specific store with filtering capabilities by status and other criteria.
GET
{micro_service_base_url}
/
orders
/
List All Orders
curl --request GET \
--url 'https://api.example.com/{{micro_service_base_url}}/orders/'import requests
url = "https://api.example.com/{{micro_service_base_url}}/orders/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/{{micro_service_base_url}}/orders/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/{{micro_service_base_url}}/orders/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/{{micro_service_base_url}}/orders/"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/{{micro_service_base_url}}/orders/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/{{micro_service_base_url}}/orders/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"orders": [
{
"id": "<string>",
"original_subtotal": "<string>",
"tax_amount": "<string>",
"discount": "<string>",
"original_price": "<string>",
"createdAt": "<string>",
"partner": "<string>",
"special_instructions": "<string>",
"exclude_allergens_items": "<string>",
"is_include_disposables": true,
"store_id": "<string>",
"dsp_order_number": "<string>",
"customer": {},
"fulfillments": [
{}
],
"orderItems": [
{}
]
}
]
}This endpoint provides access to all orders for a specified store, allowing you to filter by various criteria such as order status. It returns the same detailed order information as the incoming orders endpoint but with broader filtering options.
This endpoint is ideal for building comprehensive order management dashboards and reporting systems.
Query Parameters
string
required
Filter orders by their current status
Available Status Values
Available Status Values
- incoming: New orders waiting for acceptance
- accepted: Orders confirmed by store
- preparing: Orders being prepared
- ready: Orders ready for pickup
- completed: Successfully delivered orders
- cancelled: Cancelled orders
- denied: Orders rejected by store
string
required
The unique identifier of the store to retrieve orders for
Response
array
Array of order objects matching the specified criteria
Show Order Object Structure
Show Order Object Structure
string
Unique order identifier
string
Order subtotal before taxes and additional fees
string
Total tax applied to the order
string
Discount amount applied (null if no discount)
string
Final order total including all fees and taxes
string
Timestamp when the order was created
string
Name of the delivery service platform
string
Customer-provided special instructions for the order
string
Allergen exclusion requests (null if none)
boolean
Whether disposable items should be included
string
Store identifier processing this order
string
Order number from the delivery service platform
object
Customer contact and identification information
array
Complete fulfillment tracking with status logs and employee actions
array
Detailed list of all items in the order with pricing and specifications
Response Example
[
{
"id": "8f40ba13-3290-496c-b08c-50e3110200d5",
"original_subtotal": "393.00",
"tax_amount": "9.77",
"discount": null,
"original_price": "393.13",
"createdAt": "2023-05-24T18:15:24.638Z",
"partner": "DoorDash",
"special_instructions": "",
"exclude_allergens_items": null,
"is_include_disposables": null,
"store_id": "449235c1-3d04-4519-998b-40d2a621e5e0",
"dsp_order_number": "",
"customer": {
"customer_name": "Lula D",
"contact_phone": "8559731040",
"phone_code": null
},
"fulfillments": [
{
"quantity": null,
"date_ready": "2023-05-24T18:18:26.992Z",
"createdAt": "2023-05-24T18:15:24.715Z",
"estimated_date_delivered": "2023-05-24T18:31:14.618Z",
"id": "5afe3291-c252-4e20-94f7-71d9c3587484",
"store_id": "449235c1-3d04-4519-998b-40d2a621e5e0",
"fulfillmentStatus": {
"delivery_status_name": "completed"
},
"fulfillmentsLogs": [
{
"date_created": "2023-05-24T18:15:24.722Z",
"description": "DoorDash store mock order received",
"order_status_title": "Order received",
"fulfillments_id": "5afe3291-c252-4e20-94f7-71d9c3587484",
"employee": null
},
{
"date_created": "2023-05-24T18:16:14.685Z",
"description": "",
"order_status_title": "Bagging order",
"fulfillments_id": "5afe3291-c252-4e20-94f7-71d9c3587484",
"employee": {
"id": "870a05c1-bbbf-48ab-a757-e28ae0a2b2a8",
"first_name": "Philip T",
"last_name": "white house "
}
}
]
}
],
"orderItems": [
{
"id": "77aab9bd-5543-4783-8e37-d2e9a29a00cf",
"quantity": 3,
"special_instructions": "",
"store_item_price": "100.00",
"store_item_total_price": "300.00",
"store_item_name": "Test 123",
"store_item_description": "",
"store_item_category": "Candy",
"item": {
"images": null,
"name": "Test 123",
"description": "",
"upc": null,
"categories": [
{
"id": "3c185006-271c-4d1e-903f-de21ec3b4234",
"name": "Alcohol"
}
]
}
}
]
}
]
Use different status filters to create targeted views for different operational needs - “incoming” for new order alerts, “completed” for revenue tracking.
The fulfillmentsLogs array provides a complete audit trail of all actions taken on the order, including which employee performed each action.
Large date ranges with no status filtering may return substantial amounts of data. Consider implementing pagination for high-volume stores.
⌘I