curl --request GET \
--url https://app.smartsend.io/api/v2/team/{team}/shipments \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.smartsend.io/api/v2/team/{team}/shipments"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.smartsend.io/api/v2/team/{team}/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://app.smartsend.io/api/v2/team/{team}/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://app.smartsend.io/api/v2/team/{team}/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://app.smartsend.io/api/v2/team/{team}/shipments")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.smartsend.io/api/v2/team/{team}/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{
"data": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"currency": "<string>",
"weight_unit": "g",
"dimension_unit": "cm",
"invoice_number": "<string>",
"reference": "<string>",
"identifier": "<string>",
"uri": "<string>",
"delivery": {
"carrier_code": "<string>",
"carrier_name": "<string>",
"carrier_logo_url": "<string>",
"carrier_icon_url": "<string>",
"service_code": "<string>",
"service_name": "<string>",
"is_pickup": true,
"is_return": true,
"addons": [
{
"code": "<string>",
"name": "<string>"
}
]
},
"parties": {
"receiver": {
"reference": "<string>",
"identifier": "<string>",
"uri": "<string>",
"address": {
"address_lines": [
"<string>"
],
"postal_code": "<string>",
"city": "<string>",
"country": "<string>",
"administrative_area": "<string>"
},
"contact": {
"name_lines": [
"<string>"
],
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
},
"identifiers": {
"vat": "<string>",
"eori": "<string>",
"gb_eori": "<string>",
"tax_id": "<string>",
"voec": "<string>"
}
},
"pickup": {
"service_point_code": "<string>",
"company": "<string>",
"address": {
"address_lines": [
"<string>"
],
"postal_code": "<string>",
"city": "<string>",
"country": "<string>",
"administrative_area": "<string>"
},
"reference": "<string>",
"identifier": "<string>",
"uri": "<string>"
}
},
"parcels": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference": "<string>",
"identifier": "<string>",
"tracking_code": "<string>",
"tracking_url": "<string>",
"freetext": "<string>",
"gross_weight": 1,
"length": 1,
"width": 1,
"height": 1,
"total_net_amount": 123,
"tax_amount": 123,
"duty_amount": 123,
"items": [
{
"reference": "<string>",
"identifier": "<string>",
"uri": "<string>",
"image_url": "<string>",
"sku": "<string>",
"location": "<string>",
"name": "<string>",
"description": "<string>",
"tariff_code": "<string>",
"country_of_origin": "<string>",
"quantity": 1,
"total_net_amount": 123,
"tax_amount": 123,
"duty_amount": 123,
"net_weight": 1,
"cost_amount": 123
}
],
"documents": [
{
"url": "<string>"
}
]
}
],
"total_net_amount": 123,
"tax_amount": 123,
"duty_amount": 123,
"shipping_net_amount": 123,
"shipping_tax_amount": 123,
"created_at": "2023-11-07T05:31:56Z",
"booked_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"current_page": 123,
"per_page": 123,
"total": 123,
"last_page": 123,
"from": 123,
"to": 123
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}List shipments
Returns a paginated list of shipments, sorted by most recent first. Supports filtering by carrier, service, tracking number, and state.
curl --request GET \
--url https://app.smartsend.io/api/v2/team/{team}/shipments \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.smartsend.io/api/v2/team/{team}/shipments"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.smartsend.io/api/v2/team/{team}/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://app.smartsend.io/api/v2/team/{team}/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://app.smartsend.io/api/v2/team/{team}/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://app.smartsend.io/api/v2/team/{team}/shipments")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.smartsend.io/api/v2/team/{team}/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{
"data": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"currency": "<string>",
"weight_unit": "g",
"dimension_unit": "cm",
"invoice_number": "<string>",
"reference": "<string>",
"identifier": "<string>",
"uri": "<string>",
"delivery": {
"carrier_code": "<string>",
"carrier_name": "<string>",
"carrier_logo_url": "<string>",
"carrier_icon_url": "<string>",
"service_code": "<string>",
"service_name": "<string>",
"is_pickup": true,
"is_return": true,
"addons": [
{
"code": "<string>",
"name": "<string>"
}
]
},
"parties": {
"receiver": {
"reference": "<string>",
"identifier": "<string>",
"uri": "<string>",
"address": {
"address_lines": [
"<string>"
],
"postal_code": "<string>",
"city": "<string>",
"country": "<string>",
"administrative_area": "<string>"
},
"contact": {
"name_lines": [
"<string>"
],
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
},
"identifiers": {
"vat": "<string>",
"eori": "<string>",
"gb_eori": "<string>",
"tax_id": "<string>",
"voec": "<string>"
}
},
"pickup": {
"service_point_code": "<string>",
"company": "<string>",
"address": {
"address_lines": [
"<string>"
],
"postal_code": "<string>",
"city": "<string>",
"country": "<string>",
"administrative_area": "<string>"
},
"reference": "<string>",
"identifier": "<string>",
"uri": "<string>"
}
},
"parcels": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference": "<string>",
"identifier": "<string>",
"tracking_code": "<string>",
"tracking_url": "<string>",
"freetext": "<string>",
"gross_weight": 1,
"length": 1,
"width": 1,
"height": 1,
"total_net_amount": 123,
"tax_amount": 123,
"duty_amount": 123,
"items": [
{
"reference": "<string>",
"identifier": "<string>",
"uri": "<string>",
"image_url": "<string>",
"sku": "<string>",
"location": "<string>",
"name": "<string>",
"description": "<string>",
"tariff_code": "<string>",
"country_of_origin": "<string>",
"quantity": 1,
"total_net_amount": 123,
"tax_amount": 123,
"duty_amount": 123,
"net_weight": 1,
"cost_amount": 123
}
],
"documents": [
{
"url": "<string>"
}
]
}
],
"total_net_amount": 123,
"tax_amount": 123,
"duty_amount": 123,
"shipping_net_amount": 123,
"shipping_tax_amount": 123,
"created_at": "2023-11-07T05:31:56Z",
"booked_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"current_page": 123,
"per_page": 123,
"total": 123,
"last_page": 123,
"from": 123,
"to": 123
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Preferred language(s) for translatable content using BCP 47 language tags. Supports quality values (q-factors) for priority ordering. The API negotiates the best available language based on this header, the team's configured language, and available translations. If omitted, the team's default language is used.
"da-DK, da;q=0.9, en;q=0.8"
Any value passed in this request will be returned in the same header. This can be used to correlate requests between client and server.
1 - 128^[A-Za-z0-9._-]{1,128}$Path Parameters
Team identifier. All resources are scoped to this team.
1"ad9546c1-393e-49a5-9a72-5cc146c9bec5"
Query Parameters
Filter by carrier code
"postnord"
Filter by service code
"postnord_agent"
Filter by parcel tracking number
Filter by shipment state Current state of the shipment in the booking lifecycle
open, queued, booked, cancelled, failed Page number for pagination
x >= 1Number of shipments per page
1 <= x <= 1000Was this page helpful?