List shipments for the store
curl --request GET \
--url https://api.salesive.com/api/v1/shipping/shipments \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.salesive.com/api/v1/shipping/shipments"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.salesive.com/api/v1/shipping/shipments', 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.salesive.com/api/v1/shipping/shipments",
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>"
],
]);
$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.salesive.com/api/v1/shipping/shipments"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.salesive.com/api/v1/shipping/shipments")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesive.com/api/v1/shipping/shipments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": 200,
"success": true,
"message": "List shipments for the store",
"data": {
"shipments": [
{
"_id": "6651b2c3d4e5f60102030405",
"orderId": "6640c1b2d4e5f60102030406",
"orders": [
{
"_id": "6640c1b2d4e5f60102030406",
"orderId": "ORD-1024",
"status": "processing",
"subtotal": 15000,
"shippingCost": 2500,
"discount": 0,
"total": 17500,
"createdAt": "2026-06-25T12:00:00.000Z"
}
],
"carrier": "DHL Express",
"courier": {
"id": "dhl",
"name": "DHL Express",
"image": null
},
"trackingNumber": "SB12345678",
"trackingUrl": "https://track.example.com/SB12345678",
"shippingMethod": "express",
"shippingCost": 2500,
"status": "in_transit",
"createdAt": "2026-06-25T12:05:00.000Z",
"updatedAt": "2026-06-26T09:00:00.000Z"
}
],
"pagination": {
"total": 1,
"page": 1,
"limit": 10,
"pages": 1,
"hasNext": false,
"hasPrev": false,
"nextPage": null,
"prevPage": null
}
}
}{
"status": 401,
"success": false,
"message": "Authentication required",
"data": null
}{
"status": 403,
"success": false,
"message": "Insufficient scope",
"data": null
}Shipping
List shipments for the store
List shipments for the store. Requires the READ_SHIPPING scope.
GET
/
shipping
/
shipments
List shipments for the store
curl --request GET \
--url https://api.salesive.com/api/v1/shipping/shipments \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.salesive.com/api/v1/shipping/shipments"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.salesive.com/api/v1/shipping/shipments', 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.salesive.com/api/v1/shipping/shipments",
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>"
],
]);
$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.salesive.com/api/v1/shipping/shipments"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.salesive.com/api/v1/shipping/shipments")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesive.com/api/v1/shipping/shipments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": 200,
"success": true,
"message": "List shipments for the store",
"data": {
"shipments": [
{
"_id": "6651b2c3d4e5f60102030405",
"orderId": "6640c1b2d4e5f60102030406",
"orders": [
{
"_id": "6640c1b2d4e5f60102030406",
"orderId": "ORD-1024",
"status": "processing",
"subtotal": 15000,
"shippingCost": 2500,
"discount": 0,
"total": 17500,
"createdAt": "2026-06-25T12:00:00.000Z"
}
],
"carrier": "DHL Express",
"courier": {
"id": "dhl",
"name": "DHL Express",
"image": null
},
"trackingNumber": "SB12345678",
"trackingUrl": "https://track.example.com/SB12345678",
"shippingMethod": "express",
"shippingCost": 2500,
"status": "in_transit",
"createdAt": "2026-06-25T12:05:00.000Z",
"updatedAt": "2026-06-26T09:00:00.000Z"
}
],
"pagination": {
"total": 1,
"page": 1,
"limit": 10,
"pages": 1,
"hasNext": false,
"hasPrev": false,
"nextPage": null,
"prevPage": null
}
}
}{
"status": 401,
"success": false,
"message": "Authentication required",
"data": null
}{
"status": 403,
"success": false,
"message": "Insufficient scope",
"data": null
}Returns a paginated list of the store’s shipments, each enriched with its associated orders. Optionally filter to a single order. Requires the
READ_SHIPPING scope.Authorizations
Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.
Query Parameters
Restrict results to shipments containing this order ObjectId.
Page number (1-based).
Items per page. Defaults to 10.
Response
List shipments for the store.
Was this page helpful?
⌘I

