cURL
curl --request POST \
--url https://api.vooma.ai/v0/shipments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"shipment": {
"movements": [
{
"cargo": {
"commodities": [
{
"description": "<string>",
"isStackable": true,
"dimensions": {},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceQuantity": 123,
"handlingQuantity": 123
}
],
"dimensions": {}
},
"equipmentOptions": [
{
"description": "<string>"
}
],
"customer": {
"name": "<string>",
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>",
"contacts": [
{
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
]
},
"route": {
"stops": [
{
"stopReferences": [
{
"value": "<string>"
}
],
"location": {
"address": {
"country": "<string>",
"postalCode": "<string>",
"city": "<string>",
"state": "<string>",
"addressTwo": "<string>",
"addressOne": "<string>"
},
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>",
"name": "<string>",
"contacts": [
{
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
],
"hours": {}
},
"id": "<string>",
"externalNotes": "<string>",
"internalNotes": "<string>",
"accessorials": [
{
"size": {
"value": 123
},
"type": "TARPING"
}
],
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
},
"commodities": [
{
"description": "<string>",
"isStackable": true,
"dimensions": {},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceQuantity": 123,
"handlingQuantity": 123
}
],
"notes": "<string>",
"dateTimeRanges": [
{
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"timezone": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
]
}
]
},
"references": [
{
"value": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>",
"tmsStatus": "<string>",
"attributes": {},
"tags": [
"<string>"
],
"externalNotes": "<string>",
"internalNotes": "<string>",
"accessorials": [
{
"size": {
"value": 123
},
"type": "TARPING"
}
]
}
],
"references": [
{
"value": "<string>"
}
],
"freightModeDetails": {},
"chargesToCustomer": {
"lineItems": [
{
"description": "<string>",
"amount": {
"value": 123
}
}
]
},
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
]
}
}
'import requests
url = "https://api.vooma.ai/v0/shipments"
payload = { "shipment": {
"movements": [
{
"cargo": {
"commodities": [
{
"description": "<string>",
"isStackable": True,
"dimensions": {},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceQuantity": 123,
"handlingQuantity": 123
}
],
"dimensions": {}
},
"equipmentOptions": [{ "description": "<string>" }],
"customer": {
"name": "<string>",
"externalIds": [{ "value": "<string>" }],
"id": "<string>",
"contacts": [
{
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
]
},
"route": { "stops": [
{
"stopReferences": [{ "value": "<string>" }],
"location": {
"address": {
"country": "<string>",
"postalCode": "<string>",
"city": "<string>",
"state": "<string>",
"addressTwo": "<string>",
"addressOne": "<string>"
},
"externalIds": [{ "value": "<string>" }],
"id": "<string>",
"name": "<string>",
"contacts": [
{
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
],
"hours": {}
},
"id": "<string>",
"externalNotes": "<string>",
"internalNotes": "<string>",
"accessorials": [
{
"size": { "value": 123 },
"type": "TARPING"
}
],
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
},
"commodities": [
{
"description": "<string>",
"isStackable": True,
"dimensions": {},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceQuantity": 123,
"handlingQuantity": 123
}
],
"notes": "<string>",
"dateTimeRanges": [
{
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"timezone": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
]
}
] },
"references": [{ "value": "<string>" }],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>",
"tmsStatus": "<string>",
"attributes": {},
"tags": ["<string>"],
"externalNotes": "<string>",
"internalNotes": "<string>",
"accessorials": [
{
"size": { "value": 123 },
"type": "TARPING"
}
]
}
],
"references": [{ "value": "<string>" }],
"freightModeDetails": {},
"chargesToCustomer": { "lineItems": [
{
"description": "<string>",
"amount": { "value": 123 }
}
] },
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
shipment: {
movements: [
{
cargo: {
commodities: [
{
description: '<string>',
isStackable: true,
dimensions: {},
nmfcCode: '<string>',
freightClass: '<string>',
pieceQuantity: 123,
handlingQuantity: 123
}
],
dimensions: {}
},
equipmentOptions: [{description: '<string>'}],
customer: {
name: '<string>',
externalIds: [{value: '<string>'}],
id: '<string>',
contacts: [
{
carrierId: '<string>',
id: '<string>',
name: '<string>',
phone: '<string>',
email: '<string>',
role: '<string>'
}
]
},
route: {
stops: [
{
stopReferences: [{value: '<string>'}],
location: {
address: {
country: '<string>',
postalCode: '<string>',
city: '<string>',
state: '<string>',
addressTwo: '<string>',
addressOne: '<string>'
},
externalIds: [{value: '<string>'}],
id: '<string>',
name: '<string>',
contacts: [
{
id: '<string>',
name: '<string>',
phone: '<string>',
email: '<string>',
role: '<string>'
}
],
hours: {}
},
id: '<string>',
externalNotes: '<string>',
internalNotes: '<string>',
accessorials: [{size: {value: 123}, type: 'TARPING'}],
contact: {
carrierId: '<string>',
id: '<string>',
name: '<string>',
phone: '<string>',
email: '<string>',
role: '<string>'
},
commodities: [
{
description: '<string>',
isStackable: true,
dimensions: {},
nmfcCode: '<string>',
freightClass: '<string>',
pieceQuantity: 123,
handlingQuantity: 123
}
],
notes: '<string>',
dateTimeRanges: [
{
startDate: '<string>',
endDate: '<string>',
startTime: '<string>',
endTime: '<string>',
timezone: '<string>'
}
],
externalIds: [{type: 'CUSTOM', value: '<string>'}]
}
]
},
references: [{value: '<string>'}],
externalIds: [{type: 'CUSTOM', value: '<string>'}],
id: '<string>',
tmsStatus: '<string>',
attributes: {},
tags: ['<string>'],
externalNotes: '<string>',
internalNotes: '<string>',
accessorials: [{size: {value: 123}, type: 'TARPING'}]
}
],
references: [{value: '<string>'}],
freightModeDetails: {},
chargesToCustomer: {lineItems: [{description: '<string>', amount: {value: 123}}]},
externalIds: [{type: 'CUSTOM', value: '<string>'}]
}
})
};
fetch('https://api.vooma.ai/v0/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.vooma.ai/v0/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([
'shipment' => [
'movements' => [
[
'cargo' => [
'commodities' => [
[
'description' => '<string>',
'isStackable' => true,
'dimensions' => [
],
'nmfcCode' => '<string>',
'freightClass' => '<string>',
'pieceQuantity' => 123,
'handlingQuantity' => 123
]
],
'dimensions' => [
]
],
'equipmentOptions' => [
[
'description' => '<string>'
]
],
'customer' => [
'name' => '<string>',
'externalIds' => [
[
'value' => '<string>'
]
],
'id' => '<string>',
'contacts' => [
[
'carrierId' => '<string>',
'id' => '<string>',
'name' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'role' => '<string>'
]
]
],
'route' => [
'stops' => [
[
'stopReferences' => [
[
'value' => '<string>'
]
],
'location' => [
'address' => [
'country' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'state' => '<string>',
'addressTwo' => '<string>',
'addressOne' => '<string>'
],
'externalIds' => [
[
'value' => '<string>'
]
],
'id' => '<string>',
'name' => '<string>',
'contacts' => [
[
'id' => '<string>',
'name' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'role' => '<string>'
]
],
'hours' => [
]
],
'id' => '<string>',
'externalNotes' => '<string>',
'internalNotes' => '<string>',
'accessorials' => [
[
'size' => [
'value' => 123
],
'type' => 'TARPING'
]
],
'contact' => [
'carrierId' => '<string>',
'id' => '<string>',
'name' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'role' => '<string>'
],
'commodities' => [
[
'description' => '<string>',
'isStackable' => true,
'dimensions' => [
],
'nmfcCode' => '<string>',
'freightClass' => '<string>',
'pieceQuantity' => 123,
'handlingQuantity' => 123
]
],
'notes' => '<string>',
'dateTimeRanges' => [
[
'startDate' => '<string>',
'endDate' => '<string>',
'startTime' => '<string>',
'endTime' => '<string>',
'timezone' => '<string>'
]
],
'externalIds' => [
[
'type' => 'CUSTOM',
'value' => '<string>'
]
]
]
]
],
'references' => [
[
'value' => '<string>'
]
],
'externalIds' => [
[
'type' => 'CUSTOM',
'value' => '<string>'
]
],
'id' => '<string>',
'tmsStatus' => '<string>',
'attributes' => [
],
'tags' => [
'<string>'
],
'externalNotes' => '<string>',
'internalNotes' => '<string>',
'accessorials' => [
[
'size' => [
'value' => 123
],
'type' => 'TARPING'
]
]
]
],
'references' => [
[
'value' => '<string>'
]
],
'freightModeDetails' => [
],
'chargesToCustomer' => [
'lineItems' => [
[
'description' => '<string>',
'amount' => [
'value' => 123
]
]
]
],
'externalIds' => [
[
'type' => 'CUSTOM',
'value' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vooma.ai/v0/shipments"
payload := strings.NewReader("{\n \"shipment\": {\n \"movements\": [\n {\n \"cargo\": {\n \"commodities\": [\n {\n \"description\": \"<string>\",\n \"isStackable\": true,\n \"dimensions\": {},\n \"nmfcCode\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"pieceQuantity\": 123,\n \"handlingQuantity\": 123\n }\n ],\n \"dimensions\": {}\n },\n \"equipmentOptions\": [\n {\n \"description\": \"<string>\"\n }\n ],\n \"customer\": {\n \"name\": \"<string>\",\n \"externalIds\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"contacts\": [\n {\n \"carrierId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n },\n \"route\": {\n \"stops\": [\n {\n \"stopReferences\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"location\": {\n \"address\": {\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"addressTwo\": \"<string>\",\n \"addressOne\": \"<string>\"\n },\n \"externalIds\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"contacts\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"hours\": {}\n },\n \"id\": \"<string>\",\n \"externalNotes\": \"<string>\",\n \"internalNotes\": \"<string>\",\n \"accessorials\": [\n {\n \"size\": {\n \"value\": 123\n },\n \"type\": \"TARPING\"\n }\n ],\n \"contact\": {\n \"carrierId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n },\n \"commodities\": [\n {\n \"description\": \"<string>\",\n \"isStackable\": true,\n \"dimensions\": {},\n \"nmfcCode\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"pieceQuantity\": 123,\n \"handlingQuantity\": 123\n }\n ],\n \"notes\": \"<string>\",\n \"dateTimeRanges\": [\n {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n ],\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"references\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"tmsStatus\": \"<string>\",\n \"attributes\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"externalNotes\": \"<string>\",\n \"internalNotes\": \"<string>\",\n \"accessorials\": [\n {\n \"size\": {\n \"value\": 123\n },\n \"type\": \"TARPING\"\n }\n ]\n }\n ],\n \"references\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"freightModeDetails\": {},\n \"chargesToCustomer\": {\n \"lineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": {\n \"value\": 123\n }\n }\n ]\n },\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vooma.ai/v0/shipments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"shipment\": {\n \"movements\": [\n {\n \"cargo\": {\n \"commodities\": [\n {\n \"description\": \"<string>\",\n \"isStackable\": true,\n \"dimensions\": {},\n \"nmfcCode\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"pieceQuantity\": 123,\n \"handlingQuantity\": 123\n }\n ],\n \"dimensions\": {}\n },\n \"equipmentOptions\": [\n {\n \"description\": \"<string>\"\n }\n ],\n \"customer\": {\n \"name\": \"<string>\",\n \"externalIds\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"contacts\": [\n {\n \"carrierId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n },\n \"route\": {\n \"stops\": [\n {\n \"stopReferences\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"location\": {\n \"address\": {\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"addressTwo\": \"<string>\",\n \"addressOne\": \"<string>\"\n },\n \"externalIds\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"contacts\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"hours\": {}\n },\n \"id\": \"<string>\",\n \"externalNotes\": \"<string>\",\n \"internalNotes\": \"<string>\",\n \"accessorials\": [\n {\n \"size\": {\n \"value\": 123\n },\n \"type\": \"TARPING\"\n }\n ],\n \"contact\": {\n \"carrierId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n },\n \"commodities\": [\n {\n \"description\": \"<string>\",\n \"isStackable\": true,\n \"dimensions\": {},\n \"nmfcCode\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"pieceQuantity\": 123,\n \"handlingQuantity\": 123\n }\n ],\n \"notes\": \"<string>\",\n \"dateTimeRanges\": [\n {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n ],\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"references\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"tmsStatus\": \"<string>\",\n \"attributes\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"externalNotes\": \"<string>\",\n \"internalNotes\": \"<string>\",\n \"accessorials\": [\n {\n \"size\": {\n \"value\": 123\n },\n \"type\": \"TARPING\"\n }\n ]\n }\n ],\n \"references\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"freightModeDetails\": {},\n \"chargesToCustomer\": {\n \"lineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": {\n \"value\": 123\n }\n }\n ]\n },\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vooma.ai/v0/shipments")
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 \"shipment\": {\n \"movements\": [\n {\n \"cargo\": {\n \"commodities\": [\n {\n \"description\": \"<string>\",\n \"isStackable\": true,\n \"dimensions\": {},\n \"nmfcCode\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"pieceQuantity\": 123,\n \"handlingQuantity\": 123\n }\n ],\n \"dimensions\": {}\n },\n \"equipmentOptions\": [\n {\n \"description\": \"<string>\"\n }\n ],\n \"customer\": {\n \"name\": \"<string>\",\n \"externalIds\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"contacts\": [\n {\n \"carrierId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n },\n \"route\": {\n \"stops\": [\n {\n \"stopReferences\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"location\": {\n \"address\": {\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"addressTwo\": \"<string>\",\n \"addressOne\": \"<string>\"\n },\n \"externalIds\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"contacts\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"hours\": {}\n },\n \"id\": \"<string>\",\n \"externalNotes\": \"<string>\",\n \"internalNotes\": \"<string>\",\n \"accessorials\": [\n {\n \"size\": {\n \"value\": 123\n },\n \"type\": \"TARPING\"\n }\n ],\n \"contact\": {\n \"carrierId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n },\n \"commodities\": [\n {\n \"description\": \"<string>\",\n \"isStackable\": true,\n \"dimensions\": {},\n \"nmfcCode\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"pieceQuantity\": 123,\n \"handlingQuantity\": 123\n }\n ],\n \"notes\": \"<string>\",\n \"dateTimeRanges\": [\n {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n ],\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"references\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"tmsStatus\": \"<string>\",\n \"attributes\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"externalNotes\": \"<string>\",\n \"internalNotes\": \"<string>\",\n \"accessorials\": [\n {\n \"size\": {\n \"value\": 123\n },\n \"type\": \"TARPING\"\n }\n ]\n }\n ],\n \"references\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"freightModeDetails\": {},\n \"chargesToCustomer\": {\n \"lineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": {\n \"value\": 123\n }\n }\n ]\n },\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"movements": [
{
"cargo": {
"commodities": [
{
"description": "<string>",
"isStackable": true,
"itemReference": {
"value": "<string>"
},
"dimensions": {
"height": {
"value": 123
},
"width": {
"value": 123
},
"length": {
"value": 123
}
},
"weight": {
"value": 123
},
"hazmat": {
"classifications": [
{}
],
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>",
"reference": {
"value": "<string>"
}
},
"packingGroup": "<string>",
"unNumber": "<string>",
"weight": {
"value": 123
}
},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceQuantity": 123,
"handlingQuantity": 123
}
],
"declaredValue": {
"value": 123
},
"dimensions": {
"height": {
"value": 123
},
"width": {
"value": 123
},
"length": {
"value": 123
}
},
"totalWeight": {
"value": 123
}
},
"equipmentOptions": [
{
"equipmentLength": {
"value": 123
},
"temperature": {
"max": 123,
"min": 123
},
"description": "<string>"
}
],
"customer": {
"name": "<string>",
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>",
"contacts": [
{
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
]
},
"route": {
"stops": [
{
"stopReferences": [
{
"value": "<string>"
}
],
"location": {
"address": {
"country": "<string>",
"postalCode": "<string>",
"city": "<string>",
"state": "<string>",
"addressTwo": "<string>",
"addressOne": "<string>"
},
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>",
"name": "<string>",
"contacts": [
{
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
],
"hours": {
"sunday": {
"type": "FACILITY_HOURS",
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"saturday": {
"type": "FACILITY_HOURS",
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"friday": {
"type": "FACILITY_HOURS",
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"thursday": {
"type": "FACILITY_HOURS",
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"wednesday": {
"type": "FACILITY_HOURS",
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"tuesday": {
"type": "FACILITY_HOURS",
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"monday": {
"type": "FACILITY_HOURS",
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
}
},
"scheduling": {
"methods": [
{
"contact": {
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
},
"type": "EMAIL"
}
],
"maxDaysAhead": 123,
"notes": "<string>"
},
"geoCoordinates": {
"longitude": 123,
"latitude": 123
}
},
"id": "<string>",
"externalNotes": "<string>",
"internalNotes": "<string>",
"accessorials": [
{
"size": {
"value": 123
},
"type": "TARPING"
}
],
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
},
"commodities": [
{
"description": "<string>",
"isStackable": true,
"itemReference": {
"value": "<string>"
},
"dimensions": {
"height": {
"value": 123
},
"width": {
"value": 123
},
"length": {
"value": 123
}
},
"weight": {
"value": 123
},
"hazmat": {
"classifications": [
{}
],
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>",
"reference": {
"value": "<string>"
}
},
"packingGroup": "<string>",
"unNumber": "<string>",
"weight": {
"value": 123
}
},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceQuantity": 123,
"handlingQuantity": 123
}
],
"weight": {
"value": 123
},
"notes": "<string>",
"dateTimeRanges": [
{
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"timezone": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
]
}
],
"mileage": {
"value": 123
}
},
"references": [
{
"value": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>",
"tmsStatus": "<string>",
"attributes": {},
"tags": [
"<string>"
],
"externalNotes": "<string>",
"internalNotes": "<string>",
"carrier": {
"carrier": {
"name": "<string>",
"id": "<string>",
"equipment": [
{
"equipment": {
"equipmentLength": {
"value": 123
},
"temperature": {
"max": 123,
"min": 123
},
"description": "<string>"
},
"trailerNumber": "<string>",
"truckNumber": "<string>"
}
],
"contacts": [
{
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
}
],
"dotNumber": "<string>",
"mcNumber": "<string>"
},
"assignedDispatch": {
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
},
"assignedDriver": {
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
},
"assignedEquipment": {
"equipment": {
"equipmentLength": {
"value": 123
},
"temperature": {
"max": 123,
"min": 123
},
"description": "<string>"
},
"trailerNumber": "<string>",
"truckNumber": "<string>"
}
},
"financials": {
"costs": {
"lineItems": [
{
"description": "<string>",
"amount": {
"value": 123
}
}
]
},
"costNegotiationGuidance": {
"maxPrice": {
"value": 123
},
"startingPrice": {
"value": 123
}
}
},
"accessorials": [
{
"size": {
"value": 123
},
"type": "TARPING"
}
],
"freightModeDetails": {},
"responsibleUser": {
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>"
}
}
],
"references": [
{
"value": "<string>"
}
],
"freightModeDetails": {},
"chargesToCustomer": {
"lineItems": [
{
"description": "<string>",
"amount": {
"value": 123
}
}
]
},
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"responsibleUser": {
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>"
}
}Shipments
Create Shipment
POST
/
shipments
cURL
curl --request POST \
--url https://api.vooma.ai/v0/shipments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"shipment": {
"movements": [
{
"cargo": {
"commodities": [
{
"description": "<string>",
"isStackable": true,
"dimensions": {},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceQuantity": 123,
"handlingQuantity": 123
}
],
"dimensions": {}
},
"equipmentOptions": [
{
"description": "<string>"
}
],
"customer": {
"name": "<string>",
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>",
"contacts": [
{
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
]
},
"route": {
"stops": [
{
"stopReferences": [
{
"value": "<string>"
}
],
"location": {
"address": {
"country": "<string>",
"postalCode": "<string>",
"city": "<string>",
"state": "<string>",
"addressTwo": "<string>",
"addressOne": "<string>"
},
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>",
"name": "<string>",
"contacts": [
{
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
],
"hours": {}
},
"id": "<string>",
"externalNotes": "<string>",
"internalNotes": "<string>",
"accessorials": [
{
"size": {
"value": 123
},
"type": "TARPING"
}
],
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
},
"commodities": [
{
"description": "<string>",
"isStackable": true,
"dimensions": {},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceQuantity": 123,
"handlingQuantity": 123
}
],
"notes": "<string>",
"dateTimeRanges": [
{
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"timezone": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
]
}
]
},
"references": [
{
"value": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>",
"tmsStatus": "<string>",
"attributes": {},
"tags": [
"<string>"
],
"externalNotes": "<string>",
"internalNotes": "<string>",
"accessorials": [
{
"size": {
"value": 123
},
"type": "TARPING"
}
]
}
],
"references": [
{
"value": "<string>"
}
],
"freightModeDetails": {},
"chargesToCustomer": {
"lineItems": [
{
"description": "<string>",
"amount": {
"value": 123
}
}
]
},
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
]
}
}
'import requests
url = "https://api.vooma.ai/v0/shipments"
payload = { "shipment": {
"movements": [
{
"cargo": {
"commodities": [
{
"description": "<string>",
"isStackable": True,
"dimensions": {},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceQuantity": 123,
"handlingQuantity": 123
}
],
"dimensions": {}
},
"equipmentOptions": [{ "description": "<string>" }],
"customer": {
"name": "<string>",
"externalIds": [{ "value": "<string>" }],
"id": "<string>",
"contacts": [
{
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
]
},
"route": { "stops": [
{
"stopReferences": [{ "value": "<string>" }],
"location": {
"address": {
"country": "<string>",
"postalCode": "<string>",
"city": "<string>",
"state": "<string>",
"addressTwo": "<string>",
"addressOne": "<string>"
},
"externalIds": [{ "value": "<string>" }],
"id": "<string>",
"name": "<string>",
"contacts": [
{
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
],
"hours": {}
},
"id": "<string>",
"externalNotes": "<string>",
"internalNotes": "<string>",
"accessorials": [
{
"size": { "value": 123 },
"type": "TARPING"
}
],
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
},
"commodities": [
{
"description": "<string>",
"isStackable": True,
"dimensions": {},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceQuantity": 123,
"handlingQuantity": 123
}
],
"notes": "<string>",
"dateTimeRanges": [
{
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"timezone": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
]
}
] },
"references": [{ "value": "<string>" }],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>",
"tmsStatus": "<string>",
"attributes": {},
"tags": ["<string>"],
"externalNotes": "<string>",
"internalNotes": "<string>",
"accessorials": [
{
"size": { "value": 123 },
"type": "TARPING"
}
]
}
],
"references": [{ "value": "<string>" }],
"freightModeDetails": {},
"chargesToCustomer": { "lineItems": [
{
"description": "<string>",
"amount": { "value": 123 }
}
] },
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
shipment: {
movements: [
{
cargo: {
commodities: [
{
description: '<string>',
isStackable: true,
dimensions: {},
nmfcCode: '<string>',
freightClass: '<string>',
pieceQuantity: 123,
handlingQuantity: 123
}
],
dimensions: {}
},
equipmentOptions: [{description: '<string>'}],
customer: {
name: '<string>',
externalIds: [{value: '<string>'}],
id: '<string>',
contacts: [
{
carrierId: '<string>',
id: '<string>',
name: '<string>',
phone: '<string>',
email: '<string>',
role: '<string>'
}
]
},
route: {
stops: [
{
stopReferences: [{value: '<string>'}],
location: {
address: {
country: '<string>',
postalCode: '<string>',
city: '<string>',
state: '<string>',
addressTwo: '<string>',
addressOne: '<string>'
},
externalIds: [{value: '<string>'}],
id: '<string>',
name: '<string>',
contacts: [
{
id: '<string>',
name: '<string>',
phone: '<string>',
email: '<string>',
role: '<string>'
}
],
hours: {}
},
id: '<string>',
externalNotes: '<string>',
internalNotes: '<string>',
accessorials: [{size: {value: 123}, type: 'TARPING'}],
contact: {
carrierId: '<string>',
id: '<string>',
name: '<string>',
phone: '<string>',
email: '<string>',
role: '<string>'
},
commodities: [
{
description: '<string>',
isStackable: true,
dimensions: {},
nmfcCode: '<string>',
freightClass: '<string>',
pieceQuantity: 123,
handlingQuantity: 123
}
],
notes: '<string>',
dateTimeRanges: [
{
startDate: '<string>',
endDate: '<string>',
startTime: '<string>',
endTime: '<string>',
timezone: '<string>'
}
],
externalIds: [{type: 'CUSTOM', value: '<string>'}]
}
]
},
references: [{value: '<string>'}],
externalIds: [{type: 'CUSTOM', value: '<string>'}],
id: '<string>',
tmsStatus: '<string>',
attributes: {},
tags: ['<string>'],
externalNotes: '<string>',
internalNotes: '<string>',
accessorials: [{size: {value: 123}, type: 'TARPING'}]
}
],
references: [{value: '<string>'}],
freightModeDetails: {},
chargesToCustomer: {lineItems: [{description: '<string>', amount: {value: 123}}]},
externalIds: [{type: 'CUSTOM', value: '<string>'}]
}
})
};
fetch('https://api.vooma.ai/v0/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.vooma.ai/v0/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([
'shipment' => [
'movements' => [
[
'cargo' => [
'commodities' => [
[
'description' => '<string>',
'isStackable' => true,
'dimensions' => [
],
'nmfcCode' => '<string>',
'freightClass' => '<string>',
'pieceQuantity' => 123,
'handlingQuantity' => 123
]
],
'dimensions' => [
]
],
'equipmentOptions' => [
[
'description' => '<string>'
]
],
'customer' => [
'name' => '<string>',
'externalIds' => [
[
'value' => '<string>'
]
],
'id' => '<string>',
'contacts' => [
[
'carrierId' => '<string>',
'id' => '<string>',
'name' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'role' => '<string>'
]
]
],
'route' => [
'stops' => [
[
'stopReferences' => [
[
'value' => '<string>'
]
],
'location' => [
'address' => [
'country' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'state' => '<string>',
'addressTwo' => '<string>',
'addressOne' => '<string>'
],
'externalIds' => [
[
'value' => '<string>'
]
],
'id' => '<string>',
'name' => '<string>',
'contacts' => [
[
'id' => '<string>',
'name' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'role' => '<string>'
]
],
'hours' => [
]
],
'id' => '<string>',
'externalNotes' => '<string>',
'internalNotes' => '<string>',
'accessorials' => [
[
'size' => [
'value' => 123
],
'type' => 'TARPING'
]
],
'contact' => [
'carrierId' => '<string>',
'id' => '<string>',
'name' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'role' => '<string>'
],
'commodities' => [
[
'description' => '<string>',
'isStackable' => true,
'dimensions' => [
],
'nmfcCode' => '<string>',
'freightClass' => '<string>',
'pieceQuantity' => 123,
'handlingQuantity' => 123
]
],
'notes' => '<string>',
'dateTimeRanges' => [
[
'startDate' => '<string>',
'endDate' => '<string>',
'startTime' => '<string>',
'endTime' => '<string>',
'timezone' => '<string>'
]
],
'externalIds' => [
[
'type' => 'CUSTOM',
'value' => '<string>'
]
]
]
]
],
'references' => [
[
'value' => '<string>'
]
],
'externalIds' => [
[
'type' => 'CUSTOM',
'value' => '<string>'
]
],
'id' => '<string>',
'tmsStatus' => '<string>',
'attributes' => [
],
'tags' => [
'<string>'
],
'externalNotes' => '<string>',
'internalNotes' => '<string>',
'accessorials' => [
[
'size' => [
'value' => 123
],
'type' => 'TARPING'
]
]
]
],
'references' => [
[
'value' => '<string>'
]
],
'freightModeDetails' => [
],
'chargesToCustomer' => [
'lineItems' => [
[
'description' => '<string>',
'amount' => [
'value' => 123
]
]
]
],
'externalIds' => [
[
'type' => 'CUSTOM',
'value' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vooma.ai/v0/shipments"
payload := strings.NewReader("{\n \"shipment\": {\n \"movements\": [\n {\n \"cargo\": {\n \"commodities\": [\n {\n \"description\": \"<string>\",\n \"isStackable\": true,\n \"dimensions\": {},\n \"nmfcCode\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"pieceQuantity\": 123,\n \"handlingQuantity\": 123\n }\n ],\n \"dimensions\": {}\n },\n \"equipmentOptions\": [\n {\n \"description\": \"<string>\"\n }\n ],\n \"customer\": {\n \"name\": \"<string>\",\n \"externalIds\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"contacts\": [\n {\n \"carrierId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n },\n \"route\": {\n \"stops\": [\n {\n \"stopReferences\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"location\": {\n \"address\": {\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"addressTwo\": \"<string>\",\n \"addressOne\": \"<string>\"\n },\n \"externalIds\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"contacts\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"hours\": {}\n },\n \"id\": \"<string>\",\n \"externalNotes\": \"<string>\",\n \"internalNotes\": \"<string>\",\n \"accessorials\": [\n {\n \"size\": {\n \"value\": 123\n },\n \"type\": \"TARPING\"\n }\n ],\n \"contact\": {\n \"carrierId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n },\n \"commodities\": [\n {\n \"description\": \"<string>\",\n \"isStackable\": true,\n \"dimensions\": {},\n \"nmfcCode\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"pieceQuantity\": 123,\n \"handlingQuantity\": 123\n }\n ],\n \"notes\": \"<string>\",\n \"dateTimeRanges\": [\n {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n ],\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"references\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"tmsStatus\": \"<string>\",\n \"attributes\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"externalNotes\": \"<string>\",\n \"internalNotes\": \"<string>\",\n \"accessorials\": [\n {\n \"size\": {\n \"value\": 123\n },\n \"type\": \"TARPING\"\n }\n ]\n }\n ],\n \"references\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"freightModeDetails\": {},\n \"chargesToCustomer\": {\n \"lineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": {\n \"value\": 123\n }\n }\n ]\n },\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vooma.ai/v0/shipments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"shipment\": {\n \"movements\": [\n {\n \"cargo\": {\n \"commodities\": [\n {\n \"description\": \"<string>\",\n \"isStackable\": true,\n \"dimensions\": {},\n \"nmfcCode\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"pieceQuantity\": 123,\n \"handlingQuantity\": 123\n }\n ],\n \"dimensions\": {}\n },\n \"equipmentOptions\": [\n {\n \"description\": \"<string>\"\n }\n ],\n \"customer\": {\n \"name\": \"<string>\",\n \"externalIds\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"contacts\": [\n {\n \"carrierId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n },\n \"route\": {\n \"stops\": [\n {\n \"stopReferences\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"location\": {\n \"address\": {\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"addressTwo\": \"<string>\",\n \"addressOne\": \"<string>\"\n },\n \"externalIds\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"contacts\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"hours\": {}\n },\n \"id\": \"<string>\",\n \"externalNotes\": \"<string>\",\n \"internalNotes\": \"<string>\",\n \"accessorials\": [\n {\n \"size\": {\n \"value\": 123\n },\n \"type\": \"TARPING\"\n }\n ],\n \"contact\": {\n \"carrierId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n },\n \"commodities\": [\n {\n \"description\": \"<string>\",\n \"isStackable\": true,\n \"dimensions\": {},\n \"nmfcCode\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"pieceQuantity\": 123,\n \"handlingQuantity\": 123\n }\n ],\n \"notes\": \"<string>\",\n \"dateTimeRanges\": [\n {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n ],\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"references\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"tmsStatus\": \"<string>\",\n \"attributes\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"externalNotes\": \"<string>\",\n \"internalNotes\": \"<string>\",\n \"accessorials\": [\n {\n \"size\": {\n \"value\": 123\n },\n \"type\": \"TARPING\"\n }\n ]\n }\n ],\n \"references\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"freightModeDetails\": {},\n \"chargesToCustomer\": {\n \"lineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": {\n \"value\": 123\n }\n }\n ]\n },\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vooma.ai/v0/shipments")
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 \"shipment\": {\n \"movements\": [\n {\n \"cargo\": {\n \"commodities\": [\n {\n \"description\": \"<string>\",\n \"isStackable\": true,\n \"dimensions\": {},\n \"nmfcCode\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"pieceQuantity\": 123,\n \"handlingQuantity\": 123\n }\n ],\n \"dimensions\": {}\n },\n \"equipmentOptions\": [\n {\n \"description\": \"<string>\"\n }\n ],\n \"customer\": {\n \"name\": \"<string>\",\n \"externalIds\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"contacts\": [\n {\n \"carrierId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n },\n \"route\": {\n \"stops\": [\n {\n \"stopReferences\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"location\": {\n \"address\": {\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"addressTwo\": \"<string>\",\n \"addressOne\": \"<string>\"\n },\n \"externalIds\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"contacts\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"hours\": {}\n },\n \"id\": \"<string>\",\n \"externalNotes\": \"<string>\",\n \"internalNotes\": \"<string>\",\n \"accessorials\": [\n {\n \"size\": {\n \"value\": 123\n },\n \"type\": \"TARPING\"\n }\n ],\n \"contact\": {\n \"carrierId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"role\": \"<string>\"\n },\n \"commodities\": [\n {\n \"description\": \"<string>\",\n \"isStackable\": true,\n \"dimensions\": {},\n \"nmfcCode\": \"<string>\",\n \"freightClass\": \"<string>\",\n \"pieceQuantity\": 123,\n \"handlingQuantity\": 123\n }\n ],\n \"notes\": \"<string>\",\n \"dateTimeRanges\": [\n {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n ],\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"references\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"tmsStatus\": \"<string>\",\n \"attributes\": {},\n \"tags\": [\n \"<string>\"\n ],\n \"externalNotes\": \"<string>\",\n \"internalNotes\": \"<string>\",\n \"accessorials\": [\n {\n \"size\": {\n \"value\": 123\n },\n \"type\": \"TARPING\"\n }\n ]\n }\n ],\n \"references\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"freightModeDetails\": {},\n \"chargesToCustomer\": {\n \"lineItems\": [\n {\n \"description\": \"<string>\",\n \"amount\": {\n \"value\": 123\n }\n }\n ]\n },\n \"externalIds\": [\n {\n \"type\": \"CUSTOM\",\n \"value\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"movements": [
{
"cargo": {
"commodities": [
{
"description": "<string>",
"isStackable": true,
"itemReference": {
"value": "<string>"
},
"dimensions": {
"height": {
"value": 123
},
"width": {
"value": 123
},
"length": {
"value": 123
}
},
"weight": {
"value": 123
},
"hazmat": {
"classifications": [
{}
],
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>",
"reference": {
"value": "<string>"
}
},
"packingGroup": "<string>",
"unNumber": "<string>",
"weight": {
"value": 123
}
},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceQuantity": 123,
"handlingQuantity": 123
}
],
"declaredValue": {
"value": 123
},
"dimensions": {
"height": {
"value": 123
},
"width": {
"value": 123
},
"length": {
"value": 123
}
},
"totalWeight": {
"value": 123
}
},
"equipmentOptions": [
{
"equipmentLength": {
"value": 123
},
"temperature": {
"max": 123,
"min": 123
},
"description": "<string>"
}
],
"customer": {
"name": "<string>",
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>",
"contacts": [
{
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
]
},
"route": {
"stops": [
{
"stopReferences": [
{
"value": "<string>"
}
],
"location": {
"address": {
"country": "<string>",
"postalCode": "<string>",
"city": "<string>",
"state": "<string>",
"addressTwo": "<string>",
"addressOne": "<string>"
},
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>",
"name": "<string>",
"contacts": [
{
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
],
"hours": {
"sunday": {
"type": "FACILITY_HOURS",
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"saturday": {
"type": "FACILITY_HOURS",
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"friday": {
"type": "FACILITY_HOURS",
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"thursday": {
"type": "FACILITY_HOURS",
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"wednesday": {
"type": "FACILITY_HOURS",
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"tuesday": {
"type": "FACILITY_HOURS",
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"monday": {
"type": "FACILITY_HOURS",
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
}
},
"scheduling": {
"methods": [
{
"contact": {
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
},
"type": "EMAIL"
}
],
"maxDaysAhead": 123,
"notes": "<string>"
},
"geoCoordinates": {
"longitude": 123,
"latitude": 123
}
},
"id": "<string>",
"externalNotes": "<string>",
"internalNotes": "<string>",
"accessorials": [
{
"size": {
"value": 123
},
"type": "TARPING"
}
],
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
},
"commodities": [
{
"description": "<string>",
"isStackable": true,
"itemReference": {
"value": "<string>"
},
"dimensions": {
"height": {
"value": 123
},
"width": {
"value": 123
},
"length": {
"value": 123
}
},
"weight": {
"value": 123
},
"hazmat": {
"classifications": [
{}
],
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>",
"reference": {
"value": "<string>"
}
},
"packingGroup": "<string>",
"unNumber": "<string>",
"weight": {
"value": 123
}
},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceQuantity": 123,
"handlingQuantity": 123
}
],
"weight": {
"value": 123
},
"notes": "<string>",
"dateTimeRanges": [
{
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"timezone": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
]
}
],
"mileage": {
"value": 123
}
},
"references": [
{
"value": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>",
"tmsStatus": "<string>",
"attributes": {},
"tags": [
"<string>"
],
"externalNotes": "<string>",
"internalNotes": "<string>",
"carrier": {
"carrier": {
"name": "<string>",
"id": "<string>",
"equipment": [
{
"equipment": {
"equipmentLength": {
"value": 123
},
"temperature": {
"max": 123,
"min": 123
},
"description": "<string>"
},
"trailerNumber": "<string>",
"truckNumber": "<string>"
}
],
"contacts": [
{
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
}
],
"dotNumber": "<string>",
"mcNumber": "<string>"
},
"assignedDispatch": {
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
},
"assignedDriver": {
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
},
"assignedEquipment": {
"equipment": {
"equipmentLength": {
"value": 123
},
"temperature": {
"max": 123,
"min": 123
},
"description": "<string>"
},
"trailerNumber": "<string>",
"truckNumber": "<string>"
}
},
"financials": {
"costs": {
"lineItems": [
{
"description": "<string>",
"amount": {
"value": 123
}
}
]
},
"costNegotiationGuidance": {
"maxPrice": {
"value": 123
},
"startingPrice": {
"value": 123
}
}
},
"accessorials": [
{
"size": {
"value": 123
},
"type": "TARPING"
}
],
"freightModeDetails": {},
"responsibleUser": {
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>"
}
}
],
"references": [
{
"value": "<string>"
}
],
"freightModeDetails": {},
"chargesToCustomer": {
"lineItems": [
{
"description": "<string>",
"amount": {
"value": 123
}
}
]
},
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"responsibleUser": {
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>"
}
}Beta Feature: This functionality is currently in beta. You
may experience changes or limited support as we continue to improve it.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Show child attributes
Show child attributes
Response
200 - application/json
Ok
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
⌘I