Get Incoming Orders
curl --request GET \
--url 'https://api.example.com/{{orders_api_base_url}}/orders/'import requests
url = "https://api.example.com/{{orders_api_base_url}}/orders/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/{{orders_api_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/{{orders_api_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/{{orders_api_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/{{orders_api_base_url}}/orders/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/{{orders_api_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>",
"store_id": "<string>",
"dsp_order_number": "<string>",
"customer": {
"customer_name": "<string>",
"contact_phone": "<string>",
"phone_code": "<string>"
},
"fulfillments": [
{
"id": "<string>",
"date_ready": "<string>",
"estimated_date_delivered": "<string>",
"fulfillmentStatus": {
"delivery_status_name": "<string>"
},
"fulfillmentsLogs": [
{}
]
}
],
"orderItems": [
{
"id": "<string>",
"quantity": 123,
"special_instructions": "<string>",
"store_item_price": "<string>",
"store_item_total_price": "<string>",
"store_item_name": "<string>",
"store_item_description": "<string>",
"store_item_category": "<string>",
"item": {}
}
]
}
]
}Orders
Get Incoming Orders
Retrieve incoming orders for a specific store that are waiting for processing. This endpoint returns orders with their complete details including customer information, items, and fulfillment status.
GET
{orders_api_base_url}
/
orders
/
Get Incoming Orders
curl --request GET \
--url 'https://api.example.com/{{orders_api_base_url}}/orders/'import requests
url = "https://api.example.com/{{orders_api_base_url}}/orders/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/{{orders_api_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/{{orders_api_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/{{orders_api_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/{{orders_api_base_url}}/orders/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/{{orders_api_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>",
"store_id": "<string>",
"dsp_order_number": "<string>",
"customer": {
"customer_name": "<string>",
"contact_phone": "<string>",
"phone_code": "<string>"
},
"fulfillments": [
{
"id": "<string>",
"date_ready": "<string>",
"estimated_date_delivered": "<string>",
"fulfillmentStatus": {
"delivery_status_name": "<string>"
},
"fulfillmentsLogs": [
{}
]
}
],
"orderItems": [
{
"id": "<string>",
"quantity": 123,
"special_instructions": "<string>",
"store_item_price": "<string>",
"store_item_total_price": "<string>",
"store_item_name": "<string>",
"store_item_description": "<string>",
"store_item_category": "<string>",
"item": {}
}
]
}
]
}This endpoint retrieves all incoming orders for a specified store. It includes comprehensive order details, customer information, order items, and fulfillment tracking information.
Incoming orders represent new orders that have been received from delivery platforms and are waiting for store confirmation and processing.
Query Parameters
string
required
The unique identifier of the store to retrieve orders for
string
default:"completed"
Filter orders by status. Common values: “incoming”, “accepted”, “completed”, “cancelled”
Response
array
Array of order objects with complete details
Show Order Object
Show Order Object
string
Unique order identifier
string
Order subtotal before taxes and fees
string
Tax amount for the order
string
Applied discount amount (null if no discount)
string
Total order price including tax
string
Order creation timestamp
string
Delivery platform name (e.g., “DoorDash”, “UberEats”)
string
Customer-provided special instructions
string
Store identifier for this order
string
Delivery platform’s order number
object
array
array
Array of items in the order
Show Order Item Object
Show Order Item Object
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": "",
"store_id": "449235c1-3d04-4519-998b-40d2a621e5e0",
"customer": {
"customer_name": "Lula D",
"contact_phone": "8559731040",
"phone_code": null
},
"fulfillments": [
{
"id": "5afe3291-c252-4e20-94f7-71d9c3587484",
"date_ready": "2023-05-24T18:18:26.992Z",
"estimated_date_delivered": "2023-05-24T18:31:14.618Z",
"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",
"employee": null
}
]
}
],
"orderItems": [
{
"id": "77aab9bd-5543-4783-8e37-d2e9a29a00cf",
"quantity": 3,
"store_item_price": "100.00",
"store_item_total_price": "300.00",
"store_item_name": "Test 123",
"store_item_category": "Candy"
}
]
}
]
Use this endpoint to build real-time order dashboards and notify staff when new orders arrive.
The fulfillments array contains detailed tracking information showing the complete order journey from receipt to delivery.
⌘I

