Book a pickup
curl --request POST \
--url https://api.example.com/v1/pickups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"date": "2023-12-25",
"window": {
"ready_at": "<string>",
"close_at": "<string>"
},
"connection": "<string>",
"contact": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"shipments": [
"<string>"
],
"handling_unit_count": 123,
"instructions": "<string>",
"carrier_configs": {
"*": {
"signature": "adult",
"insurance": {
"amount": 25000,
"currency": "usd"
}
},
"fedex": {
"service": "fedex_international_priority",
"saturday_delivery": true,
"priority_alert": true
},
"ups": {}
},
"user_metadata": {}
}
'import requests
url = "https://api.example.com/v1/pickups"
payload = {
"date": "2023-12-25",
"window": {
"ready_at": "<string>",
"close_at": "<string>"
},
"connection": "<string>",
"contact": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"shipments": ["<string>"],
"handling_unit_count": 123,
"instructions": "<string>",
"carrier_configs": {
"*": {
"signature": "adult",
"insurance": {
"amount": 25000,
"currency": "usd"
}
},
"fedex": {
"service": "fedex_international_priority",
"saturday_delivery": True,
"priority_alert": True
},
"ups": {}
},
"user_metadata": {}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
date: '2023-12-25',
window: {ready_at: '<string>', close_at: '<string>'},
connection: '<string>',
contact: {
name: '<string>',
company: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
tax_ids: [{value: '<string>', country: '<string>'}],
instructions: '<string>',
access_point: {carrier: '<string>', id: '<string>'}
},
shipments: ['<string>'],
handling_unit_count: 123,
instructions: '<string>',
carrier_configs: {
'*': {signature: 'adult', insurance: {amount: 25000, currency: 'usd'}},
fedex: {
service: 'fedex_international_priority',
saturday_delivery: true,
priority_alert: true
},
ups: {}
},
user_metadata: {}
})
};
fetch('https://api.example.com/v1/pickups', 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/pickups",
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([
'date' => '2023-12-25',
'window' => [
'ready_at' => '<string>',
'close_at' => '<string>'
],
'connection' => '<string>',
'contact' => [
'name' => '<string>',
'company' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'tax_ids' => [
[
'value' => '<string>',
'country' => '<string>'
]
],
'instructions' => '<string>',
'access_point' => [
'carrier' => '<string>',
'id' => '<string>'
]
],
'shipments' => [
'<string>'
],
'handling_unit_count' => 123,
'instructions' => '<string>',
'carrier_configs' => [
'*' => [
'signature' => 'adult',
'insurance' => [
'amount' => 25000,
'currency' => 'usd'
]
],
'fedex' => [
'service' => 'fedex_international_priority',
'saturday_delivery' => true,
'priority_alert' => true
],
'ups' => [
]
],
'user_metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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/pickups"
payload := strings.NewReader("{\n \"date\": \"2023-12-25\",\n \"window\": {\n \"ready_at\": \"<string>\",\n \"close_at\": \"<string>\"\n },\n \"connection\": \"<string>\",\n \"contact\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_ids\": [\n {\n \"value\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"access_point\": {\n \"carrier\": \"<string>\",\n \"id\": \"<string>\"\n }\n },\n \"shipments\": [\n \"<string>\"\n ],\n \"handling_unit_count\": 123,\n \"instructions\": \"<string>\",\n \"carrier_configs\": {\n \"*\": {\n \"signature\": \"adult\",\n \"insurance\": {\n \"amount\": 25000,\n \"currency\": \"usd\"\n }\n },\n \"fedex\": {\n \"service\": \"fedex_international_priority\",\n \"saturday_delivery\": true,\n \"priority_alert\": true\n },\n \"ups\": {}\n },\n \"user_metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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/pickups")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"date\": \"2023-12-25\",\n \"window\": {\n \"ready_at\": \"<string>\",\n \"close_at\": \"<string>\"\n },\n \"connection\": \"<string>\",\n \"contact\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_ids\": [\n {\n \"value\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"access_point\": {\n \"carrier\": \"<string>\",\n \"id\": \"<string>\"\n }\n },\n \"shipments\": [\n \"<string>\"\n ],\n \"handling_unit_count\": 123,\n \"instructions\": \"<string>\",\n \"carrier_configs\": {\n \"*\": {\n \"signature\": \"adult\",\n \"insurance\": {\n \"amount\": 25000,\n \"currency\": \"usd\"\n }\n },\n \"fedex\": {\n \"service\": \"fedex_international_priority\",\n \"saturday_delivery\": true,\n \"priority_alert\": true\n },\n \"ups\": {}\n },\n \"user_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/pickups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"date\": \"2023-12-25\",\n \"window\": {\n \"ready_at\": \"<string>\",\n \"close_at\": \"<string>\"\n },\n \"connection\": \"<string>\",\n \"contact\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_ids\": [\n {\n \"value\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"access_point\": {\n \"carrier\": \"<string>\",\n \"id\": \"<string>\"\n }\n },\n \"shipments\": [\n \"<string>\"\n ],\n \"handling_unit_count\": 123,\n \"instructions\": \"<string>\",\n \"carrier_configs\": {\n \"*\": {\n \"signature\": \"adult\",\n \"insurance\": {\n \"amount\": 25000,\n \"currency\": \"usd\"\n }\n },\n \"fedex\": {\n \"service\": \"fedex_international_priority\",\n \"saturday_delivery\": true,\n \"priority_alert\": true\n },\n \"ups\": {}\n },\n \"user_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "pck_1Q2w3E4r",
"object": "pickup",
"livemode": true,
"created": 123,
"status": "scheduled",
"connection": "<string>",
"date": "2023-12-25",
"window": {
"ready_at": "<string>",
"close_at": "<string>"
},
"updated": 123,
"carrier": "<string>",
"confirmation_number": "<string>",
"contact": {
"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"
}
},
"timezone": "<string>",
"location": "front_door",
"instructions": "<string>",
"shipments": [
"<string>"
],
"manifest": "<string>",
"handling_unit_count": 123,
"total_weight": {
"value": 123,
"unit": "g"
},
"type": "one_time",
"schedule": "<string>",
"amount": {
"amount": 123,
"currency": "usd"
},
"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>"
}
],
"cancellation": {
"requested_at": 123,
"reason": "<string>",
"carrier_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>"
}
]
}
}Pickups
Book a pickup
POST
/
v1
/
pickups
Book a pickup
curl --request POST \
--url https://api.example.com/v1/pickups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"date": "2023-12-25",
"window": {
"ready_at": "<string>",
"close_at": "<string>"
},
"connection": "<string>",
"contact": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"shipments": [
"<string>"
],
"handling_unit_count": 123,
"instructions": "<string>",
"carrier_configs": {
"*": {
"signature": "adult",
"insurance": {
"amount": 25000,
"currency": "usd"
}
},
"fedex": {
"service": "fedex_international_priority",
"saturday_delivery": true,
"priority_alert": true
},
"ups": {}
},
"user_metadata": {}
}
'import requests
url = "https://api.example.com/v1/pickups"
payload = {
"date": "2023-12-25",
"window": {
"ready_at": "<string>",
"close_at": "<string>"
},
"connection": "<string>",
"contact": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"shipments": ["<string>"],
"handling_unit_count": 123,
"instructions": "<string>",
"carrier_configs": {
"*": {
"signature": "adult",
"insurance": {
"amount": 25000,
"currency": "usd"
}
},
"fedex": {
"service": "fedex_international_priority",
"saturday_delivery": True,
"priority_alert": True
},
"ups": {}
},
"user_metadata": {}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
date: '2023-12-25',
window: {ready_at: '<string>', close_at: '<string>'},
connection: '<string>',
contact: {
name: '<string>',
company: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
tax_ids: [{value: '<string>', country: '<string>'}],
instructions: '<string>',
access_point: {carrier: '<string>', id: '<string>'}
},
shipments: ['<string>'],
handling_unit_count: 123,
instructions: '<string>',
carrier_configs: {
'*': {signature: 'adult', insurance: {amount: 25000, currency: 'usd'}},
fedex: {
service: 'fedex_international_priority',
saturday_delivery: true,
priority_alert: true
},
ups: {}
},
user_metadata: {}
})
};
fetch('https://api.example.com/v1/pickups', 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/pickups",
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([
'date' => '2023-12-25',
'window' => [
'ready_at' => '<string>',
'close_at' => '<string>'
],
'connection' => '<string>',
'contact' => [
'name' => '<string>',
'company' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'tax_ids' => [
[
'value' => '<string>',
'country' => '<string>'
]
],
'instructions' => '<string>',
'access_point' => [
'carrier' => '<string>',
'id' => '<string>'
]
],
'shipments' => [
'<string>'
],
'handling_unit_count' => 123,
'instructions' => '<string>',
'carrier_configs' => [
'*' => [
'signature' => 'adult',
'insurance' => [
'amount' => 25000,
'currency' => 'usd'
]
],
'fedex' => [
'service' => 'fedex_international_priority',
'saturday_delivery' => true,
'priority_alert' => true
],
'ups' => [
]
],
'user_metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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/pickups"
payload := strings.NewReader("{\n \"date\": \"2023-12-25\",\n \"window\": {\n \"ready_at\": \"<string>\",\n \"close_at\": \"<string>\"\n },\n \"connection\": \"<string>\",\n \"contact\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_ids\": [\n {\n \"value\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"access_point\": {\n \"carrier\": \"<string>\",\n \"id\": \"<string>\"\n }\n },\n \"shipments\": [\n \"<string>\"\n ],\n \"handling_unit_count\": 123,\n \"instructions\": \"<string>\",\n \"carrier_configs\": {\n \"*\": {\n \"signature\": \"adult\",\n \"insurance\": {\n \"amount\": 25000,\n \"currency\": \"usd\"\n }\n },\n \"fedex\": {\n \"service\": \"fedex_international_priority\",\n \"saturday_delivery\": true,\n \"priority_alert\": true\n },\n \"ups\": {}\n },\n \"user_metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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/pickups")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"date\": \"2023-12-25\",\n \"window\": {\n \"ready_at\": \"<string>\",\n \"close_at\": \"<string>\"\n },\n \"connection\": \"<string>\",\n \"contact\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_ids\": [\n {\n \"value\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"access_point\": {\n \"carrier\": \"<string>\",\n \"id\": \"<string>\"\n }\n },\n \"shipments\": [\n \"<string>\"\n ],\n \"handling_unit_count\": 123,\n \"instructions\": \"<string>\",\n \"carrier_configs\": {\n \"*\": {\n \"signature\": \"adult\",\n \"insurance\": {\n \"amount\": 25000,\n \"currency\": \"usd\"\n }\n },\n \"fedex\": {\n \"service\": \"fedex_international_priority\",\n \"saturday_delivery\": true,\n \"priority_alert\": true\n },\n \"ups\": {}\n },\n \"user_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/pickups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"date\": \"2023-12-25\",\n \"window\": {\n \"ready_at\": \"<string>\",\n \"close_at\": \"<string>\"\n },\n \"connection\": \"<string>\",\n \"contact\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_ids\": [\n {\n \"value\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"access_point\": {\n \"carrier\": \"<string>\",\n \"id\": \"<string>\"\n }\n },\n \"shipments\": [\n \"<string>\"\n ],\n \"handling_unit_count\": 123,\n \"instructions\": \"<string>\",\n \"carrier_configs\": {\n \"*\": {\n \"signature\": \"adult\",\n \"insurance\": {\n \"amount\": 25000,\n \"currency\": \"usd\"\n }\n },\n \"fedex\": {\n \"service\": \"fedex_international_priority\",\n \"saturday_delivery\": true,\n \"priority_alert\": true\n },\n \"ups\": {}\n },\n \"user_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "pck_1Q2w3E4r",
"object": "pickup",
"livemode": true,
"created": 123,
"status": "scheduled",
"connection": "<string>",
"date": "2023-12-25",
"window": {
"ready_at": "<string>",
"close_at": "<string>"
},
"updated": 123,
"carrier": "<string>",
"confirmation_number": "<string>",
"contact": {
"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"
}
},
"timezone": "<string>",
"location": "front_door",
"instructions": "<string>",
"shipments": [
"<string>"
],
"manifest": "<string>",
"handling_unit_count": 123,
"total_weight": {
"value": 123,
"unit": "g"
},
"type": "one_time",
"schedule": "<string>",
"amount": {
"amount": 123,
"currency": "usd"
},
"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>"
}
],
"cancellation": {
"requested_at": 123,
"reason": "<string>",
"carrier_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
Show child attributes
Show child attributes
A party to a shipment. Either name or company is required. address is required on ship_from, ship_to, return_to, bill_to.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
front_door, back_door, side_door, front_desk, reception, mailroom, loading_dock, garage, other Product and feature configuration. '*' applies standardized features to every rated carrier; each other key selects a carrier.
Show child attributes
Show child attributes
Example:
{
"*": {
"signature": "adult",
"insurance": { "amount": 25000, "currency": "usd" }
},
"fedex": {
"service": "fedex_international_priority",
"saturday_delivery": true,
"priority_alert": true
},
"ups": {}
}
Client-writable. Up to 50 string key/value pairs. Never sent to carriers.
Show child attributes
Show child attributes
Response
OK
Prefixed pck_
Example:
"pck_1Q2w3E4r"
Available options:
pickup Unix timestamp (seconds)
Available options:
scheduled, rescheduled, completed, missed, cancelled, failed Show child attributes
Show child attributes
Unix timestamp (seconds)
A party to a shipment. Either name or company is required. address is required on ship_from, ship_to, return_to, bill_to.
Show child attributes
Show child attributes
Available options:
front_door, back_door, side_door, front_desk, reception, mailroom, loading_dock, garage, other ID (mfst_...). Expandable to Manifest.
Show child attributes
Show child attributes
Available options:
one_time, scheduled ID (psch_...). Expandable to PickupSchedule.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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