List Shipments
Searches your Shipments and returns key information for each match, including its latest event. Use Retrieve Shipment Details for the full record of a single Shipment.
A date range is required: provide exactly one of the pairs
created_date_*, updated_date_*, or latest_event_date_* — both ends
together, _from ≤ _to, and _from at most 13 months in the past
(the data retention window). Format yyyy-mm-ddThh:mm:ss, processed as
UTC.
AND/OR filters: parameters marked AND/OR accept bracket syntax —
field=['a','b'] matches both (AND), field=[['a','b']] matches either
(OR), field=['x',['a','b']] mixes them. String values must be quoted;
URL-encode the brackets and quotes if your client requires it.
Pagination: cursor-based. limit is 25–100 (default 25). Pass the
next_page value from each response into the next request; the first
page is next_page=0. You have reached the last page when the response
no longer returns a next_page value.
No match: a valid search with zero results returns HTTP 404 with
api_response 4041 — not an empty array.
curl --request GET \
--url https://api.perform.ai/v5/shipment/list/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.perform.ai/v5/shipment/list/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.perform.ai/v5/shipment/list/', 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.perform.ai/v5/shipment/list/",
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.perform.ai/v5/shipment/list/"
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.perform.ai/v5/shipment/list/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.perform.ai/v5/shipment/list/")
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{
"api_response": "200",
"total_result": 2,
"next_page": 510603416,
"data": [
{
"shipment_uuid": "5b8ed503-20d2-46cf-8675-ce77a059f691",
"shipment_id": "SHP-2026-000002",
"tracking_number": "00340434616780000001",
"carrier": "DHL eCommerce",
"status": "active",
"current_phase": {
"name": "Out for delivery",
"key": "G"
},
"created_date": "2026-09-19T03:26:29+00:00",
"updated_date": "2026-09-19T05:12:04+00:00",
"order": {
"order_uuid": "a0144751-6530-4135-8d73-f258a28ba27d",
"order_id": "ORD-2026-000114"
},
"latest_event": {
"event": "Out for delivery",
"date_time": "2026-09-19T11:10:00+08:00",
"timezone": "Asia/Singapore",
"location": {
"place": "Singapore"
}
}
}
]
}{
"api_response": "4030",
"message": "validation_error",
"errors": {
"created_date_from": [
"created_date or updated_date range is required."
],
"created_date_to": [
"created_date or updated_date range is required."
]
}
}{
"api_response": 403,
"message": "Key not authorized"
}{
"api_response": "4041",
"message": "No results found with the provided search parameters"
}{
"api_response": 429,
"message": "Throttled"
}{
"api_response": "500",
"message": "System error"
}Authorizations
Used by every functional endpoint. Generate the token with POST /auth/oauth/token/ and send it as Authorization: Bearer {token}.
Query Parameters
Start of the created-date range. Pair with created_date_to.
End of the created-date range.
Start of the updated-date range. Pair with updated_date_to.
End of the updated-date range.
Start of the latest-event-date range. Pair with latest_event_date_to.
End of the latest-event-date range.
Tracking number. Max 75 chars per entry. AND/OR.
Shipment reference. Max 75 chars per entry. AND/OR.
Additional reference. Max 75 chars per entry. AND/OR.
Order UUID of the associated order. AND/OR.
Order ID of the associated order. Max 75 chars per entry. AND/OR.
Order reference of the associated order. Max 75 chars per entry. AND/OR.
Perform.AI 6-character carrier ID. Exactly 6 characters. AND/OR.
Configured carrier reference. Max 75 chars per entry. AND/OR.
Shipment status. AND/OR.
pending, expired, active, inactive, delivered, return Current delivery phase, using standard phase keys. AND/OR.
Tags added to the Shipment. AND/OR.
Notification email address on the Shipment. AND/OR.
Notification phone number on the Shipment (normalized to +{country code}{number}). AND/OR.
Tracking page reference. Max 150 chars per entry. AND/OR.
Origin country, ISO 3166-1 alpha-2. AND/OR.
Destination country, ISO 3166-1 alpha-2. AND/OR.
Tracking number of a linked Shipment. Max 50 chars per entry. AND/OR.
Whether the Shipment has, had, or never had an issue. AND/OR.
no_issue, current_issue, past_issue Type of delivery issue encountered. AND/OR.
Domestic or international. AND/OR.
domestic, international Results per response.
25 <= x <= 100Pagination cursor. 0 for the first page; then the next_page value returned by the previous response.
curl --request GET \
--url https://api.perform.ai/v5/shipment/list/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.perform.ai/v5/shipment/list/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.perform.ai/v5/shipment/list/', 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.perform.ai/v5/shipment/list/",
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.perform.ai/v5/shipment/list/"
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.perform.ai/v5/shipment/list/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.perform.ai/v5/shipment/list/")
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{
"api_response": "200",
"total_result": 2,
"next_page": 510603416,
"data": [
{
"shipment_uuid": "5b8ed503-20d2-46cf-8675-ce77a059f691",
"shipment_id": "SHP-2026-000002",
"tracking_number": "00340434616780000001",
"carrier": "DHL eCommerce",
"status": "active",
"current_phase": {
"name": "Out for delivery",
"key": "G"
},
"created_date": "2026-09-19T03:26:29+00:00",
"updated_date": "2026-09-19T05:12:04+00:00",
"order": {
"order_uuid": "a0144751-6530-4135-8d73-f258a28ba27d",
"order_id": "ORD-2026-000114"
},
"latest_event": {
"event": "Out for delivery",
"date_time": "2026-09-19T11:10:00+08:00",
"timezone": "Asia/Singapore",
"location": {
"place": "Singapore"
}
}
}
]
}{
"api_response": "4030",
"message": "validation_error",
"errors": {
"created_date_from": [
"created_date or updated_date range is required."
],
"created_date_to": [
"created_date or updated_date range is required."
]
}
}{
"api_response": 403,
"message": "Key not authorized"
}{
"api_response": "4041",
"message": "No results found with the provided search parameters"
}{
"api_response": 429,
"message": "Throttled"
}{
"api_response": "500",
"message": "System error"
}