Skip to main content
GET
/
v1
/
orders
/
test
List test orders
curl --request GET \
  --url http://localhost:3000/v1/orders/test
import requests

url = "http://localhost:3000/v1/orders/test"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('http://localhost:3000/v1/orders/test', 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/test",
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/test"

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/test")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v1/orders/test")

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>",
      "display_id": 123,
      "deleted_at": "<string>"
    }
  ],
  "total": 123
}

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 500
offset
integer | null
default:0
Required range: x >= 0
status
string
rfc_status
enum<string>

Filter by RFC fulfillment status

Available options:
received,
reserved,
picking,
sweep_hold,
staged,
fulfilling,
arrived,
completed
customer_id
string<uuid>
date
string

Filter by single date (YYYY-MM-DD), use start_date/end_date for ranges

start_date
string

Start date for date range filter (YYYY-MM-DD)

end_date
string

End date for date range filter (YYYY-MM-DD)

q
string

Search by order number or email

Response

200 - application/json

List of test orders

orders
object[]
required
total
number
required