curl --request GET \
--url https://store.salesive.com/api/v1/orders \
--header 'Authorization: Bearer <token>' \
--header 'x-shop-id: <api-key>'import requests
url = "https://store.salesive.com/api/v1/orders"
headers = {
"Authorization": "Bearer <token>",
"x-shop-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'x-shop-id': '<api-key>'}
};
fetch('https://store.salesive.com/api/v1/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://store.salesive.com/api/v1/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 => [
"Authorization: Bearer <token>",
"x-shop-id: <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://store.salesive.com/api/v1/orders"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("x-shop-id", "<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://store.salesive.com/api/v1/orders")
.header("Authorization", "Bearer <token>")
.header("x-shop-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://store.salesive.com/api/v1/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-shop-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": 123,
"success": true,
"message": "<string>",
"data": {
"orders": [
{
"_id": "<string>",
"orderId": 123,
"user": "<string>",
"shop": "<string>",
"items": [
{
"product": "<string>",
"name": "<string>",
"price": 123,
"quantity": 2,
"variant": "<string>",
"sku": "<string>",
"variantAttributes": {},
"imageUrl": "<string>"
}
],
"subtotal": 123,
"shippingCost": 123,
"total": 123,
"shippingAddress": {
"fullName": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"phoneNumber": "<string>"
},
"payment": "<string>",
"shipment": "<string>",
"notes": "<string>",
"additionalInfo": [
{
"label": "<string>",
"value": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"page": 123,
"limit": 123,
"total": 123,
"pages": 123
}
}
}List orders
Retrieve orders for the authenticated shopper with optional filters.
curl --request GET \
--url https://store.salesive.com/api/v1/orders \
--header 'Authorization: Bearer <token>' \
--header 'x-shop-id: <api-key>'import requests
url = "https://store.salesive.com/api/v1/orders"
headers = {
"Authorization": "Bearer <token>",
"x-shop-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'x-shop-id': '<api-key>'}
};
fetch('https://store.salesive.com/api/v1/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://store.salesive.com/api/v1/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 => [
"Authorization: Bearer <token>",
"x-shop-id: <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://store.salesive.com/api/v1/orders"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("x-shop-id", "<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://store.salesive.com/api/v1/orders")
.header("Authorization", "Bearer <token>")
.header("x-shop-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://store.salesive.com/api/v1/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-shop-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": 123,
"success": true,
"message": "<string>",
"data": {
"orders": [
{
"_id": "<string>",
"orderId": 123,
"user": "<string>",
"shop": "<string>",
"items": [
{
"product": "<string>",
"name": "<string>",
"price": 123,
"quantity": 2,
"variant": "<string>",
"sku": "<string>",
"variantAttributes": {},
"imageUrl": "<string>"
}
],
"subtotal": 123,
"shippingCost": 123,
"total": 123,
"shippingAddress": {
"fullName": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"phoneNumber": "<string>"
},
"payment": "<string>",
"shipment": "<string>",
"notes": "<string>",
"additionalInfo": [
{
"label": "<string>",
"value": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"page": 123,
"limit": 123,
"total": 123,
"pages": 123
}
}
}Request
GET /orders
Authorization: Bearer {{token}}
x-shop-id: {{shopId}}
Headers
| Header | Type | Description |
|---|---|---|
Authorization | string | Provide the customer token in the format Bearer <jwt>. |
x-shop-id | string | Identify the shop that owns the orders. |
Query parameters
| Parameter | Type | Description |
|---|---|---|
status | string | Filter by order status. Can be specified multiple times. Valid values: pending, processing, paid, completed, cancelled, refunded. |
orderId | number | Filter by specific order number. |
minTotal | number | Filter orders with subtotal greater than or equal to this value. |
maxTotal | number | Filter orders with subtotal less than or equal to this value. |
from | string | Filter orders created after this date (ISO 8601 format). |
to | string | Filter orders created before this date (ISO 8601 format). |
page | number | Page number for pagination (default: 1). |
limit | number | Number of items per page (default: 10). |
Request examples
Get all orders
GET /orders
Filter by single status
GET /orders?status=pending
Filter by multiple statuses
GET /orders?status=pending&status=paid
Filter by total range
GET /orders?minTotal=100&maxTotal=500
Filter by date range
GET /orders?from=2025-01-01T00:00:00.000Z&to=2025-12-31T23:59:59.999Z
Filter by order number
GET /orders?orderId=9
Pagination
GET /orders?page=2&limit=5
Successful response
{
"status": 200,
"success": true,
"message": "Orders retrieved",
"data": {
"orders": [
{
"_id": "6938414ad9485f4d96134f8c",
"user": "669d5dcf3cc9c8596ec0f302",
"shop": "68b8f52575da81b332af29f1",
"items": [
{
"product": "68bc52f0e15404b8e40a7c52",
"variant": "692caacbb07303c9be5ea8f2",
"name": "Classic Hoodie",
"sku": "HOODIE-GREEN-M",
"price": 25000,
"quantity": 1,
"variantAttributes": {
"color": "green"
},
"imageUrl": "https://cdn.salesive.com/products/hoodie.jpg",
"_id": "6938414ad9485f4d96134f8d"
}
],
"status": "completed",
"payment": {
"_id": "693b7cb3e1906f5273e48135",
"shop": "68b8f52575da81b332af29f1",
"channel": "other",
"transactionId": "9859451",
"provider": "flutterwave",
"amount": 19477.2,
"total": 19876,
"currency": "NGN",
"status": "completed",
"createdAt": "2025-12-12T02:23:47.841Z",
"updatedAt": "2025-12-12T02:23:47.841Z"
},
"discount": 6250,
"coupon": "690f5d8a088bef812956b384",
"subtotal": 25000,
"shippingCost": 727.2,
"fee": 0,
"tax": 0,
"shipment": {
"_id": "693aa5ed1141d1a105282ba2",
"courier": {
"id": "express_courier",
"name": "Express Delivery",
"image": "https://cdn.salesive.com/couriers/express.png"
},
"estimatedDelivery": "2025-12-14T11:07:24.000Z"
},
"orderId": 9,
"createdAt": "2025-12-09T15:33:30.039Z",
"updatedAt": "2026-02-16T12:13:31.035Z"
}
],
"pagination": {
"page": 1,
"limit": 10,
"total": 1,
"pages": 1
}
}
}
Error response
{
"status": 401,
"success": false,
"message": "Unauthorized",
"data": {}
}
Authorizations
JWT issued by the Salesive Store API for authenticated shoppers.
Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.
Headers
Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.
Query Parameters
Filter by order status. Can be specified multiple times.
pending, processing, paid, cancelled, refunded Filter by specific order ID.
Filter orders with total greater than or equal to this value.
Filter orders with total less than or equal to this value.
Filter orders created after this date (ISO 8601 format).
Filter orders created before this date (ISO 8601 format).
Page number for pagination (default: 1).
x >= 1Number of items per page (default: 10).
x >= 1Was this page helpful?

