Submit customs documents to a carrier
curl --request POST \
--url https://api.example.com/v1/document_uploads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documents": [
{
"file": "<string>",
"name": "<string>"
}
],
"shipment": "<string>",
"connection": "<string>",
"tracking_number": "<string>",
"origin_country": "<string>",
"destination_country": "<string>",
"reference": "<string>",
"user_metadata": {}
}
'import requests
url = "https://api.example.com/v1/document_uploads"
payload = {
"documents": [
{
"file": "<string>",
"name": "<string>"
}
],
"shipment": "<string>",
"connection": "<string>",
"tracking_number": "<string>",
"origin_country": "<string>",
"destination_country": "<string>",
"reference": "<string>",
"user_metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
documents: [{file: '<string>', name: '<string>'}],
shipment: '<string>',
connection: '<string>',
tracking_number: '<string>',
origin_country: '<string>',
destination_country: '<string>',
reference: '<string>',
user_metadata: {}
})
};
fetch('https://api.example.com/v1/document_uploads', 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/document_uploads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'documents' => [
[
'file' => '<string>',
'name' => '<string>'
]
],
'shipment' => '<string>',
'connection' => '<string>',
'tracking_number' => '<string>',
'origin_country' => '<string>',
'destination_country' => '<string>',
'reference' => '<string>',
'user_metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/document_uploads"
payload := strings.NewReader("{\n \"documents\": [\n {\n \"file\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"shipment\": \"<string>\",\n \"connection\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"destination_country\": \"<string>\",\n \"reference\": \"<string>\",\n \"user_metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/document_uploads")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"documents\": [\n {\n \"file\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"shipment\": \"<string>\",\n \"connection\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"destination_country\": \"<string>\",\n \"reference\": \"<string>\",\n \"user_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/document_uploads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"documents\": [\n {\n \"file\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"shipment\": \"<string>\",\n \"connection\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"destination_country\": \"<string>\",\n \"reference\": \"<string>\",\n \"user_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "dupl_1Q2w3E4r",
"object": "document_upload",
"livemode": true,
"created": 123,
"status": "pending",
"stage": "pre_shipment",
"documents": [
{
"file": "<string>",
"type": "commercial_invoice",
"name": "<string>",
"status": "pending",
"carrier_reference": "<string>",
"error": {
"code": "<string>",
"message": "<string>"
}
}
],
"updated": 123,
"connection": "<string>",
"carrier": "<string>",
"shipment": "<string>",
"tracking_number": "<string>",
"origin_country": "<string>",
"destination_country": "<string>",
"reference": "<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>"
}
}{
"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>"
}
]
}
}{
"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>"
}
]
}
}Document Uploads
Submit customs documents to a carrier
POST
/
v1
/
document_uploads
Submit customs documents to a carrier
curl --request POST \
--url https://api.example.com/v1/document_uploads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documents": [
{
"file": "<string>",
"name": "<string>"
}
],
"shipment": "<string>",
"connection": "<string>",
"tracking_number": "<string>",
"origin_country": "<string>",
"destination_country": "<string>",
"reference": "<string>",
"user_metadata": {}
}
'import requests
url = "https://api.example.com/v1/document_uploads"
payload = {
"documents": [
{
"file": "<string>",
"name": "<string>"
}
],
"shipment": "<string>",
"connection": "<string>",
"tracking_number": "<string>",
"origin_country": "<string>",
"destination_country": "<string>",
"reference": "<string>",
"user_metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
documents: [{file: '<string>', name: '<string>'}],
shipment: '<string>',
connection: '<string>',
tracking_number: '<string>',
origin_country: '<string>',
destination_country: '<string>',
reference: '<string>',
user_metadata: {}
})
};
fetch('https://api.example.com/v1/document_uploads', 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/document_uploads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'documents' => [
[
'file' => '<string>',
'name' => '<string>'
]
],
'shipment' => '<string>',
'connection' => '<string>',
'tracking_number' => '<string>',
'origin_country' => '<string>',
'destination_country' => '<string>',
'reference' => '<string>',
'user_metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/document_uploads"
payload := strings.NewReader("{\n \"documents\": [\n {\n \"file\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"shipment\": \"<string>\",\n \"connection\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"destination_country\": \"<string>\",\n \"reference\": \"<string>\",\n \"user_metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/document_uploads")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"documents\": [\n {\n \"file\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"shipment\": \"<string>\",\n \"connection\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"destination_country\": \"<string>\",\n \"reference\": \"<string>\",\n \"user_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/document_uploads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"documents\": [\n {\n \"file\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"shipment\": \"<string>\",\n \"connection\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"destination_country\": \"<string>\",\n \"reference\": \"<string>\",\n \"user_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "dupl_1Q2w3E4r",
"object": "document_upload",
"livemode": true,
"created": 123,
"status": "pending",
"stage": "pre_shipment",
"documents": [
{
"file": "<string>",
"type": "commercial_invoice",
"name": "<string>",
"status": "pending",
"carrier_reference": "<string>",
"error": {
"code": "<string>",
"message": "<string>"
}
}
],
"updated": 123,
"connection": "<string>",
"carrier": "<string>",
"shipment": "<string>",
"tracking_number": "<string>",
"origin_country": "<string>",
"destination_country": "<string>",
"reference": "<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>"
}
}{
"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>"
}
]
}
}{
"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_...)
Maximum string length:
255Body
application/json
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
Client-writable. Up to 50 string key/value pairs. Never sent to carriers.
Show child attributes
Show child attributes
Response
OK
Prefixed dupl_
Example:
"dupl_1Q2w3E4r"
Available options:
document_upload Unix timestamp (seconds)
Available options:
pending, accepted, partially_accepted, rejected Available options:
pre_shipment, post_shipment Show child attributes
Show child attributes
Unix timestamp (seconds)
Show child attributes
Show child attributes
Client-writable. Up to 50 string key/value pairs. Never sent to carriers.
Show child attributes
Show child attributes
Read-only. Carrier-returned data not modelled by the spec (routing codes, internal IDs). Untrusted and unversioned; keys may change with the carrier's API.
Read-only. Implementer provenance. Implementer-specific keys are prefixed x_.
Show child attributes
Show child attributes