Inject canonical events
curl --request POST \
--url https://api.example.com/v1/inbound_events \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tracker": "<string>",
"carrier": "<string>",
"tracking_number": "<string>",
"create_tracker": true,
"events": [
{
"occurred_at": "2023-11-07T05:31:56Z",
"status_detail": "<string>",
"description": "<string>",
"carrier_code": "<string>",
"location": {
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"facility": "<string>",
"latitude": 123,
"longitude": 123
},
"proof_of_delivery": {
"signed_by": "<string>",
"signature_file": "<string>",
"photo_files": [
"<string>"
],
"location": {
"latitude": 123,
"longitude": 123
},
"delivered_to": "<string>"
}
}
],
"shipment": "<string>",
"charges": [
{
"kind": "<string>",
"carrier_code": "<string>",
"reason": "<string>"
}
]
}
'import requests
url = "https://api.example.com/v1/inbound_events"
payload = {
"tracker": "<string>",
"carrier": "<string>",
"tracking_number": "<string>",
"create_tracker": True,
"events": [
{
"occurred_at": "2023-11-07T05:31:56Z",
"status_detail": "<string>",
"description": "<string>",
"carrier_code": "<string>",
"location": {
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"facility": "<string>",
"latitude": 123,
"longitude": 123
},
"proof_of_delivery": {
"signed_by": "<string>",
"signature_file": "<string>",
"photo_files": ["<string>"],
"location": {
"latitude": 123,
"longitude": 123
},
"delivered_to": "<string>"
}
}
],
"shipment": "<string>",
"charges": [
{
"kind": "<string>",
"carrier_code": "<string>",
"reason": "<string>"
}
]
}
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({
tracker: '<string>',
carrier: '<string>',
tracking_number: '<string>',
create_tracker: true,
events: [
{
occurred_at: '2023-11-07T05:31:56Z',
status_detail: '<string>',
description: '<string>',
carrier_code: '<string>',
location: {
city: '<string>',
state: '<string>',
postal_code: '<string>',
country: '<string>',
facility: '<string>',
latitude: 123,
longitude: 123
},
proof_of_delivery: {
signed_by: '<string>',
signature_file: '<string>',
photo_files: ['<string>'],
location: {latitude: 123, longitude: 123},
delivered_to: '<string>'
}
}
],
shipment: '<string>',
charges: [{kind: '<string>', carrier_code: '<string>', reason: '<string>'}]
})
};
fetch('https://api.example.com/v1/inbound_events', 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/inbound_events",
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([
'tracker' => '<string>',
'carrier' => '<string>',
'tracking_number' => '<string>',
'create_tracker' => true,
'events' => [
[
'occurred_at' => '2023-11-07T05:31:56Z',
'status_detail' => '<string>',
'description' => '<string>',
'carrier_code' => '<string>',
'location' => [
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>',
'facility' => '<string>',
'latitude' => 123,
'longitude' => 123
],
'proof_of_delivery' => [
'signed_by' => '<string>',
'signature_file' => '<string>',
'photo_files' => [
'<string>'
],
'location' => [
'latitude' => 123,
'longitude' => 123
],
'delivered_to' => '<string>'
]
]
],
'shipment' => '<string>',
'charges' => [
[
'kind' => '<string>',
'carrier_code' => '<string>',
'reason' => '<string>'
]
]
]),
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/inbound_events"
payload := strings.NewReader("{\n \"tracker\": \"<string>\",\n \"carrier\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"create_tracker\": true,\n \"events\": [\n {\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"status_detail\": \"<string>\",\n \"description\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"location\": {\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"facility\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"proof_of_delivery\": {\n \"signed_by\": \"<string>\",\n \"signature_file\": \"<string>\",\n \"photo_files\": [\n \"<string>\"\n ],\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"delivered_to\": \"<string>\"\n }\n }\n ],\n \"shipment\": \"<string>\",\n \"charges\": [\n {\n \"kind\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\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/inbound_events")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tracker\": \"<string>\",\n \"carrier\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"create_tracker\": true,\n \"events\": [\n {\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"status_detail\": \"<string>\",\n \"description\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"location\": {\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"facility\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"proof_of_delivery\": {\n \"signed_by\": \"<string>\",\n \"signature_file\": \"<string>\",\n \"photo_files\": [\n \"<string>\"\n ],\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"delivered_to\": \"<string>\"\n }\n }\n ],\n \"shipment\": \"<string>\",\n \"charges\": [\n {\n \"kind\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/inbound_events")
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 \"tracker\": \"<string>\",\n \"carrier\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"create_tracker\": true,\n \"events\": [\n {\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"status_detail\": \"<string>\",\n \"description\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"location\": {\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"facility\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"proof_of_delivery\": {\n \"signed_by\": \"<string>\",\n \"signature_file\": \"<string>\",\n \"photo_files\": [\n \"<string>\"\n ],\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"delivered_to\": \"<string>\"\n }\n }\n ],\n \"shipment\": \"<string>\",\n \"charges\": [\n {\n \"kind\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "ibe_1Q2w3E4r",
"object": "inbound_event",
"livemode": true,
"created": 123,
"type": "tracking",
"status": "processed",
"updated": 123,
"source": "api",
"connection": "<string>",
"tracker": "<string>",
"shipment": "<string>",
"accepted": 123,
"rejected": 123,
"errors": [
{
"index": 123,
"code": "<string>",
"message": "<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>"
}
]
}
}Inbound
Inject canonical events
POST
/
v1
/
inbound_events
Inject canonical events
curl --request POST \
--url https://api.example.com/v1/inbound_events \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tracker": "<string>",
"carrier": "<string>",
"tracking_number": "<string>",
"create_tracker": true,
"events": [
{
"occurred_at": "2023-11-07T05:31:56Z",
"status_detail": "<string>",
"description": "<string>",
"carrier_code": "<string>",
"location": {
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"facility": "<string>",
"latitude": 123,
"longitude": 123
},
"proof_of_delivery": {
"signed_by": "<string>",
"signature_file": "<string>",
"photo_files": [
"<string>"
],
"location": {
"latitude": 123,
"longitude": 123
},
"delivered_to": "<string>"
}
}
],
"shipment": "<string>",
"charges": [
{
"kind": "<string>",
"carrier_code": "<string>",
"reason": "<string>"
}
]
}
'import requests
url = "https://api.example.com/v1/inbound_events"
payload = {
"tracker": "<string>",
"carrier": "<string>",
"tracking_number": "<string>",
"create_tracker": True,
"events": [
{
"occurred_at": "2023-11-07T05:31:56Z",
"status_detail": "<string>",
"description": "<string>",
"carrier_code": "<string>",
"location": {
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"facility": "<string>",
"latitude": 123,
"longitude": 123
},
"proof_of_delivery": {
"signed_by": "<string>",
"signature_file": "<string>",
"photo_files": ["<string>"],
"location": {
"latitude": 123,
"longitude": 123
},
"delivered_to": "<string>"
}
}
],
"shipment": "<string>",
"charges": [
{
"kind": "<string>",
"carrier_code": "<string>",
"reason": "<string>"
}
]
}
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({
tracker: '<string>',
carrier: '<string>',
tracking_number: '<string>',
create_tracker: true,
events: [
{
occurred_at: '2023-11-07T05:31:56Z',
status_detail: '<string>',
description: '<string>',
carrier_code: '<string>',
location: {
city: '<string>',
state: '<string>',
postal_code: '<string>',
country: '<string>',
facility: '<string>',
latitude: 123,
longitude: 123
},
proof_of_delivery: {
signed_by: '<string>',
signature_file: '<string>',
photo_files: ['<string>'],
location: {latitude: 123, longitude: 123},
delivered_to: '<string>'
}
}
],
shipment: '<string>',
charges: [{kind: '<string>', carrier_code: '<string>', reason: '<string>'}]
})
};
fetch('https://api.example.com/v1/inbound_events', 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/inbound_events",
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([
'tracker' => '<string>',
'carrier' => '<string>',
'tracking_number' => '<string>',
'create_tracker' => true,
'events' => [
[
'occurred_at' => '2023-11-07T05:31:56Z',
'status_detail' => '<string>',
'description' => '<string>',
'carrier_code' => '<string>',
'location' => [
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>',
'facility' => '<string>',
'latitude' => 123,
'longitude' => 123
],
'proof_of_delivery' => [
'signed_by' => '<string>',
'signature_file' => '<string>',
'photo_files' => [
'<string>'
],
'location' => [
'latitude' => 123,
'longitude' => 123
],
'delivered_to' => '<string>'
]
]
],
'shipment' => '<string>',
'charges' => [
[
'kind' => '<string>',
'carrier_code' => '<string>',
'reason' => '<string>'
]
]
]),
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/inbound_events"
payload := strings.NewReader("{\n \"tracker\": \"<string>\",\n \"carrier\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"create_tracker\": true,\n \"events\": [\n {\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"status_detail\": \"<string>\",\n \"description\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"location\": {\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"facility\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"proof_of_delivery\": {\n \"signed_by\": \"<string>\",\n \"signature_file\": \"<string>\",\n \"photo_files\": [\n \"<string>\"\n ],\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"delivered_to\": \"<string>\"\n }\n }\n ],\n \"shipment\": \"<string>\",\n \"charges\": [\n {\n \"kind\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\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/inbound_events")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tracker\": \"<string>\",\n \"carrier\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"create_tracker\": true,\n \"events\": [\n {\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"status_detail\": \"<string>\",\n \"description\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"location\": {\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"facility\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"proof_of_delivery\": {\n \"signed_by\": \"<string>\",\n \"signature_file\": \"<string>\",\n \"photo_files\": [\n \"<string>\"\n ],\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"delivered_to\": \"<string>\"\n }\n }\n ],\n \"shipment\": \"<string>\",\n \"charges\": [\n {\n \"kind\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/inbound_events")
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 \"tracker\": \"<string>\",\n \"carrier\": \"<string>\",\n \"tracking_number\": \"<string>\",\n \"create_tracker\": true,\n \"events\": [\n {\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"status_detail\": \"<string>\",\n \"description\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"location\": {\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\",\n \"facility\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"proof_of_delivery\": {\n \"signed_by\": \"<string>\",\n \"signature_file\": \"<string>\",\n \"photo_files\": [\n \"<string>\"\n ],\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123\n },\n \"delivered_to\": \"<string>\"\n }\n }\n ],\n \"shipment\": \"<string>\",\n \"charges\": [\n {\n \"kind\": \"<string>\",\n \"carrier_code\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "ibe_1Q2w3E4r",
"object": "inbound_event",
"livemode": true,
"created": 123,
"type": "tracking",
"status": "processed",
"updated": 123,
"source": "api",
"connection": "<string>",
"tracker": "<string>",
"shipment": "<string>",
"accepted": 123,
"rejected": 123,
"errors": [
{
"index": 123,
"code": "<string>",
"message": "<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
Response
OK
Prefixed ibe_
Example:
"ibe_1Q2w3E4r"
Available options:
inbound_event Unix timestamp (seconds)
Available options:
tracking, shipment_charge Available options:
processed, partially_processed, failed Unix timestamp (seconds)
Available options:
api, carrier_push 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