List Orders
curl --request GET \
--url https://production-api.puppetvendors.com/orders \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/orders"
headers = {"x-access-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};
fetch('https://production-api.puppetvendors.com/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://production-api.puppetvendors.com/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-access-token: <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://production-api.puppetvendors.com/orders"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-access-token", "<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://production-api.puppetvendors.com/orders")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'
response = http.request(request)
puts response.read_bodyOrders
List Orders
Retrieve vendor-scoped orders with cursor-based pagination
GET
/
orders
List Orders
curl --request GET \
--url https://production-api.puppetvendors.com/orders \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/orders"
headers = {"x-access-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};
fetch('https://production-api.puppetvendors.com/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://production-api.puppetvendors.com/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-access-token: <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://production-api.puppetvendors.com/orders"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-access-token", "<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://production-api.puppetvendors.com/orders")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'
response = http.request(request)
puts response.read_bodyV2 Alpha — This endpoint is part of the V2 API preview. Breaking changes may occur.
Overview
Retrieve a paginated list of orders scoped to the authenticated vendor. Only orders containing line items belonging to the vendor are returned. Results include order totals, customer info, and fulfillment status for each order.Vendor Token Required — This endpoint requires a vendor-scoped JWT token. Merchant tokens will receive a 403 error.
Use Cases
- Vendor order dashboards — Display a vendor’s recent order activity
- Order sync — Pull vendor orders into an external OMS or ERP system
- Reporting — Build custom reports on vendor sales and fulfillment
Query Parameters
Filter by financial status. One of:
pending, authorized, paid, partially_paid, refunded, voided, partially_refunded.Response
200
{
"success": true,
"data": {
"orders": [
{
"_id": "507f1f77bcf86cd799439013",
"orderId": 5123456789,
"orderNumber": 1042,
"orderName": "#1042",
"customer": {
"email": "customer@example.com",
"firstName": "Jane",
"lastName": "Doe"
},
"totalSales": 279.99,
"totalPayout": 240.79,
"fulfillmentStatus": "fulfilled",
"createdAt": "2024-06-15T10:30:00.000Z"
}
],
"totalCount": 150,
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMyJ9",
"endCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAyMCJ9"
}
}
}
Example
curl -X GET "https://production-api.puppetvendors.com/orders?first=20&status=paid" \
-H "x-access-token: YOUR_VENDOR_JWT_TOKEN"
More Examples
Filter by date range and statuscurl -X GET "https://production-api.puppetvendors.com/orders?first=20&startDate=2026-05-01T00:00:00Z&endDate=2026-05-31T23:59:59Z&status=pending" \
-H "x-access-token: YOUR_VENDOR_JWT_TOKEN"
curl -X GET "https://production-api.puppetvendors.com/orders?first=10&search=blue+t-shirt&vendorPayoutStatus=unpaid&sortBy=totalSales&sortOrder=desc" \
-H "x-access-token: YOUR_VENDOR_JWT_TOKEN"
Was this page helpful?