curl --request GET \
--url https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders \
--header 'x-api-key: <api-key>'import requests
url = "https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://apiv2.gomarketbox.com/v1/projects/{projectId}/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://apiv2.gomarketbox.com/v1/projects/{projectId}/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://apiv2.gomarketbox.com/v1/projects/{projectId}/orders"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"projectId": "<string>",
"tenantId": "<string>",
"orderId": "<string>",
"clientId": "<string>",
"currency": "<string>",
"subtotal": {
"amount": 1,
"currency": "<string>"
},
"tax": {
"amount": 1,
"currency": "<string>"
},
"total": {
"amount": 1,
"currency": "<string>"
},
"amountPaid": {
"amount": 1,
"currency": "<string>"
},
"amountRefunded": {
"amount": 1,
"currency": "<string>"
},
"status": "DRAFT",
"statusUpdatedAt": "2023-11-07T05:31:56Z",
"deleted": true,
"version": 1,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedBy": "<string>",
"feeTotal": {
"amount": 1,
"currency": "<string>"
},
"cancellationReason": "<string>",
"cancelledBy": "<string>",
"paymentMethod": "STRIPE",
"settledAt": "2023-11-07T05:31:56Z",
"amountComped": {
"amount": 1,
"currency": "<string>"
},
"pricingRegion": {
"country": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"locale": "<string>",
"attribution": {
"searchId": "srch_01k7q3x9h4e8rb2d6m0z5a7c1n",
"sessionKey": "sess-example-01",
"surface": "results"
}
}
],
"nextCursor": "<string>"
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}List orders by status, by payment method, or every order in a date range
Exactly one listing mode per request, chosen by which filter you send:
status— orders in that status, narrowed bystartCreatedAt/endCreatedAt.paymentMethod— how orders were settled (STRIPE,CASH,EXTERNAL,COMP,MIXED,LEGACY), narrowed bystartSettledAt/endSettledAt. This is the reconciliation read: “what did we take in cash last month”.- neither — every order, narrowed by
startCreatedAt/endCreatedAt.
Sending both status and paymentMethod is a 400, as is a date range belonging to the other mode (startSettledAt without paymentMethod, or startCreatedAt with it) — each index carries only one date, so the pairing is not a preference.
⚠️ The no-filter mode reads an index whose key attributes are written only when an order is created, so every order created before this feature shipped, and every order migrated from MarketBox v1, is MISSING from it until a backfill runs. An empty or short page there does not mean the project has no orders — list by status when you need completeness over historical data.
Paginate with limit and cursor; nextCursor: null is the last page. A cursor belongs to the filter set that minted it — replaying one after switching listing mode is rejected with a 400 BAD_REQUEST (“Invalid cursor”) rather than silently returning the wrong page, so start a fresh request instead. To list one client’s orders, use GET /projects/{projectId}/clients/{clientId}/orders.
curl --request GET \
--url https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders \
--header 'x-api-key: <api-key>'import requests
url = "https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://apiv2.gomarketbox.com/v1/projects/{projectId}/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://apiv2.gomarketbox.com/v1/projects/{projectId}/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://apiv2.gomarketbox.com/v1/projects/{projectId}/orders"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.gomarketbox.com/v1/projects/{projectId}/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"projectId": "<string>",
"tenantId": "<string>",
"orderId": "<string>",
"clientId": "<string>",
"currency": "<string>",
"subtotal": {
"amount": 1,
"currency": "<string>"
},
"tax": {
"amount": 1,
"currency": "<string>"
},
"total": {
"amount": 1,
"currency": "<string>"
},
"amountPaid": {
"amount": 1,
"currency": "<string>"
},
"amountRefunded": {
"amount": 1,
"currency": "<string>"
},
"status": "DRAFT",
"statusUpdatedAt": "2023-11-07T05:31:56Z",
"deleted": true,
"version": 1,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedBy": "<string>",
"feeTotal": {
"amount": 1,
"currency": "<string>"
},
"cancellationReason": "<string>",
"cancelledBy": "<string>",
"paymentMethod": "STRIPE",
"settledAt": "2023-11-07T05:31:56Z",
"amountComped": {
"amount": 1,
"currency": "<string>"
},
"pricingRegion": {
"country": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"locale": "<string>",
"attribution": {
"searchId": "srch_01k7q3x9h4e8rb2d6m0z5a7c1n",
"sessionKey": "sess-example-01",
"surface": "results"
}
}
],
"nextCursor": "<string>"
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}{
"code": "NOT_FOUND",
"message": "Booking not found",
"statusCode": 404,
"requestId": "a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10"
}Authorizations
API key minted in the MarketBox dashboard. Scope is restricted to the projects you select at creation time. Every route needs the key's standard API access (*) except POST /v1/projects/{projectId}/events, which needs events:write; a key without * is refused with 403 CAPABILITY_NOT_GRANTED.
Path Parameters
Query Parameters
List by how the order was settled. This mode reads a settled-date index, so pair it with startSettledAt/endSettledAt and never with the created-date parameters. Only settled orders carry a payment method, so DRAFT and PENDING orders never appear in this mode; a settled order later CANCELLED (refunded or not) still does, with its status. Mutually exclusive with status.
STRIPE, CASH, EXTERNAL, COMP, MIXED, LEGACY "CASH"
Maximum rows to return in data, 1–200. Defaults to 50. Values outside the range return 400. A page can still hold fewer rows than requested, so treat nextCursor: null as the only end-of-results signal and never stop on a page that merely looks short.
1 <= x <= 20050