List orders with filtering and pagination
curl --request GET \
--url http://localhost:3000/v1/ordersimport requests
url = "http://localhost:3000/v1/orders"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:3000/v1/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v1/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 := "http://localhost:3000/v1/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("http://localhost:3000/v1/orders")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v1/orders")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"orders": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_number": "<string>",
"status": "<string>",
"total_amount": 123,
"payment_status": "<string>",
"payment_method": "<string>",
"order_cutoff_time": "<string>",
"estimated_pickup_time": "<string>",
"actual_pickup_time": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>",
"source": "<string>",
"currency_code": "<string>",
"email": "<string>",
"fulfillment_status": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"full_name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sellable_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"unit_price": 123,
"fulfilled_quantity": 123,
"shipped_quantity": 123,
"is_tax_inclusive": true,
"return_requested_quantity": 123,
"return_received_quantity": 123,
"return_dismissed_quantity": 123,
"written_off_quantity": 123,
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"brand": "<string>",
"image_url": "<string>"
}
}
],
"item_count": 123,
"display_id": 123,
"deleted_at": "<string>"
}
],
"total": 123
}Orders
List orders with filtering and pagination
Returns a paginated list of orders with customer and item details.
GET
/
v1
/
orders
List orders with filtering and pagination
curl --request GET \
--url http://localhost:3000/v1/ordersimport requests
url = "http://localhost:3000/v1/orders"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:3000/v1/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v1/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 := "http://localhost:3000/v1/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("http://localhost:3000/v1/orders")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v1/orders")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"orders": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_number": "<string>",
"status": "<string>",
"total_amount": 123,
"payment_status": "<string>",
"payment_method": "<string>",
"order_cutoff_time": "<string>",
"estimated_pickup_time": "<string>",
"actual_pickup_time": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>",
"source": "<string>",
"currency_code": "<string>",
"email": "<string>",
"fulfillment_status": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"full_name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sellable_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"unit_price": 123,
"fulfilled_quantity": 123,
"shipped_quantity": 123,
"is_tax_inclusive": true,
"return_requested_quantity": 123,
"return_received_quantity": 123,
"return_dismissed_quantity": 123,
"written_off_quantity": 123,
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"brand": "<string>",
"image_url": "<string>"
}
}
],
"item_count": 123,
"display_id": 123,
"deleted_at": "<string>"
}
],
"total": 123
}Query Parameters
Required range:
1 <= x <= 500Required range:
x >= 0Filter by RFC fulfillment status
Available options:
received, reserved, picking, sweep_hold, staged, fulfilling, arrived, completed Filter by single date (YYYY-MM-DD), use start_date/end_date for ranges
Start date for date range filter (YYYY-MM-DD)
End date for date range filter (YYYY-MM-DD)
Search by order number or email
⌘I