Update a Shipment
curl --request POST \
--url https://api.example.com/v1/shipments/{id} \
--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>"
}
},
"return_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>"
}
},
"bill_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>"
}
},
"billing": {
"paid_by": "sender",
"account_number": "<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": {}
}
]
}
],
"order": {
"id": "<string>",
"reference": "<string>",
"channel": "<string>",
"ordered_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"insurance_charge": {
"amount": 123,
"currency": "usd"
},
"invoice": {
"number": "<string>",
"date": "2023-12-25",
"file": "<string>"
},
"buyer": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"seller": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
}
},
"carrier_configs": {
"*": {
"signature": "adult",
"insurance": {
"amount": 25000,
"currency": "usd"
}
},
"fedex": {
"service": "fedex_international_priority",
"saturday_delivery": true,
"priority_alert": true
},
"ups": {}
},
"ship_date": "2023-12-25",
"reference": "<string>",
"handover": {
"close_group": "<string>"
},
"returns": {
"is_return": true,
"include_return_label": true
},
"user_metadata": {},
"redact": true
}
'import requests
url = "https://api.example.com/v1/shipments/{id}"
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>"
}
},
"return_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>"
}
},
"bill_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>"
}
},
"billing": {
"paid_by": "sender",
"account_number": "<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": {}
}
]
}
],
"order": {
"id": "<string>",
"reference": "<string>",
"channel": "<string>",
"ordered_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"insurance_charge": {
"amount": 123,
"currency": "usd"
},
"invoice": {
"number": "<string>",
"date": "2023-12-25",
"file": "<string>"
},
"buyer": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"seller": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
}
},
"carrier_configs": {
"*": {
"signature": "adult",
"insurance": {
"amount": 25000,
"currency": "usd"
}
},
"fedex": {
"service": "fedex_international_priority",
"saturday_delivery": True,
"priority_alert": True
},
"ups": {}
},
"ship_date": "2023-12-25",
"reference": "<string>",
"handover": { "close_group": "<string>" },
"returns": {
"is_return": True,
"include_return_label": True
},
"user_metadata": {},
"redact": True
}
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>'}
},
return_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>'}
},
bill_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>'}
},
billing: {paid_by: 'sender', account_number: '<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: {}
}
]
}
],
order: {
id: '<string>',
reference: '<string>',
channel: '<string>',
ordered_at: '2023-11-07T05:31:56Z',
currency: '<string>',
insurance_charge: {amount: 123, currency: 'usd'},
invoice: {number: '<string>', date: '2023-12-25', file: '<string>'},
buyer: {
name: '<string>',
company: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
tax_ids: [{value: '<string>', country: '<string>'}],
instructions: '<string>',
access_point: {carrier: '<string>', id: '<string>'}
},
seller: {
name: '<string>',
company: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
tax_ids: [{value: '<string>', country: '<string>'}],
instructions: '<string>',
access_point: {carrier: '<string>', id: '<string>'}
}
},
carrier_configs: {
'*': {signature: 'adult', insurance: {amount: 25000, currency: 'usd'}},
fedex: {
service: 'fedex_international_priority',
saturday_delivery: true,
priority_alert: true
},
ups: {}
},
ship_date: '2023-12-25',
reference: '<string>',
handover: {close_group: '<string>'},
returns: {is_return: true, include_return_label: true},
user_metadata: {},
redact: true
})
};
fetch('https://api.example.com/v1/shipments/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/shipments/{id}",
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>'
]
],
'return_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>'
]
],
'bill_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>'
]
],
'billing' => [
'paid_by' => 'sender',
'account_number' => '<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' => [
]
]
]
]
],
'order' => [
'id' => '<string>',
'reference' => '<string>',
'channel' => '<string>',
'ordered_at' => '2023-11-07T05:31:56Z',
'currency' => '<string>',
'insurance_charge' => [
'amount' => 123,
'currency' => 'usd'
],
'invoice' => [
'number' => '<string>',
'date' => '2023-12-25',
'file' => '<string>'
],
'buyer' => [
'name' => '<string>',
'company' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'tax_ids' => [
[
'value' => '<string>',
'country' => '<string>'
]
],
'instructions' => '<string>',
'access_point' => [
'carrier' => '<string>',
'id' => '<string>'
]
],
'seller' => [
'name' => '<string>',
'company' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'tax_ids' => [
[
'value' => '<string>',
'country' => '<string>'
]
],
'instructions' => '<string>',
'access_point' => [
'carrier' => '<string>',
'id' => '<string>'
]
]
],
'carrier_configs' => [
'*' => [
'signature' => 'adult',
'insurance' => [
'amount' => 25000,
'currency' => 'usd'
]
],
'fedex' => [
'service' => 'fedex_international_priority',
'saturday_delivery' => true,
'priority_alert' => true
],
'ups' => [
]
],
'ship_date' => '2023-12-25',
'reference' => '<string>',
'handover' => [
'close_group' => '<string>'
],
'returns' => [
'is_return' => true,
'include_return_label' => true
],
'user_metadata' => [
],
'redact' => true
]),
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/shipments/{id}"
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 \"return_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 \"bill_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 \"billing\": {\n \"paid_by\": \"sender\",\n \"account_number\": \"<string>\"\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 \"order\": {\n \"id\": \"<string>\",\n \"reference\": \"<string>\",\n \"channel\": \"<string>\",\n \"ordered_at\": \"2023-11-07T05:31:56Z\",\n \"currency\": \"<string>\",\n \"insurance_charge\": {\n \"amount\": 123,\n \"currency\": \"usd\"\n },\n \"invoice\": {\n \"number\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"file\": \"<string>\"\n },\n \"buyer\": {\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 \"seller\": {\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 },\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 \"ship_date\": \"2023-12-25\",\n \"reference\": \"<string>\",\n \"handover\": {\n \"close_group\": \"<string>\"\n },\n \"returns\": {\n \"is_return\": true,\n \"include_return_label\": true\n },\n \"user_metadata\": {},\n \"redact\": true\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/shipments/{id}")
.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 \"return_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 \"bill_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 \"billing\": {\n \"paid_by\": \"sender\",\n \"account_number\": \"<string>\"\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 \"order\": {\n \"id\": \"<string>\",\n \"reference\": \"<string>\",\n \"channel\": \"<string>\",\n \"ordered_at\": \"2023-11-07T05:31:56Z\",\n \"currency\": \"<string>\",\n \"insurance_charge\": {\n \"amount\": 123,\n \"currency\": \"usd\"\n },\n \"invoice\": {\n \"number\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"file\": \"<string>\"\n },\n \"buyer\": {\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 \"seller\": {\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 },\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 \"ship_date\": \"2023-12-25\",\n \"reference\": \"<string>\",\n \"handover\": {\n \"close_group\": \"<string>\"\n },\n \"returns\": {\n \"is_return\": true,\n \"include_return_label\": true\n },\n \"user_metadata\": {},\n \"redact\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/shipments/{id}")
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 \"return_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 \"bill_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 \"billing\": {\n \"paid_by\": \"sender\",\n \"account_number\": \"<string>\"\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 \"order\": {\n \"id\": \"<string>\",\n \"reference\": \"<string>\",\n \"channel\": \"<string>\",\n \"ordered_at\": \"2023-11-07T05:31:56Z\",\n \"currency\": \"<string>\",\n \"insurance_charge\": {\n \"amount\": 123,\n \"currency\": \"usd\"\n },\n \"invoice\": {\n \"number\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"file\": \"<string>\"\n },\n \"buyer\": {\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 \"seller\": {\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 },\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 \"ship_date\": \"2023-12-25\",\n \"reference\": \"<string>\",\n \"handover\": {\n \"close_group\": \"<string>\"\n },\n \"returns\": {\n \"is_return\": true,\n \"include_return_label\": true\n },\n \"user_metadata\": {},\n \"redact\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "shp_1Q2w3E4r",
"object": "shipment",
"livemode": true,
"created": 123,
"status": "draft",
"updated": 123,
"reference": "<string>",
"ship_date": "2023-12-25",
"ship_from": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"ship_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"return_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"bill_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"billing": {
"paid_by": "sender",
"account_number": "<string>"
},
"handling_units": [
{
"weight": {
"value": 123,
"unit": "g"
},
"id": "<string>",
"type": "parcel",
"conditions": {
"temperature": {
"min": {
"value": 123,
"unit": "<string>"
},
"max": {
"value": 123,
"unit": "<string>"
}
},
"shock": {
"max": {
"value": 123,
"unit": "<string>"
}
},
"tilt": {
"max_degrees": 123
}
},
"dimensions": {
"length": 123,
"width": 123,
"height": 123,
"unit": "mm"
},
"packaging": "<string>",
"freight": {
"pallet_standard": "eur1",
"stackable": true,
"piece_count": 123,
"freight_class": "<string>",
"nmfc_code": "<string>",
"hazmat_placard": true
},
"reference": "<string>",
"description": "<string>",
"items": [
{
"quantity": 2,
"title": "<string>",
"description": "<string>",
"sku": "<string>",
"unit_value": {
"amount": 123,
"currency": "usd"
},
"unit_net_weight": {
"value": 123,
"unit": "g"
},
"unit_gross_weight": {
"value": 123,
"unit": "g"
},
"origin_country": "<string>",
"export_hs_code": "<string>",
"import_hs_code": "<string>",
"category": "<string>",
"product_url": "<string>",
"image_url": "<string>",
"product_id": "<string>",
"variant_id": "<string>",
"order_line_id": "<string>",
"brand": "<string>",
"material": "<string>",
"manufacturer": {
"name": "<string>",
"country": "<string>",
"mid": "<string>"
},
"compliance": {
"controlled": true,
"control_type": "dual_use",
"eccn": "<string>",
"license": {
"type": "export",
"number": "<string>",
"expires_on": "2023-12-25"
},
"regulatory_agency": "<string>",
"regulatory_program": "<string>",
"regulatory_category_code": "<string>",
"certification": {
"type": "<string>",
"reference": "<string>"
}
},
"dangerous_goods": {
"class": "<string>",
"un_number": "<string>",
"proper_shipping_name": "<string>",
"packing_group": "I",
"packing_instruction": "<string>",
"section": "<string>",
"quantity": {
"value": 123,
"unit": "g"
},
"lithium": {
"type": "ion",
"configuration": "alone",
"watt_hours": 123,
"lithium_grams": 123,
"cells": 123
},
"accessibility": "accessible",
"transport_mode": "air",
"excepted_quantity": true,
"limited_quantity": true,
"emergency_contact": {
"name": "<string>",
"phone": "<string>"
},
"declaration_document": "<string>"
},
"product": "<string>",
"user_metadata": {}
}
],
"tracking_number": "<string>",
"carrier_metadata": {}
}
],
"order": {
"id": "<string>",
"reference": "<string>",
"channel": "<string>",
"ordered_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"subtotal": {
"amount": 123,
"currency": "usd"
},
"shipping_charge": {
"amount": 123,
"currency": "usd"
},
"insurance_charge": {
"amount": 123,
"currency": "usd"
},
"discount": {
"amount": 123,
"currency": "usd"
},
"tax": {
"amount": 123,
"currency": "usd"
},
"total": {
"amount": 123,
"currency": "usd"
},
"invoice": {
"number": "<string>",
"date": "2023-12-25",
"type": "commercial",
"terms_of_payment": "prepaid",
"file": "<string>"
},
"buyer": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"seller": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
}
},
"customs_declaration": {
"contents_type": "merchandise",
"contents_explanation": "<string>",
"incoterm": "DAP",
"duties": {
"paid_by": "sender",
"account_number": "<string>",
"bill_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
}
},
"landed_cost": "<string>",
"import_broker": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"export_broker": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"importer_of_record": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"exporter_of_record": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"eu_responsible_person": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"export_declaration": {
"type": "itn",
"value": "<string>"
},
"non_delivery": "return",
"paperless_trade": true,
"certify": true,
"signer": "<string>",
"documents": [
{
"type": "<string>",
"carrier_reference": "<string>",
"document_upload": "<string>"
}
]
},
"carrier_configs": {
"*": {
"signature": "adult",
"insurance": {
"amount": 25000,
"currency": "usd"
}
},
"fedex": {
"service": "fedex_international_priority",
"saturday_delivery": true,
"priority_alert": true
},
"ups": {}
},
"purchase": {
"rate": "<string>",
"rate_quote": "<string>",
"service": {
"code": "<string>",
"carrier": "<string>",
"connection": "<string>",
"name": "<string>",
"level": "same_day",
"carrier_code": "<string>"
},
"amount": {
"amount": 123,
"currency": "usd"
},
"charges": [
{
"kind": "base",
"amount": {
"amount": 123,
"currency": "usd"
},
"option": "<string>",
"name": "<string>",
"carrier_code": "<string>"
}
],
"delivery": {
"days": 123,
"date": "2023-12-25",
"window": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"guaranteed": true,
"business_days": true
},
"label_format": {
"format": "pdf",
"size": "<string>",
"dpi": "203",
"inline": true
},
"purchased_at": 123,
"error": {},
"void": {
"requested_at": 123,
"reason": "<string>",
"status": "pending",
"refund": {
"status": "not_applicable",
"amount": {
"amount": 123,
"currency": "usd"
},
"expected_by": "2023-12-25"
},
"carrier_reference": "<string>"
},
"coverage": "<string>"
},
"tracking": {
"status": "pre_transit",
"number": "<string>",
"url": "<string>",
"tracker": "<string>",
"journey": "<string>"
},
"handover": {
"close_group": "<string>",
"pickup": "<string>",
"manifest": "<string>"
},
"injection": {
"partner": "<string>",
"channel": "carrier",
"upstream_reference": "<string>",
"label_mode": "pre_labeled",
"status": "submitted",
"upstream_carrier": "<string>",
"upstream_tracking_number": "<string>",
"injection_point": "<string>",
"expected_at": "<string>",
"asn": "<string>",
"tracking_feedback": {
"mode": "push",
"target": "partner_webhooks",
"number": "upstream"
},
"decision": {
"reasons": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
},
"received": {
"at": 123,
"facility": "<string>",
"condition": "ok",
"measured": {
"weight": {
"value": 123,
"unit": "g"
},
"dimensions": {
"length": 123,
"width": 123,
"height": 123,
"unit": "mm"
}
}
}
},
"returns": {
"is_return": true,
"outbound_shipment": "<string>",
"return_shipment": "<string>"
},
"documents": [
{
"id": "<string>",
"object": "document",
"type": "label",
"format": "pdf",
"size": "<string>",
"url": "<string>",
"url_expires_at": 123,
"data": "<string>",
"handling_unit": "<string>",
"bundle": [
"<string>"
],
"template": "<string>",
"template_version": 123,
"related": {
"type": "<string>",
"id": "<string>"
},
"file": "<string>",
"sha256": "<string>"
}
],
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
],
"user_metadata": {},
"carrier_metadata": {},
"system_metadata": {
"source": "api",
"created_by": {
"type": "api_key",
"id": "<string>"
},
"request_id": "<string>",
"idempotency_key": "<string>",
"batch": "<string>",
"generated": true,
"test_scenario": "<string>"
}
}{
"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>"
}
]
}
}Shipments
Update a Shipment
POST
/
v1
/
shipments
/
{id}
Update a Shipment
curl --request POST \
--url https://api.example.com/v1/shipments/{id} \
--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>"
}
},
"return_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>"
}
},
"bill_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>"
}
},
"billing": {
"paid_by": "sender",
"account_number": "<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": {}
}
]
}
],
"order": {
"id": "<string>",
"reference": "<string>",
"channel": "<string>",
"ordered_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"insurance_charge": {
"amount": 123,
"currency": "usd"
},
"invoice": {
"number": "<string>",
"date": "2023-12-25",
"file": "<string>"
},
"buyer": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"seller": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
}
},
"carrier_configs": {
"*": {
"signature": "adult",
"insurance": {
"amount": 25000,
"currency": "usd"
}
},
"fedex": {
"service": "fedex_international_priority",
"saturday_delivery": true,
"priority_alert": true
},
"ups": {}
},
"ship_date": "2023-12-25",
"reference": "<string>",
"handover": {
"close_group": "<string>"
},
"returns": {
"is_return": true,
"include_return_label": true
},
"user_metadata": {},
"redact": true
}
'import requests
url = "https://api.example.com/v1/shipments/{id}"
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>"
}
},
"return_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>"
}
},
"bill_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>"
}
},
"billing": {
"paid_by": "sender",
"account_number": "<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": {}
}
]
}
],
"order": {
"id": "<string>",
"reference": "<string>",
"channel": "<string>",
"ordered_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"insurance_charge": {
"amount": 123,
"currency": "usd"
},
"invoice": {
"number": "<string>",
"date": "2023-12-25",
"file": "<string>"
},
"buyer": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"seller": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
}
},
"carrier_configs": {
"*": {
"signature": "adult",
"insurance": {
"amount": 25000,
"currency": "usd"
}
},
"fedex": {
"service": "fedex_international_priority",
"saturday_delivery": True,
"priority_alert": True
},
"ups": {}
},
"ship_date": "2023-12-25",
"reference": "<string>",
"handover": { "close_group": "<string>" },
"returns": {
"is_return": True,
"include_return_label": True
},
"user_metadata": {},
"redact": True
}
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>'}
},
return_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>'}
},
bill_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>'}
},
billing: {paid_by: 'sender', account_number: '<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: {}
}
]
}
],
order: {
id: '<string>',
reference: '<string>',
channel: '<string>',
ordered_at: '2023-11-07T05:31:56Z',
currency: '<string>',
insurance_charge: {amount: 123, currency: 'usd'},
invoice: {number: '<string>', date: '2023-12-25', file: '<string>'},
buyer: {
name: '<string>',
company: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
tax_ids: [{value: '<string>', country: '<string>'}],
instructions: '<string>',
access_point: {carrier: '<string>', id: '<string>'}
},
seller: {
name: '<string>',
company: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
tax_ids: [{value: '<string>', country: '<string>'}],
instructions: '<string>',
access_point: {carrier: '<string>', id: '<string>'}
}
},
carrier_configs: {
'*': {signature: 'adult', insurance: {amount: 25000, currency: 'usd'}},
fedex: {
service: 'fedex_international_priority',
saturday_delivery: true,
priority_alert: true
},
ups: {}
},
ship_date: '2023-12-25',
reference: '<string>',
handover: {close_group: '<string>'},
returns: {is_return: true, include_return_label: true},
user_metadata: {},
redact: true
})
};
fetch('https://api.example.com/v1/shipments/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/shipments/{id}",
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>'
]
],
'return_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>'
]
],
'bill_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>'
]
],
'billing' => [
'paid_by' => 'sender',
'account_number' => '<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' => [
]
]
]
]
],
'order' => [
'id' => '<string>',
'reference' => '<string>',
'channel' => '<string>',
'ordered_at' => '2023-11-07T05:31:56Z',
'currency' => '<string>',
'insurance_charge' => [
'amount' => 123,
'currency' => 'usd'
],
'invoice' => [
'number' => '<string>',
'date' => '2023-12-25',
'file' => '<string>'
],
'buyer' => [
'name' => '<string>',
'company' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'tax_ids' => [
[
'value' => '<string>',
'country' => '<string>'
]
],
'instructions' => '<string>',
'access_point' => [
'carrier' => '<string>',
'id' => '<string>'
]
],
'seller' => [
'name' => '<string>',
'company' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'tax_ids' => [
[
'value' => '<string>',
'country' => '<string>'
]
],
'instructions' => '<string>',
'access_point' => [
'carrier' => '<string>',
'id' => '<string>'
]
]
],
'carrier_configs' => [
'*' => [
'signature' => 'adult',
'insurance' => [
'amount' => 25000,
'currency' => 'usd'
]
],
'fedex' => [
'service' => 'fedex_international_priority',
'saturday_delivery' => true,
'priority_alert' => true
],
'ups' => [
]
],
'ship_date' => '2023-12-25',
'reference' => '<string>',
'handover' => [
'close_group' => '<string>'
],
'returns' => [
'is_return' => true,
'include_return_label' => true
],
'user_metadata' => [
],
'redact' => true
]),
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/shipments/{id}"
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 \"return_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 \"bill_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 \"billing\": {\n \"paid_by\": \"sender\",\n \"account_number\": \"<string>\"\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 \"order\": {\n \"id\": \"<string>\",\n \"reference\": \"<string>\",\n \"channel\": \"<string>\",\n \"ordered_at\": \"2023-11-07T05:31:56Z\",\n \"currency\": \"<string>\",\n \"insurance_charge\": {\n \"amount\": 123,\n \"currency\": \"usd\"\n },\n \"invoice\": {\n \"number\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"file\": \"<string>\"\n },\n \"buyer\": {\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 \"seller\": {\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 },\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 \"ship_date\": \"2023-12-25\",\n \"reference\": \"<string>\",\n \"handover\": {\n \"close_group\": \"<string>\"\n },\n \"returns\": {\n \"is_return\": true,\n \"include_return_label\": true\n },\n \"user_metadata\": {},\n \"redact\": true\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/shipments/{id}")
.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 \"return_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 \"bill_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 \"billing\": {\n \"paid_by\": \"sender\",\n \"account_number\": \"<string>\"\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 \"order\": {\n \"id\": \"<string>\",\n \"reference\": \"<string>\",\n \"channel\": \"<string>\",\n \"ordered_at\": \"2023-11-07T05:31:56Z\",\n \"currency\": \"<string>\",\n \"insurance_charge\": {\n \"amount\": 123,\n \"currency\": \"usd\"\n },\n \"invoice\": {\n \"number\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"file\": \"<string>\"\n },\n \"buyer\": {\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 \"seller\": {\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 },\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 \"ship_date\": \"2023-12-25\",\n \"reference\": \"<string>\",\n \"handover\": {\n \"close_group\": \"<string>\"\n },\n \"returns\": {\n \"is_return\": true,\n \"include_return_label\": true\n },\n \"user_metadata\": {},\n \"redact\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/shipments/{id}")
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 \"return_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 \"bill_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 \"billing\": {\n \"paid_by\": \"sender\",\n \"account_number\": \"<string>\"\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 \"order\": {\n \"id\": \"<string>\",\n \"reference\": \"<string>\",\n \"channel\": \"<string>\",\n \"ordered_at\": \"2023-11-07T05:31:56Z\",\n \"currency\": \"<string>\",\n \"insurance_charge\": {\n \"amount\": 123,\n \"currency\": \"usd\"\n },\n \"invoice\": {\n \"number\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"file\": \"<string>\"\n },\n \"buyer\": {\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 \"seller\": {\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 },\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 \"ship_date\": \"2023-12-25\",\n \"reference\": \"<string>\",\n \"handover\": {\n \"close_group\": \"<string>\"\n },\n \"returns\": {\n \"is_return\": true,\n \"include_return_label\": true\n },\n \"user_metadata\": {},\n \"redact\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "shp_1Q2w3E4r",
"object": "shipment",
"livemode": true,
"created": 123,
"status": "draft",
"updated": 123,
"reference": "<string>",
"ship_date": "2023-12-25",
"ship_from": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"ship_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"return_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"bill_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"billing": {
"paid_by": "sender",
"account_number": "<string>"
},
"handling_units": [
{
"weight": {
"value": 123,
"unit": "g"
},
"id": "<string>",
"type": "parcel",
"conditions": {
"temperature": {
"min": {
"value": 123,
"unit": "<string>"
},
"max": {
"value": 123,
"unit": "<string>"
}
},
"shock": {
"max": {
"value": 123,
"unit": "<string>"
}
},
"tilt": {
"max_degrees": 123
}
},
"dimensions": {
"length": 123,
"width": 123,
"height": 123,
"unit": "mm"
},
"packaging": "<string>",
"freight": {
"pallet_standard": "eur1",
"stackable": true,
"piece_count": 123,
"freight_class": "<string>",
"nmfc_code": "<string>",
"hazmat_placard": true
},
"reference": "<string>",
"description": "<string>",
"items": [
{
"quantity": 2,
"title": "<string>",
"description": "<string>",
"sku": "<string>",
"unit_value": {
"amount": 123,
"currency": "usd"
},
"unit_net_weight": {
"value": 123,
"unit": "g"
},
"unit_gross_weight": {
"value": 123,
"unit": "g"
},
"origin_country": "<string>",
"export_hs_code": "<string>",
"import_hs_code": "<string>",
"category": "<string>",
"product_url": "<string>",
"image_url": "<string>",
"product_id": "<string>",
"variant_id": "<string>",
"order_line_id": "<string>",
"brand": "<string>",
"material": "<string>",
"manufacturer": {
"name": "<string>",
"country": "<string>",
"mid": "<string>"
},
"compliance": {
"controlled": true,
"control_type": "dual_use",
"eccn": "<string>",
"license": {
"type": "export",
"number": "<string>",
"expires_on": "2023-12-25"
},
"regulatory_agency": "<string>",
"regulatory_program": "<string>",
"regulatory_category_code": "<string>",
"certification": {
"type": "<string>",
"reference": "<string>"
}
},
"dangerous_goods": {
"class": "<string>",
"un_number": "<string>",
"proper_shipping_name": "<string>",
"packing_group": "I",
"packing_instruction": "<string>",
"section": "<string>",
"quantity": {
"value": 123,
"unit": "g"
},
"lithium": {
"type": "ion",
"configuration": "alone",
"watt_hours": 123,
"lithium_grams": 123,
"cells": 123
},
"accessibility": "accessible",
"transport_mode": "air",
"excepted_quantity": true,
"limited_quantity": true,
"emergency_contact": {
"name": "<string>",
"phone": "<string>"
},
"declaration_document": "<string>"
},
"product": "<string>",
"user_metadata": {}
}
],
"tracking_number": "<string>",
"carrier_metadata": {}
}
],
"order": {
"id": "<string>",
"reference": "<string>",
"channel": "<string>",
"ordered_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"subtotal": {
"amount": 123,
"currency": "usd"
},
"shipping_charge": {
"amount": 123,
"currency": "usd"
},
"insurance_charge": {
"amount": 123,
"currency": "usd"
},
"discount": {
"amount": 123,
"currency": "usd"
},
"tax": {
"amount": 123,
"currency": "usd"
},
"total": {
"amount": 123,
"currency": "usd"
},
"invoice": {
"number": "<string>",
"date": "2023-12-25",
"type": "commercial",
"terms_of_payment": "prepaid",
"file": "<string>"
},
"buyer": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"seller": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
}
},
"customs_declaration": {
"contents_type": "merchandise",
"contents_explanation": "<string>",
"incoterm": "DAP",
"duties": {
"paid_by": "sender",
"account_number": "<string>",
"bill_to": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
}
},
"landed_cost": "<string>",
"import_broker": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"export_broker": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"importer_of_record": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"exporter_of_record": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"eu_responsible_person": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"export_declaration": {
"type": "itn",
"value": "<string>"
},
"non_delivery": "return",
"paperless_trade": true,
"certify": true,
"signer": "<string>",
"documents": [
{
"type": "<string>",
"carrier_reference": "<string>",
"document_upload": "<string>"
}
]
},
"carrier_configs": {
"*": {
"signature": "adult",
"insurance": {
"amount": 25000,
"currency": "usd"
}
},
"fedex": {
"service": "fedex_international_priority",
"saturday_delivery": true,
"priority_alert": true
},
"ups": {}
},
"purchase": {
"rate": "<string>",
"rate_quote": "<string>",
"service": {
"code": "<string>",
"carrier": "<string>",
"connection": "<string>",
"name": "<string>",
"level": "same_day",
"carrier_code": "<string>"
},
"amount": {
"amount": 123,
"currency": "usd"
},
"charges": [
{
"kind": "base",
"amount": {
"amount": 123,
"currency": "usd"
},
"option": "<string>",
"name": "<string>",
"carrier_code": "<string>"
}
],
"delivery": {
"days": 123,
"date": "2023-12-25",
"window": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"guaranteed": true,
"business_days": true
},
"label_format": {
"format": "pdf",
"size": "<string>",
"dpi": "203",
"inline": true
},
"purchased_at": 123,
"error": {},
"void": {
"requested_at": 123,
"reason": "<string>",
"status": "pending",
"refund": {
"status": "not_applicable",
"amount": {
"amount": 123,
"currency": "usd"
},
"expected_by": "2023-12-25"
},
"carrier_reference": "<string>"
},
"coverage": "<string>"
},
"tracking": {
"status": "pre_transit",
"number": "<string>",
"url": "<string>",
"tracker": "<string>",
"journey": "<string>"
},
"handover": {
"close_group": "<string>",
"pickup": "<string>",
"manifest": "<string>"
},
"injection": {
"partner": "<string>",
"channel": "carrier",
"upstream_reference": "<string>",
"label_mode": "pre_labeled",
"status": "submitted",
"upstream_carrier": "<string>",
"upstream_tracking_number": "<string>",
"injection_point": "<string>",
"expected_at": "<string>",
"asn": "<string>",
"tracking_feedback": {
"mode": "push",
"target": "partner_webhooks",
"number": "upstream"
},
"decision": {
"reasons": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
},
"received": {
"at": 123,
"facility": "<string>",
"condition": "ok",
"measured": {
"weight": {
"value": 123,
"unit": "g"
},
"dimensions": {
"length": 123,
"width": 123,
"height": 123,
"unit": "mm"
}
}
}
},
"returns": {
"is_return": true,
"outbound_shipment": "<string>",
"return_shipment": "<string>"
},
"documents": [
{
"id": "<string>",
"object": "document",
"type": "label",
"format": "pdf",
"size": "<string>",
"url": "<string>",
"url_expires_at": 123,
"data": "<string>",
"handling_unit": "<string>",
"bundle": [
"<string>"
],
"template": "<string>",
"template_version": 123,
"related": {
"type": "<string>",
"id": "<string>"
},
"file": "<string>",
"sha256": "<string>"
}
],
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
],
"user_metadata": {},
"carrier_metadata": {},
"system_metadata": {
"source": "api",
"created_by": {
"type": "api_key",
"id": "<string>"
},
"request_id": "<string>",
"idempotency_key": "<string>",
"batch": "<string>",
"generated": true,
"test_scenario": "<string>"
}
}{
"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_...)
Path Parameters
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
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
Which carrier account pays transportation charges. The party is bill_to. Country and postal code for validation come from bill_to.address.
Show child attributes
Show child attributes
Required array length:
1 - 99 elementsShow child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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": {}
}
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
Response
OK
Prefixed shp_
Example:
"shp_1Q2w3E4r"
Available options:
shipment Unix timestamp (seconds)
Available options:
draft, purchasing, purchase_failed, purchased, manifested, void_pending, voided, void_failed 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
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
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
Which carrier account pays transportation charges. The party is bill_to. Country and postal code for validation come from bill_to.address.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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": {}
}
What was bought and its commercial outcome. Null until the first purchase attempt.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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