Plan a journey
curl --request POST \
--url https://api.example.com/v1/journeys/plan \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ship_from": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"ship_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"handling_units": [
{
"weight": {
"value": 123
},
"type": "parcel",
"conditions": {
"temperature": {
"min": {
"value": 123,
"unit": "<string>"
},
"max": {
"value": 123,
"unit": "<string>"
}
},
"shock": {
"max": {
"value": 123,
"unit": "<string>"
}
},
"tilt": {
"max_degrees": 123
}
},
"packaging": "<string>",
"freight": {
"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>",
"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,
"eccn": "<string>",
"license": {
"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_instruction": "<string>",
"section": "<string>",
"lithium": {
"watt_hours": 123,
"lithium_grams": 123,
"cells": 123
},
"excepted_quantity": true,
"limited_quantity": true,
"emergency_contact": {
"name": "<string>",
"phone": "<string>"
},
"declaration_document": "<string>"
},
"product": "<string>",
"user_metadata": {}
}
]
}
],
"service": "<string>",
"ship_date": "2023-12-25"
}
'import requests
url = "https://api.example.com/v1/journeys/plan"
payload = {
"ship_from": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"ship_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"handling_units": [
{
"weight": { "value": 123 },
"type": "parcel",
"conditions": {
"temperature": {
"min": {
"value": 123,
"unit": "<string>"
},
"max": {
"value": 123,
"unit": "<string>"
}
},
"shock": { "max": {
"value": 123,
"unit": "<string>"
} },
"tilt": { "max_degrees": 123 }
},
"packaging": "<string>",
"freight": {
"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>",
"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,
"eccn": "<string>",
"license": {
"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_instruction": "<string>",
"section": "<string>",
"lithium": {
"watt_hours": 123,
"lithium_grams": 123,
"cells": 123
},
"excepted_quantity": True,
"limited_quantity": True,
"emergency_contact": {
"name": "<string>",
"phone": "<string>"
},
"declaration_document": "<string>"
},
"product": "<string>",
"user_metadata": {}
}
]
}
],
"service": "<string>",
"ship_date": "2023-12-25"
}
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({
ship_from: {
name: '<string>',
company: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
tax_ids: [{value: '<string>', country: '<string>'}],
instructions: '<string>',
access_point: {carrier: '<string>', id: '<string>'}
},
ship_to: {
name: '<string>',
company: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
tax_ids: [{value: '<string>', country: '<string>'}],
instructions: '<string>',
access_point: {carrier: '<string>', id: '<string>'}
},
handling_units: [
{
weight: {value: 123},
type: 'parcel',
conditions: {
temperature: {min: {value: 123, unit: '<string>'}, max: {value: 123, unit: '<string>'}},
shock: {max: {value: 123, unit: '<string>'}},
tilt: {max_degrees: 123}
},
packaging: '<string>',
freight: {
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>',
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,
eccn: '<string>',
license: {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_instruction: '<string>',
section: '<string>',
lithium: {watt_hours: 123, lithium_grams: 123, cells: 123},
excepted_quantity: true,
limited_quantity: true,
emergency_contact: {name: '<string>', phone: '<string>'},
declaration_document: '<string>'
},
product: '<string>',
user_metadata: {}
}
]
}
],
service: '<string>',
ship_date: '2023-12-25'
})
};
fetch('https://api.example.com/v1/journeys/plan', 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/journeys/plan",
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([
'ship_from' => [
'name' => '<string>',
'company' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'tax_ids' => [
[
'value' => '<string>',
'country' => '<string>'
]
],
'instructions' => '<string>',
'access_point' => [
'carrier' => '<string>',
'id' => '<string>'
]
],
'ship_to' => [
'name' => '<string>',
'company' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'tax_ids' => [
[
'value' => '<string>',
'country' => '<string>'
]
],
'instructions' => '<string>',
'access_point' => [
'carrier' => '<string>',
'id' => '<string>'
]
],
'handling_units' => [
[
'weight' => [
'value' => 123
],
'type' => 'parcel',
'conditions' => [
'temperature' => [
'min' => [
'value' => 123,
'unit' => '<string>'
],
'max' => [
'value' => 123,
'unit' => '<string>'
]
],
'shock' => [
'max' => [
'value' => 123,
'unit' => '<string>'
]
],
'tilt' => [
'max_degrees' => 123
]
],
'packaging' => '<string>',
'freight' => [
'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>',
'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,
'eccn' => '<string>',
'license' => [
'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_instruction' => '<string>',
'section' => '<string>',
'lithium' => [
'watt_hours' => 123,
'lithium_grams' => 123,
'cells' => 123
],
'excepted_quantity' => true,
'limited_quantity' => true,
'emergency_contact' => [
'name' => '<string>',
'phone' => '<string>'
],
'declaration_document' => '<string>'
],
'product' => '<string>',
'user_metadata' => [
]
]
]
]
],
'service' => '<string>',
'ship_date' => '2023-12-25'
]),
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/journeys/plan"
payload := strings.NewReader("{\n \"ship_from\": {\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 \"ship_to\": {\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 \"handling_units\": [\n {\n \"weight\": {\n \"value\": 123\n },\n \"type\": \"parcel\",\n \"conditions\": {\n \"temperature\": {\n \"min\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"max\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n },\n \"shock\": {\n \"max\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n },\n \"tilt\": {\n \"max_degrees\": 123\n }\n },\n \"packaging\": \"<string>\",\n \"freight\": {\n \"stackable\": true,\n \"piece_count\": 123,\n \"freight_class\": \"<string>\",\n \"nmfc_code\": \"<string>\",\n \"hazmat_placard\": true\n },\n \"reference\": \"<string>\",\n \"description\": \"<string>\",\n \"items\": [\n {\n \"quantity\": 2,\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"export_hs_code\": \"<string>\",\n \"import_hs_code\": \"<string>\",\n \"category\": \"<string>\",\n \"product_url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"order_line_id\": \"<string>\",\n \"brand\": \"<string>\",\n \"material\": \"<string>\",\n \"manufacturer\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"mid\": \"<string>\"\n },\n \"compliance\": {\n \"controlled\": true,\n \"eccn\": \"<string>\",\n \"license\": {\n \"number\": \"<string>\",\n \"expires_on\": \"2023-12-25\"\n },\n \"regulatory_agency\": \"<string>\",\n \"regulatory_program\": \"<string>\",\n \"regulatory_category_code\": \"<string>\",\n \"certification\": {\n \"type\": \"<string>\",\n \"reference\": \"<string>\"\n }\n },\n \"dangerous_goods\": {\n \"class\": \"<string>\",\n \"un_number\": \"<string>\",\n \"proper_shipping_name\": \"<string>\",\n \"packing_instruction\": \"<string>\",\n \"section\": \"<string>\",\n \"lithium\": {\n \"watt_hours\": 123,\n \"lithium_grams\": 123,\n \"cells\": 123\n },\n \"excepted_quantity\": true,\n \"limited_quantity\": true,\n \"emergency_contact\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"declaration_document\": \"<string>\"\n },\n \"product\": \"<string>\",\n \"user_metadata\": {}\n }\n ]\n }\n ],\n \"service\": \"<string>\",\n \"ship_date\": \"2023-12-25\"\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/journeys/plan")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ship_from\": {\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 \"ship_to\": {\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 \"handling_units\": [\n {\n \"weight\": {\n \"value\": 123\n },\n \"type\": \"parcel\",\n \"conditions\": {\n \"temperature\": {\n \"min\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"max\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n },\n \"shock\": {\n \"max\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n },\n \"tilt\": {\n \"max_degrees\": 123\n }\n },\n \"packaging\": \"<string>\",\n \"freight\": {\n \"stackable\": true,\n \"piece_count\": 123,\n \"freight_class\": \"<string>\",\n \"nmfc_code\": \"<string>\",\n \"hazmat_placard\": true\n },\n \"reference\": \"<string>\",\n \"description\": \"<string>\",\n \"items\": [\n {\n \"quantity\": 2,\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"export_hs_code\": \"<string>\",\n \"import_hs_code\": \"<string>\",\n \"category\": \"<string>\",\n \"product_url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"order_line_id\": \"<string>\",\n \"brand\": \"<string>\",\n \"material\": \"<string>\",\n \"manufacturer\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"mid\": \"<string>\"\n },\n \"compliance\": {\n \"controlled\": true,\n \"eccn\": \"<string>\",\n \"license\": {\n \"number\": \"<string>\",\n \"expires_on\": \"2023-12-25\"\n },\n \"regulatory_agency\": \"<string>\",\n \"regulatory_program\": \"<string>\",\n \"regulatory_category_code\": \"<string>\",\n \"certification\": {\n \"type\": \"<string>\",\n \"reference\": \"<string>\"\n }\n },\n \"dangerous_goods\": {\n \"class\": \"<string>\",\n \"un_number\": \"<string>\",\n \"proper_shipping_name\": \"<string>\",\n \"packing_instruction\": \"<string>\",\n \"section\": \"<string>\",\n \"lithium\": {\n \"watt_hours\": 123,\n \"lithium_grams\": 123,\n \"cells\": 123\n },\n \"excepted_quantity\": true,\n \"limited_quantity\": true,\n \"emergency_contact\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"declaration_document\": \"<string>\"\n },\n \"product\": \"<string>\",\n \"user_metadata\": {}\n }\n ]\n }\n ],\n \"service\": \"<string>\",\n \"ship_date\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/journeys/plan")
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 \"ship_from\": {\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 \"ship_to\": {\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 \"handling_units\": [\n {\n \"weight\": {\n \"value\": 123\n },\n \"type\": \"parcel\",\n \"conditions\": {\n \"temperature\": {\n \"min\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"max\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n },\n \"shock\": {\n \"max\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n },\n \"tilt\": {\n \"max_degrees\": 123\n }\n },\n \"packaging\": \"<string>\",\n \"freight\": {\n \"stackable\": true,\n \"piece_count\": 123,\n \"freight_class\": \"<string>\",\n \"nmfc_code\": \"<string>\",\n \"hazmat_placard\": true\n },\n \"reference\": \"<string>\",\n \"description\": \"<string>\",\n \"items\": [\n {\n \"quantity\": 2,\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"export_hs_code\": \"<string>\",\n \"import_hs_code\": \"<string>\",\n \"category\": \"<string>\",\n \"product_url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"order_line_id\": \"<string>\",\n \"brand\": \"<string>\",\n \"material\": \"<string>\",\n \"manufacturer\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"mid\": \"<string>\"\n },\n \"compliance\": {\n \"controlled\": true,\n \"eccn\": \"<string>\",\n \"license\": {\n \"number\": \"<string>\",\n \"expires_on\": \"2023-12-25\"\n },\n \"regulatory_agency\": \"<string>\",\n \"regulatory_program\": \"<string>\",\n \"regulatory_category_code\": \"<string>\",\n \"certification\": {\n \"type\": \"<string>\",\n \"reference\": \"<string>\"\n }\n },\n \"dangerous_goods\": {\n \"class\": \"<string>\",\n \"un_number\": \"<string>\",\n \"proper_shipping_name\": \"<string>\",\n \"packing_instruction\": \"<string>\",\n \"section\": \"<string>\",\n \"lithium\": {\n \"watt_hours\": 123,\n \"lithium_grams\": 123,\n \"cells\": 123\n },\n \"excepted_quantity\": true,\n \"limited_quantity\": true,\n \"emergency_contact\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"declaration_document\": \"<string>\"\n },\n \"product\": \"<string>\",\n \"user_metadata\": {}\n }\n ]\n }\n ],\n \"service\": \"<string>\",\n \"ship_date\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"object": "journey",
"status": "planned",
"segments": [
{
"sequence": 123,
"type": "first_mile",
"run": "<string>",
"leg": "<string>",
"operator": {
"type": "self",
"connection": "<string>",
"service": "<string>",
"name": "<string>",
"reference": "<string>"
},
"from": "<string>",
"to": "<string>",
"planned_departure": "<string>",
"planned_arrival": "<string>",
"actual_departure": "<string>",
"actual_arrival": "<string>",
"subcontracted_shipment": "<string>"
}
],
"id": "<string>",
"shipment": "<string>",
"planned_delivery": "2023-12-25",
"estimated_delivery": "2023-12-25"
}{
"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>"
}
]
}
}Routes
Plan a journey
POST
/
v1
/
journeys
/
plan
Plan a journey
curl --request POST \
--url https://api.example.com/v1/journeys/plan \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ship_from": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"ship_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"handling_units": [
{
"weight": {
"value": 123
},
"type": "parcel",
"conditions": {
"temperature": {
"min": {
"value": 123,
"unit": "<string>"
},
"max": {
"value": 123,
"unit": "<string>"
}
},
"shock": {
"max": {
"value": 123,
"unit": "<string>"
}
},
"tilt": {
"max_degrees": 123
}
},
"packaging": "<string>",
"freight": {
"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>",
"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,
"eccn": "<string>",
"license": {
"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_instruction": "<string>",
"section": "<string>",
"lithium": {
"watt_hours": 123,
"lithium_grams": 123,
"cells": 123
},
"excepted_quantity": true,
"limited_quantity": true,
"emergency_contact": {
"name": "<string>",
"phone": "<string>"
},
"declaration_document": "<string>"
},
"product": "<string>",
"user_metadata": {}
}
]
}
],
"service": "<string>",
"ship_date": "2023-12-25"
}
'import requests
url = "https://api.example.com/v1/journeys/plan"
payload = {
"ship_from": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"ship_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"handling_units": [
{
"weight": { "value": 123 },
"type": "parcel",
"conditions": {
"temperature": {
"min": {
"value": 123,
"unit": "<string>"
},
"max": {
"value": 123,
"unit": "<string>"
}
},
"shock": { "max": {
"value": 123,
"unit": "<string>"
} },
"tilt": { "max_degrees": 123 }
},
"packaging": "<string>",
"freight": {
"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>",
"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,
"eccn": "<string>",
"license": {
"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_instruction": "<string>",
"section": "<string>",
"lithium": {
"watt_hours": 123,
"lithium_grams": 123,
"cells": 123
},
"excepted_quantity": True,
"limited_quantity": True,
"emergency_contact": {
"name": "<string>",
"phone": "<string>"
},
"declaration_document": "<string>"
},
"product": "<string>",
"user_metadata": {}
}
]
}
],
"service": "<string>",
"ship_date": "2023-12-25"
}
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({
ship_from: {
name: '<string>',
company: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
tax_ids: [{value: '<string>', country: '<string>'}],
instructions: '<string>',
access_point: {carrier: '<string>', id: '<string>'}
},
ship_to: {
name: '<string>',
company: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
tax_ids: [{value: '<string>', country: '<string>'}],
instructions: '<string>',
access_point: {carrier: '<string>', id: '<string>'}
},
handling_units: [
{
weight: {value: 123},
type: 'parcel',
conditions: {
temperature: {min: {value: 123, unit: '<string>'}, max: {value: 123, unit: '<string>'}},
shock: {max: {value: 123, unit: '<string>'}},
tilt: {max_degrees: 123}
},
packaging: '<string>',
freight: {
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>',
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,
eccn: '<string>',
license: {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_instruction: '<string>',
section: '<string>',
lithium: {watt_hours: 123, lithium_grams: 123, cells: 123},
excepted_quantity: true,
limited_quantity: true,
emergency_contact: {name: '<string>', phone: '<string>'},
declaration_document: '<string>'
},
product: '<string>',
user_metadata: {}
}
]
}
],
service: '<string>',
ship_date: '2023-12-25'
})
};
fetch('https://api.example.com/v1/journeys/plan', 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/journeys/plan",
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([
'ship_from' => [
'name' => '<string>',
'company' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'tax_ids' => [
[
'value' => '<string>',
'country' => '<string>'
]
],
'instructions' => '<string>',
'access_point' => [
'carrier' => '<string>',
'id' => '<string>'
]
],
'ship_to' => [
'name' => '<string>',
'company' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'tax_ids' => [
[
'value' => '<string>',
'country' => '<string>'
]
],
'instructions' => '<string>',
'access_point' => [
'carrier' => '<string>',
'id' => '<string>'
]
],
'handling_units' => [
[
'weight' => [
'value' => 123
],
'type' => 'parcel',
'conditions' => [
'temperature' => [
'min' => [
'value' => 123,
'unit' => '<string>'
],
'max' => [
'value' => 123,
'unit' => '<string>'
]
],
'shock' => [
'max' => [
'value' => 123,
'unit' => '<string>'
]
],
'tilt' => [
'max_degrees' => 123
]
],
'packaging' => '<string>',
'freight' => [
'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>',
'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,
'eccn' => '<string>',
'license' => [
'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_instruction' => '<string>',
'section' => '<string>',
'lithium' => [
'watt_hours' => 123,
'lithium_grams' => 123,
'cells' => 123
],
'excepted_quantity' => true,
'limited_quantity' => true,
'emergency_contact' => [
'name' => '<string>',
'phone' => '<string>'
],
'declaration_document' => '<string>'
],
'product' => '<string>',
'user_metadata' => [
]
]
]
]
],
'service' => '<string>',
'ship_date' => '2023-12-25'
]),
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/journeys/plan"
payload := strings.NewReader("{\n \"ship_from\": {\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 \"ship_to\": {\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 \"handling_units\": [\n {\n \"weight\": {\n \"value\": 123\n },\n \"type\": \"parcel\",\n \"conditions\": {\n \"temperature\": {\n \"min\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"max\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n },\n \"shock\": {\n \"max\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n },\n \"tilt\": {\n \"max_degrees\": 123\n }\n },\n \"packaging\": \"<string>\",\n \"freight\": {\n \"stackable\": true,\n \"piece_count\": 123,\n \"freight_class\": \"<string>\",\n \"nmfc_code\": \"<string>\",\n \"hazmat_placard\": true\n },\n \"reference\": \"<string>\",\n \"description\": \"<string>\",\n \"items\": [\n {\n \"quantity\": 2,\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"export_hs_code\": \"<string>\",\n \"import_hs_code\": \"<string>\",\n \"category\": \"<string>\",\n \"product_url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"order_line_id\": \"<string>\",\n \"brand\": \"<string>\",\n \"material\": \"<string>\",\n \"manufacturer\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"mid\": \"<string>\"\n },\n \"compliance\": {\n \"controlled\": true,\n \"eccn\": \"<string>\",\n \"license\": {\n \"number\": \"<string>\",\n \"expires_on\": \"2023-12-25\"\n },\n \"regulatory_agency\": \"<string>\",\n \"regulatory_program\": \"<string>\",\n \"regulatory_category_code\": \"<string>\",\n \"certification\": {\n \"type\": \"<string>\",\n \"reference\": \"<string>\"\n }\n },\n \"dangerous_goods\": {\n \"class\": \"<string>\",\n \"un_number\": \"<string>\",\n \"proper_shipping_name\": \"<string>\",\n \"packing_instruction\": \"<string>\",\n \"section\": \"<string>\",\n \"lithium\": {\n \"watt_hours\": 123,\n \"lithium_grams\": 123,\n \"cells\": 123\n },\n \"excepted_quantity\": true,\n \"limited_quantity\": true,\n \"emergency_contact\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"declaration_document\": \"<string>\"\n },\n \"product\": \"<string>\",\n \"user_metadata\": {}\n }\n ]\n }\n ],\n \"service\": \"<string>\",\n \"ship_date\": \"2023-12-25\"\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/journeys/plan")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ship_from\": {\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 \"ship_to\": {\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 \"handling_units\": [\n {\n \"weight\": {\n \"value\": 123\n },\n \"type\": \"parcel\",\n \"conditions\": {\n \"temperature\": {\n \"min\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"max\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n },\n \"shock\": {\n \"max\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n },\n \"tilt\": {\n \"max_degrees\": 123\n }\n },\n \"packaging\": \"<string>\",\n \"freight\": {\n \"stackable\": true,\n \"piece_count\": 123,\n \"freight_class\": \"<string>\",\n \"nmfc_code\": \"<string>\",\n \"hazmat_placard\": true\n },\n \"reference\": \"<string>\",\n \"description\": \"<string>\",\n \"items\": [\n {\n \"quantity\": 2,\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"export_hs_code\": \"<string>\",\n \"import_hs_code\": \"<string>\",\n \"category\": \"<string>\",\n \"product_url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"order_line_id\": \"<string>\",\n \"brand\": \"<string>\",\n \"material\": \"<string>\",\n \"manufacturer\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"mid\": \"<string>\"\n },\n \"compliance\": {\n \"controlled\": true,\n \"eccn\": \"<string>\",\n \"license\": {\n \"number\": \"<string>\",\n \"expires_on\": \"2023-12-25\"\n },\n \"regulatory_agency\": \"<string>\",\n \"regulatory_program\": \"<string>\",\n \"regulatory_category_code\": \"<string>\",\n \"certification\": {\n \"type\": \"<string>\",\n \"reference\": \"<string>\"\n }\n },\n \"dangerous_goods\": {\n \"class\": \"<string>\",\n \"un_number\": \"<string>\",\n \"proper_shipping_name\": \"<string>\",\n \"packing_instruction\": \"<string>\",\n \"section\": \"<string>\",\n \"lithium\": {\n \"watt_hours\": 123,\n \"lithium_grams\": 123,\n \"cells\": 123\n },\n \"excepted_quantity\": true,\n \"limited_quantity\": true,\n \"emergency_contact\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"declaration_document\": \"<string>\"\n },\n \"product\": \"<string>\",\n \"user_metadata\": {}\n }\n ]\n }\n ],\n \"service\": \"<string>\",\n \"ship_date\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/journeys/plan")
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 \"ship_from\": {\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 \"ship_to\": {\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 \"handling_units\": [\n {\n \"weight\": {\n \"value\": 123\n },\n \"type\": \"parcel\",\n \"conditions\": {\n \"temperature\": {\n \"min\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n },\n \"max\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n },\n \"shock\": {\n \"max\": {\n \"value\": 123,\n \"unit\": \"<string>\"\n }\n },\n \"tilt\": {\n \"max_degrees\": 123\n }\n },\n \"packaging\": \"<string>\",\n \"freight\": {\n \"stackable\": true,\n \"piece_count\": 123,\n \"freight_class\": \"<string>\",\n \"nmfc_code\": \"<string>\",\n \"hazmat_placard\": true\n },\n \"reference\": \"<string>\",\n \"description\": \"<string>\",\n \"items\": [\n {\n \"quantity\": 2,\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"export_hs_code\": \"<string>\",\n \"import_hs_code\": \"<string>\",\n \"category\": \"<string>\",\n \"product_url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"order_line_id\": \"<string>\",\n \"brand\": \"<string>\",\n \"material\": \"<string>\",\n \"manufacturer\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"mid\": \"<string>\"\n },\n \"compliance\": {\n \"controlled\": true,\n \"eccn\": \"<string>\",\n \"license\": {\n \"number\": \"<string>\",\n \"expires_on\": \"2023-12-25\"\n },\n \"regulatory_agency\": \"<string>\",\n \"regulatory_program\": \"<string>\",\n \"regulatory_category_code\": \"<string>\",\n \"certification\": {\n \"type\": \"<string>\",\n \"reference\": \"<string>\"\n }\n },\n \"dangerous_goods\": {\n \"class\": \"<string>\",\n \"un_number\": \"<string>\",\n \"proper_shipping_name\": \"<string>\",\n \"packing_instruction\": \"<string>\",\n \"section\": \"<string>\",\n \"lithium\": {\n \"watt_hours\": 123,\n \"lithium_grams\": 123,\n \"cells\": 123\n },\n \"excepted_quantity\": true,\n \"limited_quantity\": true,\n \"emergency_contact\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"declaration_document\": \"<string>\"\n },\n \"product\": \"<string>\",\n \"user_metadata\": {}\n }\n ]\n }\n ],\n \"service\": \"<string>\",\n \"ship_date\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"object": "journey",
"status": "planned",
"segments": [
{
"sequence": 123,
"type": "first_mile",
"run": "<string>",
"leg": "<string>",
"operator": {
"type": "self",
"connection": "<string>",
"service": "<string>",
"name": "<string>",
"reference": "<string>"
},
"from": "<string>",
"to": "<string>",
"planned_departure": "<string>",
"planned_arrival": "<string>",
"actual_departure": "<string>",
"actual_arrival": "<string>",
"subcontracted_shipment": "<string>"
}
],
"id": "<string>",
"shipment": "<string>",
"planned_delivery": "2023-12-25",
"estimated_delivery": "2023-12-25"
}{
"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_...)
Body
application/json
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
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
Response
OK
Available options:
journey Available options:
planned, on_track, at_risk, delayed, rerouted, completed Show child attributes
Show child attributes