Get Order
curl --request GET \
--url https://production-api.puppetvendors.com/orders/{orderId} \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/orders/{orderId}"
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/{orderId}', 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/{orderId}",
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/{orderId}"
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/{orderId}")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/orders/{orderId}")
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
Get Order
Retrieve a single order with vendor-scoped line items
GET
/
orders
/
{orderId}
Get Order
curl --request GET \
--url https://production-api.puppetvendors.com/orders/{orderId} \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/orders/{orderId}"
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/{orderId}', 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/{orderId}",
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/{orderId}"
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/{orderId}")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/orders/{orderId}")
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 detailed information for a single order, scoped to the authenticated vendor. The response includes only line items belonging to the vendor and indicates vendor scoping via theisVendorScoped flag. The orderId parameter accepts either a MongoDB ObjectId or a numeric Shopify order ID.
Vendor Token Required — This endpoint requires a vendor-scoped JWT token. Merchant tokens will receive a 403 error.
Use Cases
- Order detail view — Display full order breakdown in a vendor portal
- Payout reconciliation — Check vendor earnings for a specific order
- Fulfillment planning — See which vendor line items need fulfillment
Path Parameters
string
required
The order’s MongoDB ObjectId or numeric Shopify order ID.
Response
200
{
"success": true,
"data": {
"order": {
"_id": "507f1f77bcf86cd799439013",
"orderId": 5123456789,
"orderNumber": 1042,
"orderName": "#1042",
"customer": {
"email": "customer@example.com",
"firstName": "Jane",
"lastName": "Doe"
},
"shippingAddress": {
"address1": "123 High Street",
"city": "London",
"province": "England",
"country": "United Kingdom",
"zip": "SW1A 1AA"
},
"status": "fulfilled",
"createdAt": "2024-06-15T10:30:00.000Z"
},
"lineItems": [
{
"_id": "507f1f77bcf86cd799439015",
"lineItemName": "Widget Pro - Large / Blue",
"quantity": 2,
"unitPrice": 139.99,
"fulfillmentStatus": "fulfilled"
}
],
"isVendorScoped": true
}
}
Error Response
404
{
"success": false,
"error": {
"message": "Order not found",
"code": "NOT_FOUND"
}
}
Example
curl -X GET "https://production-api.puppetvendors.com/orders/507f1f77bcf86cd799439013" \
-H "x-access-token: YOUR_VENDOR_JWT_TOKEN"
Was this page helpful?