Create a shipment
curl --request POST \
--url https://api.cf.ovrsea.com/v1/shipments \
--header 'Content-Type: application/json' \
--data '
{
"needs_ad_valorem_insurance": true,
"route": {
"delivery_location_id": "45",
"delivery_port_id": "2",
"pickup_location_id": "23",
"pickup_port_id": "1"
},
"cargo": {
"containers": [
{
"count": 2
}
],
"loads": [
{
"count": 4,
"total_volume": 3840000,
"total_weight": 1200
}
]
},
"cargo_ready_date": "2027-03-01",
"desired_delivery_date": "2027-04-15",
"incoterm": "fob",
"name": "June Air Export USA",
"specific_instructions": "Call the warehouse before delivery",
"transported_goods": {
"goods_description": "Ceramic tiles"
}
}
'import requests
url = "https://api.cf.ovrsea.com/v1/shipments"
payload = {
"needs_ad_valorem_insurance": True,
"route": {
"delivery_location_id": "45",
"delivery_port_id": "2",
"pickup_location_id": "23",
"pickup_port_id": "1"
},
"cargo": {
"containers": [{ "count": 2 }],
"loads": [
{
"count": 4,
"total_volume": 3840000,
"total_weight": 1200
}
]
},
"cargo_ready_date": "2027-03-01",
"desired_delivery_date": "2027-04-15",
"incoterm": "fob",
"name": "June Air Export USA",
"specific_instructions": "Call the warehouse before delivery",
"transported_goods": { "goods_description": "Ceramic tiles" }
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
needs_ad_valorem_insurance: true,
route: {
delivery_location_id: '45',
delivery_port_id: '2',
pickup_location_id: '23',
pickup_port_id: '1'
},
cargo: {
containers: [{count: 2}],
loads: [{count: 4, total_volume: 3840000, total_weight: 1200}]
},
cargo_ready_date: '2027-03-01',
desired_delivery_date: '2027-04-15',
incoterm: 'fob',
name: 'June Air Export USA',
specific_instructions: 'Call the warehouse before delivery',
transported_goods: {goods_description: 'Ceramic tiles'}
})
};
fetch('https://api.cf.ovrsea.com/v1/shipments', 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.cf.ovrsea.com/v1/shipments",
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([
'needs_ad_valorem_insurance' => true,
'route' => [
'delivery_location_id' => '45',
'delivery_port_id' => '2',
'pickup_location_id' => '23',
'pickup_port_id' => '1'
],
'cargo' => [
'containers' => [
[
'count' => 2
]
],
'loads' => [
[
'count' => 4,
'total_volume' => 3840000,
'total_weight' => 1200
]
]
],
'cargo_ready_date' => '2027-03-01',
'desired_delivery_date' => '2027-04-15',
'incoterm' => 'fob',
'name' => 'June Air Export USA',
'specific_instructions' => 'Call the warehouse before delivery',
'transported_goods' => [
'goods_description' => 'Ceramic tiles'
]
]),
CURLOPT_HTTPHEADER => [
"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.cf.ovrsea.com/v1/shipments"
payload := strings.NewReader("{\n \"needs_ad_valorem_insurance\": true,\n \"route\": {\n \"delivery_location_id\": \"45\",\n \"delivery_port_id\": \"2\",\n \"pickup_location_id\": \"23\",\n \"pickup_port_id\": \"1\"\n },\n \"cargo\": {\n \"containers\": [\n {\n \"count\": 2\n }\n ],\n \"loads\": [\n {\n \"count\": 4,\n \"total_volume\": 3840000,\n \"total_weight\": 1200\n }\n ]\n },\n \"cargo_ready_date\": \"2027-03-01\",\n \"desired_delivery_date\": \"2027-04-15\",\n \"incoterm\": \"fob\",\n \"name\": \"June Air Export USA\",\n \"specific_instructions\": \"Call the warehouse before delivery\",\n \"transported_goods\": {\n \"goods_description\": \"Ceramic tiles\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.cf.ovrsea.com/v1/shipments")
.header("Content-Type", "application/json")
.body("{\n \"needs_ad_valorem_insurance\": true,\n \"route\": {\n \"delivery_location_id\": \"45\",\n \"delivery_port_id\": \"2\",\n \"pickup_location_id\": \"23\",\n \"pickup_port_id\": \"1\"\n },\n \"cargo\": {\n \"containers\": [\n {\n \"count\": 2\n }\n ],\n \"loads\": [\n {\n \"count\": 4,\n \"total_volume\": 3840000,\n \"total_weight\": 1200\n }\n ]\n },\n \"cargo_ready_date\": \"2027-03-01\",\n \"desired_delivery_date\": \"2027-04-15\",\n \"incoterm\": \"fob\",\n \"name\": \"June Air Export USA\",\n \"specific_instructions\": \"Call the warehouse before delivery\",\n \"transported_goods\": {\n \"goods_description\": \"Ceramic tiles\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cf.ovrsea.com/v1/shipments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"needs_ad_valorem_insurance\": true,\n \"route\": {\n \"delivery_location_id\": \"45\",\n \"delivery_port_id\": \"2\",\n \"pickup_location_id\": \"23\",\n \"pickup_port_id\": \"1\"\n },\n \"cargo\": {\n \"containers\": [\n {\n \"count\": 2\n }\n ],\n \"loads\": [\n {\n \"count\": 4,\n \"total_volume\": 3840000,\n \"total_weight\": 1200\n }\n ]\n },\n \"cargo_ready_date\": \"2027-03-01\",\n \"desired_delivery_date\": \"2027-04-15\",\n \"incoterm\": \"fob\",\n \"name\": \"June Air Export USA\",\n \"specific_instructions\": \"Call the warehouse before delivery\",\n \"transported_goods\": {\n \"goods_description\": \"Ceramic tiles\"\n }\n}"
response = http.request(request)
puts response.read_body{
"name": "June Air Export USA",
"ovrsea_shipment_id": "CDEF",
"status": "booking_request",
"created_at": "2021-09-20T10:02:09+01:00",
"incoterm": "fob",
"freight_mode": "air",
"load_type": "fcl",
"freight_type": "port_to_door",
"route": {
"pickup_location_id": "23",
"origin_port_unlocode": "FR/FOS",
"destination_port_unlocode": "US/NYC",
"delivery_location_id": "45"
},
"cargo_ready_date": "2021-10-11",
"desired_delivery_date": "2021-10-11",
"specific_instructions": "<string>",
"cargo": {
"total_weight": {
"value": 350.25,
"unit": "kg"
},
"total_volume": {
"value": 10.25,
"unit": "cbm"
},
"total_teus": 5,
"containers": [
{
"container_type": "twenty_foot_standard",
"container_number": "TEMU8667058",
"seal_number": 1332641,
"purchase_order_references": [
4500346155
]
}
],
"loads": [
{
"count": 3,
"type": "pallet",
"weight": {
"value": 350.25,
"unit": "kg"
},
"volume_unit": "cm",
"length": {
"value": 10.25,
"unit": "cm"
},
"width": {
"value": 10.25,
"unit": "cm"
},
"height": {
"value": 10.25,
"unit": "cm"
}
}
]
},
"transported_goods": {
"goods_description": "Description of the shipped goods",
"is_stackable": true,
"is_hazardous": false,
"hazardous_description": "UN1993",
"contains_lithium": false,
"lithium_packaging_type": "alone",
"contains_magnets": false,
"needs_controlled_temperature": false,
"temperature_range_description": "5-25°C"
},
"commercial_value": {
"amount": 150357.99,
"currency": "USD"
},
"needs_ad_valorem_insurance": false,
"purchase_order_references": [
4500346155
],
"main_tracking_dates": {
"pickup_date": {
"date": "2021-09-20T10:02:09+01:00",
"status": "estimated"
},
"departure_date": {
"date": "2021-09-20T10:02:09+01:00",
"status": "estimated"
},
"arrival_date": {
"date": "2021-09-20T10:02:09+01:00",
"status": "estimated"
},
"delivery_date": {
"date": "2021-09-20T10:02:09+01:00",
"status": "estimated"
}
},
"booking_information": {
"carrier": "CMA CGM",
"master_bill": "LHV1190703558",
"house_bill": "HOUSEREF12357",
"ocean_booking": {
"booking_number": "TWLEH2106004",
"voyage": "033E",
"vessel": "CMA CGM Jacques Saadé"
},
"air_booking": {
"flight_number": "AF256",
"chargeable_weight": {
"value": 350.25,
"unit": "kg"
}
}
},
"invoice_status": "available",
"invoice_references": [
"FAC2022-9567"
],
"accepted_quote": {
"id": "325",
"request_date": "2021-09-20T10:02:09+01:00",
"accepted_date": "2021-09-20T10:02:09+01:00"
}
}"<string>""<string>"Shipments
Create a shipment
Creates a shipment for the account between locations or ports.
Create a shipment
curl --request POST \
--url https://api.cf.ovrsea.com/v1/shipments \
--header 'Content-Type: application/json' \
--data '
{
"needs_ad_valorem_insurance": true,
"route": {
"delivery_location_id": "45",
"delivery_port_id": "2",
"pickup_location_id": "23",
"pickup_port_id": "1"
},
"cargo": {
"containers": [
{
"count": 2
}
],
"loads": [
{
"count": 4,
"total_volume": 3840000,
"total_weight": 1200
}
]
},
"cargo_ready_date": "2027-03-01",
"desired_delivery_date": "2027-04-15",
"incoterm": "fob",
"name": "June Air Export USA",
"specific_instructions": "Call the warehouse before delivery",
"transported_goods": {
"goods_description": "Ceramic tiles"
}
}
'import requests
url = "https://api.cf.ovrsea.com/v1/shipments"
payload = {
"needs_ad_valorem_insurance": True,
"route": {
"delivery_location_id": "45",
"delivery_port_id": "2",
"pickup_location_id": "23",
"pickup_port_id": "1"
},
"cargo": {
"containers": [{ "count": 2 }],
"loads": [
{
"count": 4,
"total_volume": 3840000,
"total_weight": 1200
}
]
},
"cargo_ready_date": "2027-03-01",
"desired_delivery_date": "2027-04-15",
"incoterm": "fob",
"name": "June Air Export USA",
"specific_instructions": "Call the warehouse before delivery",
"transported_goods": { "goods_description": "Ceramic tiles" }
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
needs_ad_valorem_insurance: true,
route: {
delivery_location_id: '45',
delivery_port_id: '2',
pickup_location_id: '23',
pickup_port_id: '1'
},
cargo: {
containers: [{count: 2}],
loads: [{count: 4, total_volume: 3840000, total_weight: 1200}]
},
cargo_ready_date: '2027-03-01',
desired_delivery_date: '2027-04-15',
incoterm: 'fob',
name: 'June Air Export USA',
specific_instructions: 'Call the warehouse before delivery',
transported_goods: {goods_description: 'Ceramic tiles'}
})
};
fetch('https://api.cf.ovrsea.com/v1/shipments', 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.cf.ovrsea.com/v1/shipments",
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([
'needs_ad_valorem_insurance' => true,
'route' => [
'delivery_location_id' => '45',
'delivery_port_id' => '2',
'pickup_location_id' => '23',
'pickup_port_id' => '1'
],
'cargo' => [
'containers' => [
[
'count' => 2
]
],
'loads' => [
[
'count' => 4,
'total_volume' => 3840000,
'total_weight' => 1200
]
]
],
'cargo_ready_date' => '2027-03-01',
'desired_delivery_date' => '2027-04-15',
'incoterm' => 'fob',
'name' => 'June Air Export USA',
'specific_instructions' => 'Call the warehouse before delivery',
'transported_goods' => [
'goods_description' => 'Ceramic tiles'
]
]),
CURLOPT_HTTPHEADER => [
"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.cf.ovrsea.com/v1/shipments"
payload := strings.NewReader("{\n \"needs_ad_valorem_insurance\": true,\n \"route\": {\n \"delivery_location_id\": \"45\",\n \"delivery_port_id\": \"2\",\n \"pickup_location_id\": \"23\",\n \"pickup_port_id\": \"1\"\n },\n \"cargo\": {\n \"containers\": [\n {\n \"count\": 2\n }\n ],\n \"loads\": [\n {\n \"count\": 4,\n \"total_volume\": 3840000,\n \"total_weight\": 1200\n }\n ]\n },\n \"cargo_ready_date\": \"2027-03-01\",\n \"desired_delivery_date\": \"2027-04-15\",\n \"incoterm\": \"fob\",\n \"name\": \"June Air Export USA\",\n \"specific_instructions\": \"Call the warehouse before delivery\",\n \"transported_goods\": {\n \"goods_description\": \"Ceramic tiles\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.cf.ovrsea.com/v1/shipments")
.header("Content-Type", "application/json")
.body("{\n \"needs_ad_valorem_insurance\": true,\n \"route\": {\n \"delivery_location_id\": \"45\",\n \"delivery_port_id\": \"2\",\n \"pickup_location_id\": \"23\",\n \"pickup_port_id\": \"1\"\n },\n \"cargo\": {\n \"containers\": [\n {\n \"count\": 2\n }\n ],\n \"loads\": [\n {\n \"count\": 4,\n \"total_volume\": 3840000,\n \"total_weight\": 1200\n }\n ]\n },\n \"cargo_ready_date\": \"2027-03-01\",\n \"desired_delivery_date\": \"2027-04-15\",\n \"incoterm\": \"fob\",\n \"name\": \"June Air Export USA\",\n \"specific_instructions\": \"Call the warehouse before delivery\",\n \"transported_goods\": {\n \"goods_description\": \"Ceramic tiles\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cf.ovrsea.com/v1/shipments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"needs_ad_valorem_insurance\": true,\n \"route\": {\n \"delivery_location_id\": \"45\",\n \"delivery_port_id\": \"2\",\n \"pickup_location_id\": \"23\",\n \"pickup_port_id\": \"1\"\n },\n \"cargo\": {\n \"containers\": [\n {\n \"count\": 2\n }\n ],\n \"loads\": [\n {\n \"count\": 4,\n \"total_volume\": 3840000,\n \"total_weight\": 1200\n }\n ]\n },\n \"cargo_ready_date\": \"2027-03-01\",\n \"desired_delivery_date\": \"2027-04-15\",\n \"incoterm\": \"fob\",\n \"name\": \"June Air Export USA\",\n \"specific_instructions\": \"Call the warehouse before delivery\",\n \"transported_goods\": {\n \"goods_description\": \"Ceramic tiles\"\n }\n}"
response = http.request(request)
puts response.read_body{
"name": "June Air Export USA",
"ovrsea_shipment_id": "CDEF",
"status": "booking_request",
"created_at": "2021-09-20T10:02:09+01:00",
"incoterm": "fob",
"freight_mode": "air",
"load_type": "fcl",
"freight_type": "port_to_door",
"route": {
"pickup_location_id": "23",
"origin_port_unlocode": "FR/FOS",
"destination_port_unlocode": "US/NYC",
"delivery_location_id": "45"
},
"cargo_ready_date": "2021-10-11",
"desired_delivery_date": "2021-10-11",
"specific_instructions": "<string>",
"cargo": {
"total_weight": {
"value": 350.25,
"unit": "kg"
},
"total_volume": {
"value": 10.25,
"unit": "cbm"
},
"total_teus": 5,
"containers": [
{
"container_type": "twenty_foot_standard",
"container_number": "TEMU8667058",
"seal_number": 1332641,
"purchase_order_references": [
4500346155
]
}
],
"loads": [
{
"count": 3,
"type": "pallet",
"weight": {
"value": 350.25,
"unit": "kg"
},
"volume_unit": "cm",
"length": {
"value": 10.25,
"unit": "cm"
},
"width": {
"value": 10.25,
"unit": "cm"
},
"height": {
"value": 10.25,
"unit": "cm"
}
}
]
},
"transported_goods": {
"goods_description": "Description of the shipped goods",
"is_stackable": true,
"is_hazardous": false,
"hazardous_description": "UN1993",
"contains_lithium": false,
"lithium_packaging_type": "alone",
"contains_magnets": false,
"needs_controlled_temperature": false,
"temperature_range_description": "5-25°C"
},
"commercial_value": {
"amount": 150357.99,
"currency": "USD"
},
"needs_ad_valorem_insurance": false,
"purchase_order_references": [
4500346155
],
"main_tracking_dates": {
"pickup_date": {
"date": "2021-09-20T10:02:09+01:00",
"status": "estimated"
},
"departure_date": {
"date": "2021-09-20T10:02:09+01:00",
"status": "estimated"
},
"arrival_date": {
"date": "2021-09-20T10:02:09+01:00",
"status": "estimated"
},
"delivery_date": {
"date": "2021-09-20T10:02:09+01:00",
"status": "estimated"
}
},
"booking_information": {
"carrier": "CMA CGM",
"master_bill": "LHV1190703558",
"house_bill": "HOUSEREF12357",
"ocean_booking": {
"booking_number": "TWLEH2106004",
"voyage": "033E",
"vessel": "CMA CGM Jacques Saadé"
},
"air_booking": {
"flight_number": "AF256",
"chargeable_weight": {
"value": 350.25,
"unit": "kg"
}
}
},
"invoice_status": "available",
"invoice_references": [
"FAC2022-9567"
],
"accepted_quote": {
"id": "325",
"request_date": "2021-09-20T10:02:09+01:00",
"accepted_date": "2021-09-20T10:02:09+01:00"
}
}"<string>""<string>"Body
application/json
Response
The created shipment.
