Get Order
curl --request GET \
--url https://production-api.puppetvendors.com/v1/orders/{orderId} \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/v1/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/v1/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/v1/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/v1/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/v1/orders/{orderId}")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/v1/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 an order or its calculated line items
GET
/
v1
/
orders
/
{orderId}
Get Order
curl --request GET \
--url https://production-api.puppetvendors.com/v1/orders/{orderId} \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/v1/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/v1/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/v1/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/v1/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/v1/orders/{orderId}")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/v1/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_bodyOverview
Fetch a Shopify order by its order ID. Optionally retrieve the calculated line items (with commission, payout, and cost data) instead of the raw order.Use Cases
- Look up order details for customer support workflows
- Pull calculated line items to verify commission and payout amounts
- Feed order data into an external accounting or fulfillment system
- Build a custom order detail page in a third-party dashboard
Path Parameters
string
required
The Shopify order ID (numeric).
Query Parameters
string
Set to
"true" to return calculated line items instead of the raw order document. Calculated line items include commission, payout, cost of goods, and other financial fields.Response
Raw Order (default)
200
{
"orders": {
"_id": "...",
"orderId": 5022136860720,
"orderNumber": 1042,
"shopId": "...",
...
}
}
Calculated Line Items (?lineItems=true)
200
{
"orders": [
{
"_id": "...",
"lineItemId": 12345678901234,
"orderId": 5022136860720,
"vendorName": "acme supplies",
"sales": 279.99,
"commission": 39.20,
"costOfItem": 15.50,
"payout": 194.13,
...
}
]
}
Example
# Get raw order
curl -X GET "https://api.puppetvendors.com/v1/orders/5022136860720" \
-H "x-access-token: YOUR_JWT_TOKEN"
# Get calculated line items
curl -X GET "https://api.puppetvendors.com/v1/orders/5022136860720?lineItems=true" \
-H "x-access-token: YOUR_JWT_TOKEN"
Was this page helpful?