Get Shipments
curl --request GET \
--url https://app.amber.ai/api/public/v1/brands/{brand}/shipments/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.amber.ai/api/public/v1/brands/{brand}/shipments/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.amber.ai/api/public/v1/brands/{brand}/shipments/{id}', 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.amber.ai/api/public/v1/brands/{brand}/shipments/{id}",
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.amber.ai/api/public/v1/brands/{brand}/shipments/{id}"
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.amber.ai/api/public/v1/brands/{brand}/shipments/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.amber.ai/api/public/v1/brands/{brand}/shipments/{id}")
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{
"id": "<string>",
"shipmentCode": "<string>",
"status": "<string>",
"trackingNumber": "<string>",
"carrier": "<string>",
"carrierSlug": "<string>",
"freightForwarder": "<string>",
"shipmentMode": "<string>",
"containerNumbers": [
"<string>"
],
"totalPacks": 123,
"grossWeightValue": "<string>",
"grossWeightUom": "<string>",
"volumeValue": "<string>",
"volumeUom": "<string>",
"incoterm": "<string>",
"incotermLocation": "<string>",
"targetShipDate": "<string>",
"agreedShipDate": "<string>",
"revisedShipDate": "<string>",
"actualShipDate": "<string>",
"agreedPickupDate": "<string>",
"revisedPickupDate": "<string>",
"actualPickupDate": "<string>",
"estimatedPortArrivalDate": "<string>",
"actualPortArrivalDate": "<string>",
"targetArrivalDate": "<string>",
"estimatedArrivalDate": "<string>",
"customsClearedDate": "<string>",
"customsClearedDateSource": "<string>",
"actualArrivalDate": "<string>",
"actualArrivalDateSource": "<string>",
"cargoReadyDate": "<string>",
"bookingReceivedDate": "<string>",
"houseBillNumber": "<string>",
"masterBillNumber": "<string>",
"estimatedCost": "<string>",
"finalCost": "<string>",
"customsCost": "<string>",
"costCurrency": "<string>",
"conveyanceReference": "<string>",
"loadType": "<string>",
"loadUtilization": "<string>",
"originId": "<string>",
"dischargeLocationId": "<string>",
"destinationId": "<string>",
"pickupLocationId": "<string>",
"source": "<string>",
"externalShipmentId": "<string>",
"externalStatus": "<string>",
"externalBookingReference": "<string>",
"lastEventOccurredAt": "<string>",
"brandOwnerId": "<string>",
"customFields": "<unknown>",
"createdAt": "<string>",
"updatedAt": "<string>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}Shipments
Get Shipments
GET
/
brands
/
{brand}
/
shipments
/
{id}
Get Shipments
curl --request GET \
--url https://app.amber.ai/api/public/v1/brands/{brand}/shipments/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.amber.ai/api/public/v1/brands/{brand}/shipments/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.amber.ai/api/public/v1/brands/{brand}/shipments/{id}', 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.amber.ai/api/public/v1/brands/{brand}/shipments/{id}",
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.amber.ai/api/public/v1/brands/{brand}/shipments/{id}"
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.amber.ai/api/public/v1/brands/{brand}/shipments/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.amber.ai/api/public/v1/brands/{brand}/shipments/{id}")
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{
"id": "<string>",
"shipmentCode": "<string>",
"status": "<string>",
"trackingNumber": "<string>",
"carrier": "<string>",
"carrierSlug": "<string>",
"freightForwarder": "<string>",
"shipmentMode": "<string>",
"containerNumbers": [
"<string>"
],
"totalPacks": 123,
"grossWeightValue": "<string>",
"grossWeightUom": "<string>",
"volumeValue": "<string>",
"volumeUom": "<string>",
"incoterm": "<string>",
"incotermLocation": "<string>",
"targetShipDate": "<string>",
"agreedShipDate": "<string>",
"revisedShipDate": "<string>",
"actualShipDate": "<string>",
"agreedPickupDate": "<string>",
"revisedPickupDate": "<string>",
"actualPickupDate": "<string>",
"estimatedPortArrivalDate": "<string>",
"actualPortArrivalDate": "<string>",
"targetArrivalDate": "<string>",
"estimatedArrivalDate": "<string>",
"customsClearedDate": "<string>",
"customsClearedDateSource": "<string>",
"actualArrivalDate": "<string>",
"actualArrivalDateSource": "<string>",
"cargoReadyDate": "<string>",
"bookingReceivedDate": "<string>",
"houseBillNumber": "<string>",
"masterBillNumber": "<string>",
"estimatedCost": "<string>",
"finalCost": "<string>",
"customsCost": "<string>",
"costCurrency": "<string>",
"conveyanceReference": "<string>",
"loadType": "<string>",
"loadUtilization": "<string>",
"originId": "<string>",
"dischargeLocationId": "<string>",
"destinationId": "<string>",
"pickupLocationId": "<string>",
"source": "<string>",
"externalShipmentId": "<string>",
"externalStatus": "<string>",
"externalBookingReference": "<string>",
"lastEventOccurredAt": "<string>",
"brandOwnerId": "<string>",
"customFields": "<unknown>",
"createdAt": "<string>",
"updatedAt": "<string>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"errorCode": "<string>",
"details": "<unknown>"
}Authorizations
A brand-scoped or global amb_sk_... API key.
Path Parameters
Brand slug authorized by this API key.
Example:
"acme"
Stable resource identifier.
Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Response
Visible entity.
Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$