Search shipments
curl --request GET \
--url https://api.example.com/v1/shipments/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/v1/shipments/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v1/shipments/search', 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.example.com/v1/shipments/search",
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.example.com/v1/shipments/search"
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.example.com/v1/shipments/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/shipments/search")
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{
"object": "search_result",
"has_more": true,
"data": [
{
"id": "shp_1Q2w3E4r",
"object": "shipment",
"livemode": true,
"created": 123,
"status": "draft",
"updated": 123,
"reference": "<string>",
"ship_date": "2023-12-25",
"ship_from": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"ship_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"return_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"bill_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"billing": {
"paid_by": "sender",
"account_number": "<string>"
},
"handling_units": [
{
"weight": {
"value": 123,
"unit": "g"
},
"id": "<string>",
"type": "parcel",
"conditions": {
"temperature": {
"min": {
"value": 123,
"unit": "<string>"
},
"max": {
"value": 123,
"unit": "<string>"
}
},
"shock": {
"max": {
"value": 123,
"unit": "<string>"
}
},
"tilt": {
"max_degrees": 123
}
},
"dimensions": {
"length": 123,
"width": 123,
"height": 123,
"unit": "mm"
},
"packaging": "<string>",
"freight": {
"pallet_standard": "eur1",
"stackable": true,
"piece_count": 123,
"freight_class": "<string>",
"nmfc_code": "<string>",
"hazmat_placard": true
},
"reference": "<string>",
"description": "<string>",
"items": [
{
"quantity": 2,
"title": "<string>",
"description": "<string>",
"sku": "<string>",
"unit_value": {
"amount": 123,
"currency": "usd"
},
"unit_net_weight": {
"value": 123,
"unit": "g"
},
"unit_gross_weight": {
"value": 123,
"unit": "g"
},
"origin_country": "<string>",
"export_hs_code": "<string>",
"import_hs_code": "<string>",
"category": "<string>",
"product_url": "<string>",
"image_url": "<string>",
"product_id": "<string>",
"variant_id": "<string>",
"order_line_id": "<string>",
"brand": "<string>",
"material": "<string>",
"manufacturer": {
"name": "<string>",
"country": "<string>",
"mid": "<string>"
},
"compliance": {
"controlled": true,
"control_type": "dual_use",
"eccn": "<string>",
"license": {
"type": "export",
"number": "<string>",
"expires_on": "2023-12-25"
},
"regulatory_agency": "<string>",
"regulatory_program": "<string>",
"regulatory_category_code": "<string>",
"certification": {
"type": "<string>",
"reference": "<string>"
}
},
"dangerous_goods": {
"class": "<string>",
"un_number": "<string>",
"proper_shipping_name": "<string>",
"packing_group": "I",
"packing_instruction": "<string>",
"section": "<string>",
"quantity": {
"value": 123,
"unit": "g"
},
"lithium": {
"type": "ion",
"configuration": "alone",
"watt_hours": 123,
"lithium_grams": 123,
"cells": 123
},
"accessibility": "accessible",
"transport_mode": "air",
"excepted_quantity": true,
"limited_quantity": true,
"emergency_contact": {
"name": "<string>",
"phone": "<string>"
},
"declaration_document": "<string>"
},
"product": "<string>",
"user_metadata": {}
}
],
"tracking_number": "<string>",
"carrier_metadata": {}
}
],
"order": {
"id": "<string>",
"reference": "<string>",
"channel": "<string>",
"ordered_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"subtotal": {
"amount": 123,
"currency": "usd"
},
"shipping_charge": {
"amount": 123,
"currency": "usd"
},
"insurance_charge": {
"amount": 123,
"currency": "usd"
},
"discount": {
"amount": 123,
"currency": "usd"
},
"tax": {
"amount": 123,
"currency": "usd"
},
"total": {
"amount": 123,
"currency": "usd"
},
"invoice": {
"number": "<string>",
"date": "2023-12-25",
"type": "commercial",
"terms_of_payment": "prepaid",
"file": "<string>"
},
"buyer": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"seller": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
}
},
"customs_declaration": {
"contents_type": "merchandise",
"contents_explanation": "<string>",
"incoterm": "DAP",
"duties": {
"paid_by": "sender",
"account_number": "<string>",
"bill_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
}
},
"landed_cost": "<string>",
"import_broker": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"export_broker": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"importer_of_record": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"exporter_of_record": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"eu_responsible_person": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"export_declaration": {
"type": "itn",
"value": "<string>"
},
"non_delivery": "return",
"paperless_trade": true,
"certify": true,
"signer": "<string>",
"documents": [
{
"type": "<string>",
"carrier_reference": "<string>",
"document_upload": "<string>"
}
]
},
"carrier_configs": {
"*": {
"signature": "adult",
"insurance": {
"amount": 25000,
"currency": "usd"
}
},
"fedex": {
"service": "fedex_international_priority",
"saturday_delivery": true,
"priority_alert": true
},
"ups": {}
},
"purchase": {
"rate": "<string>",
"rate_quote": "<string>",
"service": {
"code": "<string>",
"carrier": "<string>",
"connection": "<string>",
"name": "<string>",
"level": "same_day",
"carrier_code": "<string>"
},
"amount": {
"amount": 123,
"currency": "usd"
},
"charges": [
{
"kind": "base",
"amount": {
"amount": 123,
"currency": "usd"
},
"option": "<string>",
"name": "<string>",
"carrier_code": "<string>"
}
],
"delivery": {
"days": 123,
"date": "2023-12-25",
"window": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"guaranteed": true,
"business_days": true
},
"label_format": {
"format": "pdf",
"size": "<string>",
"dpi": "203",
"inline": true
},
"purchased_at": 123,
"error": {},
"void": {
"requested_at": 123,
"reason": "<string>",
"status": "pending",
"refund": {
"status": "not_applicable",
"amount": {
"amount": 123,
"currency": "usd"
},
"expected_by": "2023-12-25"
},
"carrier_reference": "<string>"
},
"coverage": "<string>"
},
"tracking": {
"status": "pre_transit",
"number": "<string>",
"url": "<string>",
"tracker": "<string>",
"journey": "<string>"
},
"handover": {
"close_group": "<string>",
"pickup": "<string>",
"manifest": "<string>"
},
"injection": {
"partner": "<string>",
"channel": "carrier",
"upstream_reference": "<string>",
"label_mode": "pre_labeled",
"status": "submitted",
"upstream_carrier": "<string>",
"upstream_tracking_number": "<string>",
"injection_point": "<string>",
"expected_at": "<string>",
"asn": "<string>",
"tracking_feedback": {
"mode": "push",
"target": "partner_webhooks",
"number": "upstream"
},
"decision": {
"reasons": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
},
"received": {
"at": 123,
"facility": "<string>",
"condition": "ok",
"measured": {
"weight": {
"value": 123,
"unit": "g"
},
"dimensions": {
"length": 123,
"width": 123,
"height": 123,
"unit": "mm"
}
}
}
},
"returns": {
"is_return": true,
"outbound_shipment": "<string>",
"return_shipment": "<string>"
},
"documents": [
{
"id": "<string>",
"object": "document",
"type": "label",
"format": "pdf",
"size": "<string>",
"url": "<string>",
"url_expires_at": 123,
"data": "<string>",
"handling_unit": "<string>",
"bundle": [
"<string>"
],
"template": "<string>",
"template_version": 123,
"related": {
"type": "<string>",
"id": "<string>"
},
"file": "<string>",
"sha256": "<string>"
}
],
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
],
"user_metadata": {},
"carrier_metadata": {},
"system_metadata": {
"source": "api",
"created_by": {
"type": "api_key",
"id": "<string>"
},
"request_id": "<string>",
"idempotency_key": "<string>",
"batch": "<string>",
"generated": true,
"test_scenario": "<string>"
}
}
],
"next_page": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}Shipments
Search shipments
GET
/
v1
/
shipments
/
search
Search shipments
curl --request GET \
--url https://api.example.com/v1/shipments/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/v1/shipments/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v1/shipments/search', 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.example.com/v1/shipments/search",
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.example.com/v1/shipments/search"
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.example.com/v1/shipments/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/shipments/search")
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{
"object": "search_result",
"has_more": true,
"data": [
{
"id": "shp_1Q2w3E4r",
"object": "shipment",
"livemode": true,
"created": 123,
"status": "draft",
"updated": 123,
"reference": "<string>",
"ship_date": "2023-12-25",
"ship_from": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"ship_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"return_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"bill_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"billing": {
"paid_by": "sender",
"account_number": "<string>"
},
"handling_units": [
{
"weight": {
"value": 123,
"unit": "g"
},
"id": "<string>",
"type": "parcel",
"conditions": {
"temperature": {
"min": {
"value": 123,
"unit": "<string>"
},
"max": {
"value": 123,
"unit": "<string>"
}
},
"shock": {
"max": {
"value": 123,
"unit": "<string>"
}
},
"tilt": {
"max_degrees": 123
}
},
"dimensions": {
"length": 123,
"width": 123,
"height": 123,
"unit": "mm"
},
"packaging": "<string>",
"freight": {
"pallet_standard": "eur1",
"stackable": true,
"piece_count": 123,
"freight_class": "<string>",
"nmfc_code": "<string>",
"hazmat_placard": true
},
"reference": "<string>",
"description": "<string>",
"items": [
{
"quantity": 2,
"title": "<string>",
"description": "<string>",
"sku": "<string>",
"unit_value": {
"amount": 123,
"currency": "usd"
},
"unit_net_weight": {
"value": 123,
"unit": "g"
},
"unit_gross_weight": {
"value": 123,
"unit": "g"
},
"origin_country": "<string>",
"export_hs_code": "<string>",
"import_hs_code": "<string>",
"category": "<string>",
"product_url": "<string>",
"image_url": "<string>",
"product_id": "<string>",
"variant_id": "<string>",
"order_line_id": "<string>",
"brand": "<string>",
"material": "<string>",
"manufacturer": {
"name": "<string>",
"country": "<string>",
"mid": "<string>"
},
"compliance": {
"controlled": true,
"control_type": "dual_use",
"eccn": "<string>",
"license": {
"type": "export",
"number": "<string>",
"expires_on": "2023-12-25"
},
"regulatory_agency": "<string>",
"regulatory_program": "<string>",
"regulatory_category_code": "<string>",
"certification": {
"type": "<string>",
"reference": "<string>"
}
},
"dangerous_goods": {
"class": "<string>",
"un_number": "<string>",
"proper_shipping_name": "<string>",
"packing_group": "I",
"packing_instruction": "<string>",
"section": "<string>",
"quantity": {
"value": 123,
"unit": "g"
},
"lithium": {
"type": "ion",
"configuration": "alone",
"watt_hours": 123,
"lithium_grams": 123,
"cells": 123
},
"accessibility": "accessible",
"transport_mode": "air",
"excepted_quantity": true,
"limited_quantity": true,
"emergency_contact": {
"name": "<string>",
"phone": "<string>"
},
"declaration_document": "<string>"
},
"product": "<string>",
"user_metadata": {}
}
],
"tracking_number": "<string>",
"carrier_metadata": {}
}
],
"order": {
"id": "<string>",
"reference": "<string>",
"channel": "<string>",
"ordered_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"subtotal": {
"amount": 123,
"currency": "usd"
},
"shipping_charge": {
"amount": 123,
"currency": "usd"
},
"insurance_charge": {
"amount": 123,
"currency": "usd"
},
"discount": {
"amount": 123,
"currency": "usd"
},
"tax": {
"amount": 123,
"currency": "usd"
},
"total": {
"amount": 123,
"currency": "usd"
},
"invoice": {
"number": "<string>",
"date": "2023-12-25",
"type": "commercial",
"terms_of_payment": "prepaid",
"file": "<string>"
},
"buyer": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"seller": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
}
},
"customs_declaration": {
"contents_type": "merchandise",
"contents_explanation": "<string>",
"incoterm": "DAP",
"duties": {
"paid_by": "sender",
"account_number": "<string>",
"bill_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
}
},
"landed_cost": "<string>",
"import_broker": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"export_broker": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"importer_of_record": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"exporter_of_record": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"eu_responsible_person": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"export_declaration": {
"type": "itn",
"value": "<string>"
},
"non_delivery": "return",
"paperless_trade": true,
"certify": true,
"signer": "<string>",
"documents": [
{
"type": "<string>",
"carrier_reference": "<string>",
"document_upload": "<string>"
}
]
},
"carrier_configs": {
"*": {
"signature": "adult",
"insurance": {
"amount": 25000,
"currency": "usd"
}
},
"fedex": {
"service": "fedex_international_priority",
"saturday_delivery": true,
"priority_alert": true
},
"ups": {}
},
"purchase": {
"rate": "<string>",
"rate_quote": "<string>",
"service": {
"code": "<string>",
"carrier": "<string>",
"connection": "<string>",
"name": "<string>",
"level": "same_day",
"carrier_code": "<string>"
},
"amount": {
"amount": 123,
"currency": "usd"
},
"charges": [
{
"kind": "base",
"amount": {
"amount": 123,
"currency": "usd"
},
"option": "<string>",
"name": "<string>",
"carrier_code": "<string>"
}
],
"delivery": {
"days": 123,
"date": "2023-12-25",
"window": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"guaranteed": true,
"business_days": true
},
"label_format": {
"format": "pdf",
"size": "<string>",
"dpi": "203",
"inline": true
},
"purchased_at": 123,
"error": {},
"void": {
"requested_at": 123,
"reason": "<string>",
"status": "pending",
"refund": {
"status": "not_applicable",
"amount": {
"amount": 123,
"currency": "usd"
},
"expected_by": "2023-12-25"
},
"carrier_reference": "<string>"
},
"coverage": "<string>"
},
"tracking": {
"status": "pre_transit",
"number": "<string>",
"url": "<string>",
"tracker": "<string>",
"journey": "<string>"
},
"handover": {
"close_group": "<string>",
"pickup": "<string>",
"manifest": "<string>"
},
"injection": {
"partner": "<string>",
"channel": "carrier",
"upstream_reference": "<string>",
"label_mode": "pre_labeled",
"status": "submitted",
"upstream_carrier": "<string>",
"upstream_tracking_number": "<string>",
"injection_point": "<string>",
"expected_at": "<string>",
"asn": "<string>",
"tracking_feedback": {
"mode": "push",
"target": "partner_webhooks",
"number": "upstream"
},
"decision": {
"reasons": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
},
"received": {
"at": 123,
"facility": "<string>",
"condition": "ok",
"measured": {
"weight": {
"value": 123,
"unit": "g"
},
"dimensions": {
"length": 123,
"width": 123,
"height": 123,
"unit": "mm"
}
}
}
},
"returns": {
"is_return": true,
"outbound_shipment": "<string>",
"return_shipment": "<string>"
},
"documents": [
{
"id": "<string>",
"object": "document",
"type": "label",
"format": "pdf",
"size": "<string>",
"url": "<string>",
"url_expires_at": 123,
"data": "<string>",
"handling_unit": "<string>",
"bundle": [
"<string>"
],
"template": "<string>",
"template_version": 123,
"related": {
"type": "<string>",
"id": "<string>"
},
"file": "<string>",
"sha256": "<string>"
}
],
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
],
"user_metadata": {},
"carrier_metadata": {},
"system_metadata": {
"source": "api",
"created_by": {
"type": "api_key",
"id": "<string>"
},
"request_id": "<string>",
"idempotency_key": "<string>",
"batch": "<string>",
"generated": true,
"test_scenario": "<string>"
}
}
],
"next_page": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}Authorizations
apiKeyoauth2
sk_test_ / sk_live_ / rk_test_ / rk_live_ keys
Headers
Act on behalf of a connected account (acct_...)
Query Parameters
Search query language (chapter 10 §3)
Required range:
1 <= x <= 100