Retrieve an order
curl --request GET \
--url https://api.sellfern.com/orders/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sellfern.com/orders/{id}"
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://api.sellfern.com/orders/{id}', 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://api.sellfern.com/orders/{id}",
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://api.sellfern.com/orders/{id}"
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://api.sellfern.com/orders/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sellfern.com/orders/{id}")
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{
"success": true,
"data": {
"id": 1234567890,
"storeName": "My Etsy Store",
"date": "2023-11-07T05:31:56Z",
"currency": "USD",
"totalAmount": 123,
"subtotal": 123,
"tax": 123,
"shippingCost": 123,
"discount": 123,
"customerName": "<string>",
"customerAddress": "<string>",
"shipAddress1": "<string>",
"shipAddress2": "<string>",
"shipCity": "<string>",
"shipState": "<string>",
"shipZipcode": "<string>",
"shipCountry": "<string>",
"isGift": true,
"isRefunded": true,
"isCaseClosed": true,
"isLost": true,
"requiresAudit": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"items": [
{
"id": "987654321",
"orderId": "1234567890",
"customOrderId": "<string>",
"name": "<string>",
"sku": "<string>",
"customSku": "<string>",
"spu": "<string>",
"quantity": 1,
"price": 123,
"status": "In Production",
"assignedSupplier": "<string>",
"subSupplier": "<string>",
"material": "<string>",
"materialId": "<string>",
"designUrl": "<string>",
"trackingCode": "<string>",
"carrier": "<string>",
"style": "<string>",
"type": "<string>",
"size": "<string>",
"color": "<string>",
"variations": "<string>",
"personalization": "<string>",
"comment": "<string>",
"idService": "<string>",
"phone": "<string>",
"orderDate": "<string>",
"storeName": "<string>",
"isGift": true,
"customerName": "<string>",
"customerAddress": "<string>",
"shipName": "<string>",
"shipAddress1": "<string>",
"shipAddress2": "<string>",
"shipCity": "<string>",
"shipState": "<string>",
"shipZipcode": "<string>",
"shipCountry": "<string>",
"vatIossNumber": "<string>"
}
]
},
"meta": {
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_error",
"message": "Request validation failed."
},
"meta": {
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "unauthorized",
"message": "Missing or invalid API key."
},
"meta": {
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "missing_scope",
"message": "Missing required scope."
},
"meta": {
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "not_found",
"message": "Resource not found."
},
"meta": {
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded."
},
"meta": {
"request_id": "<string>"
}
}Orders
Retrieve an order
Retrieves one order and its items. Orders outside the authenticated organization are returned as not found. The public schema is curated for fulfillment operations and omits customer email, payment method, net/profitability, refund amount, and item cost fields.
Scope notes: Requires order read scope and authenticated organization isolation.
Read-only endpoint.
GET
/
orders
/
{id}
Retrieve an order
curl --request GET \
--url https://api.sellfern.com/orders/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sellfern.com/orders/{id}"
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://api.sellfern.com/orders/{id}', 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://api.sellfern.com/orders/{id}",
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://api.sellfern.com/orders/{id}"
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://api.sellfern.com/orders/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sellfern.com/orders/{id}")
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{
"success": true,
"data": {
"id": 1234567890,
"storeName": "My Etsy Store",
"date": "2023-11-07T05:31:56Z",
"currency": "USD",
"totalAmount": 123,
"subtotal": 123,
"tax": 123,
"shippingCost": 123,
"discount": 123,
"customerName": "<string>",
"customerAddress": "<string>",
"shipAddress1": "<string>",
"shipAddress2": "<string>",
"shipCity": "<string>",
"shipState": "<string>",
"shipZipcode": "<string>",
"shipCountry": "<string>",
"isGift": true,
"isRefunded": true,
"isCaseClosed": true,
"isLost": true,
"requiresAudit": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"items": [
{
"id": "987654321",
"orderId": "1234567890",
"customOrderId": "<string>",
"name": "<string>",
"sku": "<string>",
"customSku": "<string>",
"spu": "<string>",
"quantity": 1,
"price": 123,
"status": "In Production",
"assignedSupplier": "<string>",
"subSupplier": "<string>",
"material": "<string>",
"materialId": "<string>",
"designUrl": "<string>",
"trackingCode": "<string>",
"carrier": "<string>",
"style": "<string>",
"type": "<string>",
"size": "<string>",
"color": "<string>",
"variations": "<string>",
"personalization": "<string>",
"comment": "<string>",
"idService": "<string>",
"phone": "<string>",
"orderDate": "<string>",
"storeName": "<string>",
"isGift": true,
"customerName": "<string>",
"customerAddress": "<string>",
"shipName": "<string>",
"shipAddress1": "<string>",
"shipAddress2": "<string>",
"shipCity": "<string>",
"shipState": "<string>",
"shipZipcode": "<string>",
"shipCountry": "<string>",
"vatIossNumber": "<string>"
}
]
},
"meta": {
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_error",
"message": "Request validation failed."
},
"meta": {
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "unauthorized",
"message": "Missing or invalid API key."
},
"meta": {
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "missing_scope",
"message": "Missing required scope."
},
"meta": {
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "not_found",
"message": "Resource not found."
},
"meta": {
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded."
},
"meta": {
"request_id": "<string>"
}
}Authorizations
Sellfern public API key scoped to the authenticated organization. Do not use user JWTs for public integrations.
Path Parameters
Order ID.
Required range:
x >= 1⌘I
