cURL
curl -sS -X GET 'https://apipub.firstbasehq.com/api/v1/shipments?trackingNumbers=&page=1&size=10' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json'import requests
url = "https://apipub.firstbasehq.com/api/v1/shipments"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://apipub.firstbasehq.com/api/v1/shipments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"size": 123,
"totalElements": 123,
"totalPages": 123,
"pageNumber": 123,
"data": [
{
"id": "123E4567-E89B-12D3-A456-426614174000",
"trackingCode": "1Z00000000",
"carrier": "UPS",
"status": "DELIVERED",
"trackingHistory": [
{
"id": "123E4567-E89B-12D3-A456-426614174000",
"status": "IN_TRANSIT",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"orderItemIds": "123E4567-E89B-12D3-A456-426614174000",
"trackingUrl": "http://trackinglink.com/trackingcode"
}
]
}
]{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}Shipment
Get shipment
Returns shipment details for the provided tracking numbers, paginated. At least one tracking number must be supplied. Each result includes carrier, tracking status, and the order items associated with the shipment.
GET
https://apipub.firstbasehq.com
/
api
/
v1
/
shipments
cURL
curl -sS -X GET 'https://apipub.firstbasehq.com/api/v1/shipments?trackingNumbers=&page=1&size=10' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json'import requests
url = "https://apipub.firstbasehq.com/api/v1/shipments"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://apipub.firstbasehq.com/api/v1/shipments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"size": 123,
"totalElements": 123,
"totalPages": 123,
"pageNumber": 123,
"data": [
{
"id": "123E4567-E89B-12D3-A456-426614174000",
"trackingCode": "1Z00000000",
"carrier": "UPS",
"status": "DELIVERED",
"trackingHistory": [
{
"id": "123E4567-E89B-12D3-A456-426614174000",
"status": "IN_TRANSIT",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"orderItemIds": "123E4567-E89B-12D3-A456-426614174000",
"trackingUrl": "http://trackinglink.com/trackingcode"
}
]
}
]{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}Authorizations
Query Parameters
Response
Paginated list of shipment details matching the provided tracking numbers