Sync a load
curl --request POST \
--url https://api.cargado.com/loads/sync \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"load": {
"externalId": "456293",
"externalCustomerId": "ACMECORP",
"trailerRequirements": {
"allowedTypes": [
"DRY_VAN_53"
],
"maxAgeYears": 123,
"highCube": true,
"spaceSaver": true,
"foodGrade": true,
"logisticPost": true,
"extendable": true,
"liftGate": true,
"minAxles": 123,
"metalEdgeProtectors": true,
"airChute": true,
"ctpatCompliant": true,
"floorTypes": []
},
"carrierRequirements": {
"ctpatCertified": true,
"oeaCertified": true,
"pipCertified": true,
"fastCertified": true,
"internationalCarrierBonded": true,
"internationalCarrierBondedUS": true,
"internationalCarrierBondedCA": true,
"internationalCarrierBondedMX": true,
"has247CustomerService": true,
"minCargoInsurance": {
"amount": 500000000
}
},
"driverRequirements": {
"twicCard": true,
"tankerEndorsed": true,
"cdl": true
},
"stops": [
{
"type": "PICKUP",
"externalId": "27924_1",
"location": {
"place": {
"type": "ADDRESS",
"city": "Chicago",
"street": "123 Main St",
"neighborhood": "Valle Oriente",
"state": "IL",
"postalCode": "98335"
},
"isCtpatCertified": true,
"isPipCertified": true,
"isOeaCertified": true,
"timezone": "America/Chicago"
},
"appointment": {
"type": "UNSPECIFIED"
},
"referenceNumbers": [
{
"label": "Shipment #",
"value": "1234234"
}
],
"inboundTransitRequirements": {
"maximumExpectedMinutes": 123,
"teamDriverRequired": true,
"trackingRequired": true
},
"dropDurationHours": 24,
"fumigation": {
"requiredBefore": true,
"requiredAfter": true
},
"scaleTicket": {
"requiredBefore": true,
"requiredAfter": true
},
"driverAssistRequired": true
}
],
"externalDisplayId": "ORD-2024-001",
"externalWorkspaceId": "<string>",
"referenceNumbers": [
{
"label": "Shipment #",
"value": "1234234"
}
],
"commodities": [
{
"name": "Crude Oil",
"hazmatDetails": {
"isHazmat": true,
"classification": "CLASS_3_FLAMMABLE_LIQUIDS",
"unNumber": "1263",
"packingGroup": "II"
},
"dimensions": {
"length": {
"value": 576,
"unit": "INCHES"
},
"width": {
"value": 120,
"unit": "INCHES"
},
"height": {
"value": 72,
"unit": "INCHES"
}
},
"weight": {
"type": "APPROXIMATE",
"value": 123
},
"temperatureRequirements": {
"minimum": 10,
"maximum": 20,
"unit": "CELSIUS"
},
"pieces": {
"type": "PALLET",
"stackable": true,
"perPieceVolume": {
"value": 100,
"unit": "GALLONS"
},
"perPieceDimensions": {
"length": {
"value": 576,
"unit": "INCHES"
},
"width": {
"value": 120,
"unit": "INCHES"
},
"height": {
"value": 72,
"unit": "INCHES"
}
},
"count": 10
}
}
],
"requiredEquipment": [
{
"quantity": 500.5
}
],
"metadata": {
"tmsOrderId": "1314234",
"customerName": "Acme Corp",
"weight": 4200,
"expedited": true
},
"roundTrip": true,
"linearFeet": 123,
"maxBuy": {
"amount": 500000000
},
"targetRate": {
"amount": 500000000
},
"externalOwnerCoverageUserId": "user_12345",
"externalOwnerCoverageTeamId": "team_67890",
"borderCrossings": [
{
"type": "BORDER_CROSSING",
"externalId": "27924_1",
"referenceNumbers": [
{
"label": "Shipment #",
"value": "1234234"
}
],
"requiredInspections": [],
"expectedDwellTimeMinutes": 12
}
],
"assignedCarrier": {
"carrier": {
"dotNumber": "123456",
"mcNumber": "248243",
"mxNumber": "2343",
"rfcNumber": "RUSM2344227MY4",
"cvorNumber": "2344227MY4",
"nirNumber": "R-23424",
"nscNumber": "2344227MY4",
"externalId": "GJNTMIIN"
},
"price": {
"lineItems": [
{
"value": {
"amount": 500000000
},
"externalId": "<string>",
"externalCode": "<string>",
"externalDescription": "<string>"
}
]
}
},
"schemaVersionNumber": 0
}
}
'import requests
url = "https://api.cargado.com/loads/sync"
payload = { "load": {
"externalId": "456293",
"externalCustomerId": "ACMECORP",
"trailerRequirements": {
"allowedTypes": ["DRY_VAN_53"],
"maxAgeYears": 123,
"highCube": True,
"spaceSaver": True,
"foodGrade": True,
"logisticPost": True,
"extendable": True,
"liftGate": True,
"minAxles": 123,
"metalEdgeProtectors": True,
"airChute": True,
"ctpatCompliant": True,
"floorTypes": []
},
"carrierRequirements": {
"ctpatCertified": True,
"oeaCertified": True,
"pipCertified": True,
"fastCertified": True,
"internationalCarrierBonded": True,
"internationalCarrierBondedUS": True,
"internationalCarrierBondedCA": True,
"internationalCarrierBondedMX": True,
"has247CustomerService": True,
"minCargoInsurance": { "amount": 500000000 }
},
"driverRequirements": {
"twicCard": True,
"tankerEndorsed": True,
"cdl": True
},
"stops": [
{
"type": "PICKUP",
"externalId": "27924_1",
"location": {
"place": {
"type": "ADDRESS",
"city": "Chicago",
"street": "123 Main St",
"neighborhood": "Valle Oriente",
"state": "IL",
"postalCode": "98335"
},
"isCtpatCertified": True,
"isPipCertified": True,
"isOeaCertified": True,
"timezone": "America/Chicago"
},
"appointment": { "type": "UNSPECIFIED" },
"referenceNumbers": [
{
"label": "Shipment #",
"value": "1234234"
}
],
"inboundTransitRequirements": {
"maximumExpectedMinutes": 123,
"teamDriverRequired": True,
"trackingRequired": True
},
"dropDurationHours": 24,
"fumigation": {
"requiredBefore": True,
"requiredAfter": True
},
"scaleTicket": {
"requiredBefore": True,
"requiredAfter": True
},
"driverAssistRequired": True
}
],
"externalDisplayId": "ORD-2024-001",
"externalWorkspaceId": "<string>",
"referenceNumbers": [
{
"label": "Shipment #",
"value": "1234234"
}
],
"commodities": [
{
"name": "Crude Oil",
"hazmatDetails": {
"isHazmat": True,
"classification": "CLASS_3_FLAMMABLE_LIQUIDS",
"unNumber": "1263",
"packingGroup": "II"
},
"dimensions": {
"length": {
"value": 576,
"unit": "INCHES"
},
"width": {
"value": 120,
"unit": "INCHES"
},
"height": {
"value": 72,
"unit": "INCHES"
}
},
"weight": {
"type": "APPROXIMATE",
"value": 123
},
"temperatureRequirements": {
"minimum": 10,
"maximum": 20,
"unit": "CELSIUS"
},
"pieces": {
"type": "PALLET",
"stackable": True,
"perPieceVolume": {
"value": 100,
"unit": "GALLONS"
},
"perPieceDimensions": {
"length": {
"value": 576,
"unit": "INCHES"
},
"width": {
"value": 120,
"unit": "INCHES"
},
"height": {
"value": 72,
"unit": "INCHES"
}
},
"count": 10
}
}
],
"requiredEquipment": [{ "quantity": 500.5 }],
"metadata": {
"tmsOrderId": "1314234",
"customerName": "Acme Corp",
"weight": 4200,
"expedited": True
},
"roundTrip": True,
"linearFeet": 123,
"maxBuy": { "amount": 500000000 },
"targetRate": { "amount": 500000000 },
"externalOwnerCoverageUserId": "user_12345",
"externalOwnerCoverageTeamId": "team_67890",
"borderCrossings": [
{
"type": "BORDER_CROSSING",
"externalId": "27924_1",
"referenceNumbers": [
{
"label": "Shipment #",
"value": "1234234"
}
],
"requiredInspections": [],
"expectedDwellTimeMinutes": 12
}
],
"assignedCarrier": {
"carrier": {
"dotNumber": "123456",
"mcNumber": "248243",
"mxNumber": "2343",
"rfcNumber": "RUSM2344227MY4",
"cvorNumber": "2344227MY4",
"nirNumber": "R-23424",
"nscNumber": "2344227MY4",
"externalId": "GJNTMIIN"
},
"price": { "lineItems": [
{
"value": { "amount": 500000000 },
"externalId": "<string>",
"externalCode": "<string>",
"externalDescription": "<string>"
}
] }
},
"schemaVersionNumber": 0
} }
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
load: {
externalId: '456293',
externalCustomerId: 'ACMECORP',
trailerRequirements: {
allowedTypes: ['DRY_VAN_53'],
maxAgeYears: 123,
highCube: true,
spaceSaver: true,
foodGrade: true,
logisticPost: true,
extendable: true,
liftGate: true,
minAxles: 123,
metalEdgeProtectors: true,
airChute: true,
ctpatCompliant: true,
floorTypes: []
},
carrierRequirements: {
ctpatCertified: true,
oeaCertified: true,
pipCertified: true,
fastCertified: true,
internationalCarrierBonded: true,
internationalCarrierBondedUS: true,
internationalCarrierBondedCA: true,
internationalCarrierBondedMX: true,
has247CustomerService: true,
minCargoInsurance: {amount: 500000000}
},
driverRequirements: {twicCard: true, tankerEndorsed: true, cdl: true},
stops: [
{
type: 'PICKUP',
externalId: '27924_1',
location: {
place: {
type: 'ADDRESS',
city: 'Chicago',
street: '123 Main St',
neighborhood: 'Valle Oriente',
state: 'IL',
postalCode: '98335'
},
isCtpatCertified: true,
isPipCertified: true,
isOeaCertified: true,
timezone: 'America/Chicago'
},
appointment: {type: 'UNSPECIFIED'},
referenceNumbers: [{label: 'Shipment #', value: '1234234'}],
inboundTransitRequirements: {maximumExpectedMinutes: 123, teamDriverRequired: true, trackingRequired: true},
dropDurationHours: 24,
fumigation: {requiredBefore: true, requiredAfter: true},
scaleTicket: {requiredBefore: true, requiredAfter: true},
driverAssistRequired: true
}
],
externalDisplayId: 'ORD-2024-001',
externalWorkspaceId: '<string>',
referenceNumbers: [{label: 'Shipment #', value: '1234234'}],
commodities: [
{
name: 'Crude Oil',
hazmatDetails: {
isHazmat: true,
classification: 'CLASS_3_FLAMMABLE_LIQUIDS',
unNumber: '1263',
packingGroup: 'II'
},
dimensions: {
length: {value: 576, unit: 'INCHES'},
width: {value: 120, unit: 'INCHES'},
height: {value: 72, unit: 'INCHES'}
},
weight: {type: 'APPROXIMATE', value: 123},
temperatureRequirements: {minimum: 10, maximum: 20, unit: 'CELSIUS'},
pieces: {
type: 'PALLET',
stackable: true,
perPieceVolume: {value: 100, unit: 'GALLONS'},
perPieceDimensions: {
length: {value: 576, unit: 'INCHES'},
width: {value: 120, unit: 'INCHES'},
height: {value: 72, unit: 'INCHES'}
},
count: 10
}
}
],
requiredEquipment: [{quantity: 500.5}],
metadata: {
tmsOrderId: '1314234',
customerName: 'Acme Corp',
weight: 4200,
expedited: true
},
roundTrip: true,
linearFeet: 123,
maxBuy: {amount: 500000000},
targetRate: {amount: 500000000},
externalOwnerCoverageUserId: 'user_12345',
externalOwnerCoverageTeamId: 'team_67890',
borderCrossings: [
{
type: 'BORDER_CROSSING',
externalId: '27924_1',
referenceNumbers: [{label: 'Shipment #', value: '1234234'}],
requiredInspections: [],
expectedDwellTimeMinutes: 12
}
],
assignedCarrier: {
carrier: {
dotNumber: '123456',
mcNumber: '248243',
mxNumber: '2343',
rfcNumber: 'RUSM2344227MY4',
cvorNumber: '2344227MY4',
nirNumber: 'R-23424',
nscNumber: '2344227MY4',
externalId: 'GJNTMIIN'
},
price: {
lineItems: [
{
value: {amount: 500000000},
externalId: '<string>',
externalCode: '<string>',
externalDescription: '<string>'
}
]
}
},
schemaVersionNumber: 0
}
})
};
fetch('https://api.cargado.com/loads/sync', 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.cargado.com/loads/sync",
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([
'load' => [
'externalId' => '456293',
'externalCustomerId' => 'ACMECORP',
'trailerRequirements' => [
'allowedTypes' => [
'DRY_VAN_53'
],
'maxAgeYears' => 123,
'highCube' => true,
'spaceSaver' => true,
'foodGrade' => true,
'logisticPost' => true,
'extendable' => true,
'liftGate' => true,
'minAxles' => 123,
'metalEdgeProtectors' => true,
'airChute' => true,
'ctpatCompliant' => true,
'floorTypes' => [
]
],
'carrierRequirements' => [
'ctpatCertified' => true,
'oeaCertified' => true,
'pipCertified' => true,
'fastCertified' => true,
'internationalCarrierBonded' => true,
'internationalCarrierBondedUS' => true,
'internationalCarrierBondedCA' => true,
'internationalCarrierBondedMX' => true,
'has247CustomerService' => true,
'minCargoInsurance' => [
'amount' => 500000000
]
],
'driverRequirements' => [
'twicCard' => true,
'tankerEndorsed' => true,
'cdl' => true
],
'stops' => [
[
'type' => 'PICKUP',
'externalId' => '27924_1',
'location' => [
'place' => [
'type' => 'ADDRESS',
'city' => 'Chicago',
'street' => '123 Main St',
'neighborhood' => 'Valle Oriente',
'state' => 'IL',
'postalCode' => '98335'
],
'isCtpatCertified' => true,
'isPipCertified' => true,
'isOeaCertified' => true,
'timezone' => 'America/Chicago'
],
'appointment' => [
'type' => 'UNSPECIFIED'
],
'referenceNumbers' => [
[
'label' => 'Shipment #',
'value' => '1234234'
]
],
'inboundTransitRequirements' => [
'maximumExpectedMinutes' => 123,
'teamDriverRequired' => true,
'trackingRequired' => true
],
'dropDurationHours' => 24,
'fumigation' => [
'requiredBefore' => true,
'requiredAfter' => true
],
'scaleTicket' => [
'requiredBefore' => true,
'requiredAfter' => true
],
'driverAssistRequired' => true
]
],
'externalDisplayId' => 'ORD-2024-001',
'externalWorkspaceId' => '<string>',
'referenceNumbers' => [
[
'label' => 'Shipment #',
'value' => '1234234'
]
],
'commodities' => [
[
'name' => 'Crude Oil',
'hazmatDetails' => [
'isHazmat' => true,
'classification' => 'CLASS_3_FLAMMABLE_LIQUIDS',
'unNumber' => '1263',
'packingGroup' => 'II'
],
'dimensions' => [
'length' => [
'value' => 576,
'unit' => 'INCHES'
],
'width' => [
'value' => 120,
'unit' => 'INCHES'
],
'height' => [
'value' => 72,
'unit' => 'INCHES'
]
],
'weight' => [
'type' => 'APPROXIMATE',
'value' => 123
],
'temperatureRequirements' => [
'minimum' => 10,
'maximum' => 20,
'unit' => 'CELSIUS'
],
'pieces' => [
'type' => 'PALLET',
'stackable' => true,
'perPieceVolume' => [
'value' => 100,
'unit' => 'GALLONS'
],
'perPieceDimensions' => [
'length' => [
'value' => 576,
'unit' => 'INCHES'
],
'width' => [
'value' => 120,
'unit' => 'INCHES'
],
'height' => [
'value' => 72,
'unit' => 'INCHES'
]
],
'count' => 10
]
]
],
'requiredEquipment' => [
[
'quantity' => 500.5
]
],
'metadata' => [
'tmsOrderId' => '1314234',
'customerName' => 'Acme Corp',
'weight' => 4200,
'expedited' => true
],
'roundTrip' => true,
'linearFeet' => 123,
'maxBuy' => [
'amount' => 500000000
],
'targetRate' => [
'amount' => 500000000
],
'externalOwnerCoverageUserId' => 'user_12345',
'externalOwnerCoverageTeamId' => 'team_67890',
'borderCrossings' => [
[
'type' => 'BORDER_CROSSING',
'externalId' => '27924_1',
'referenceNumbers' => [
[
'label' => 'Shipment #',
'value' => '1234234'
]
],
'requiredInspections' => [
],
'expectedDwellTimeMinutes' => 12
]
],
'assignedCarrier' => [
'carrier' => [
'dotNumber' => '123456',
'mcNumber' => '248243',
'mxNumber' => '2343',
'rfcNumber' => 'RUSM2344227MY4',
'cvorNumber' => '2344227MY4',
'nirNumber' => 'R-23424',
'nscNumber' => '2344227MY4',
'externalId' => 'GJNTMIIN'
],
'price' => [
'lineItems' => [
[
'value' => [
'amount' => 500000000
],
'externalId' => '<string>',
'externalCode' => '<string>',
'externalDescription' => '<string>'
]
]
]
],
'schemaVersionNumber' => 0
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$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.cargado.com/loads/sync"
payload := strings.NewReader("{\n \"load\": {\n \"externalId\": \"456293\",\n \"externalCustomerId\": \"ACMECORP\",\n \"trailerRequirements\": {\n \"allowedTypes\": [\n \"DRY_VAN_53\"\n ],\n \"maxAgeYears\": 123,\n \"highCube\": true,\n \"spaceSaver\": true,\n \"foodGrade\": true,\n \"logisticPost\": true,\n \"extendable\": true,\n \"liftGate\": true,\n \"minAxles\": 123,\n \"metalEdgeProtectors\": true,\n \"airChute\": true,\n \"ctpatCompliant\": true,\n \"floorTypes\": []\n },\n \"carrierRequirements\": {\n \"ctpatCertified\": true,\n \"oeaCertified\": true,\n \"pipCertified\": true,\n \"fastCertified\": true,\n \"internationalCarrierBonded\": true,\n \"internationalCarrierBondedUS\": true,\n \"internationalCarrierBondedCA\": true,\n \"internationalCarrierBondedMX\": true,\n \"has247CustomerService\": true,\n \"minCargoInsurance\": {\n \"amount\": 500000000\n }\n },\n \"driverRequirements\": {\n \"twicCard\": true,\n \"tankerEndorsed\": true,\n \"cdl\": true\n },\n \"stops\": [\n {\n \"type\": \"PICKUP\",\n \"externalId\": \"27924_1\",\n \"location\": {\n \"place\": {\n \"type\": \"ADDRESS\",\n \"city\": \"Chicago\",\n \"street\": \"123 Main St\",\n \"neighborhood\": \"Valle Oriente\",\n \"state\": \"IL\",\n \"postalCode\": \"98335\"\n },\n \"isCtpatCertified\": true,\n \"isPipCertified\": true,\n \"isOeaCertified\": true,\n \"timezone\": \"America/Chicago\"\n },\n \"appointment\": {\n \"type\": \"UNSPECIFIED\"\n },\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"inboundTransitRequirements\": {\n \"maximumExpectedMinutes\": 123,\n \"teamDriverRequired\": true,\n \"trackingRequired\": true\n },\n \"dropDurationHours\": 24,\n \"fumigation\": {\n \"requiredBefore\": true,\n \"requiredAfter\": true\n },\n \"scaleTicket\": {\n \"requiredBefore\": true,\n \"requiredAfter\": true\n },\n \"driverAssistRequired\": true\n }\n ],\n \"externalDisplayId\": \"ORD-2024-001\",\n \"externalWorkspaceId\": \"<string>\",\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"commodities\": [\n {\n \"name\": \"Crude Oil\",\n \"hazmatDetails\": {\n \"isHazmat\": true,\n \"classification\": \"CLASS_3_FLAMMABLE_LIQUIDS\",\n \"unNumber\": \"1263\",\n \"packingGroup\": \"II\"\n },\n \"dimensions\": {\n \"length\": {\n \"value\": 576,\n \"unit\": \"INCHES\"\n },\n \"width\": {\n \"value\": 120,\n \"unit\": \"INCHES\"\n },\n \"height\": {\n \"value\": 72,\n \"unit\": \"INCHES\"\n }\n },\n \"weight\": {\n \"type\": \"APPROXIMATE\",\n \"value\": 123\n },\n \"temperatureRequirements\": {\n \"minimum\": 10,\n \"maximum\": 20,\n \"unit\": \"CELSIUS\"\n },\n \"pieces\": {\n \"type\": \"PALLET\",\n \"stackable\": true,\n \"perPieceVolume\": {\n \"value\": 100,\n \"unit\": \"GALLONS\"\n },\n \"perPieceDimensions\": {\n \"length\": {\n \"value\": 576,\n \"unit\": \"INCHES\"\n },\n \"width\": {\n \"value\": 120,\n \"unit\": \"INCHES\"\n },\n \"height\": {\n \"value\": 72,\n \"unit\": \"INCHES\"\n }\n },\n \"count\": 10\n }\n }\n ],\n \"requiredEquipment\": [\n {\n \"quantity\": 500.5\n }\n ],\n \"metadata\": {\n \"tmsOrderId\": \"1314234\",\n \"customerName\": \"Acme Corp\",\n \"weight\": 4200,\n \"expedited\": true\n },\n \"roundTrip\": true,\n \"linearFeet\": 123,\n \"maxBuy\": {\n \"amount\": 500000000\n },\n \"targetRate\": {\n \"amount\": 500000000\n },\n \"externalOwnerCoverageUserId\": \"user_12345\",\n \"externalOwnerCoverageTeamId\": \"team_67890\",\n \"borderCrossings\": [\n {\n \"type\": \"BORDER_CROSSING\",\n \"externalId\": \"27924_1\",\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"requiredInspections\": [],\n \"expectedDwellTimeMinutes\": 12\n }\n ],\n \"assignedCarrier\": {\n \"carrier\": {\n \"dotNumber\": \"123456\",\n \"mcNumber\": \"248243\",\n \"mxNumber\": \"2343\",\n \"rfcNumber\": \"RUSM2344227MY4\",\n \"cvorNumber\": \"2344227MY4\",\n \"nirNumber\": \"R-23424\",\n \"nscNumber\": \"2344227MY4\",\n \"externalId\": \"GJNTMIIN\"\n },\n \"price\": {\n \"lineItems\": [\n {\n \"value\": {\n \"amount\": 500000000\n },\n \"externalId\": \"<string>\",\n \"externalCode\": \"<string>\",\n \"externalDescription\": \"<string>\"\n }\n ]\n }\n },\n \"schemaVersionNumber\": 0\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
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.cargado.com/loads/sync")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"load\": {\n \"externalId\": \"456293\",\n \"externalCustomerId\": \"ACMECORP\",\n \"trailerRequirements\": {\n \"allowedTypes\": [\n \"DRY_VAN_53\"\n ],\n \"maxAgeYears\": 123,\n \"highCube\": true,\n \"spaceSaver\": true,\n \"foodGrade\": true,\n \"logisticPost\": true,\n \"extendable\": true,\n \"liftGate\": true,\n \"minAxles\": 123,\n \"metalEdgeProtectors\": true,\n \"airChute\": true,\n \"ctpatCompliant\": true,\n \"floorTypes\": []\n },\n \"carrierRequirements\": {\n \"ctpatCertified\": true,\n \"oeaCertified\": true,\n \"pipCertified\": true,\n \"fastCertified\": true,\n \"internationalCarrierBonded\": true,\n \"internationalCarrierBondedUS\": true,\n \"internationalCarrierBondedCA\": true,\n \"internationalCarrierBondedMX\": true,\n \"has247CustomerService\": true,\n \"minCargoInsurance\": {\n \"amount\": 500000000\n }\n },\n \"driverRequirements\": {\n \"twicCard\": true,\n \"tankerEndorsed\": true,\n \"cdl\": true\n },\n \"stops\": [\n {\n \"type\": \"PICKUP\",\n \"externalId\": \"27924_1\",\n \"location\": {\n \"place\": {\n \"type\": \"ADDRESS\",\n \"city\": \"Chicago\",\n \"street\": \"123 Main St\",\n \"neighborhood\": \"Valle Oriente\",\n \"state\": \"IL\",\n \"postalCode\": \"98335\"\n },\n \"isCtpatCertified\": true,\n \"isPipCertified\": true,\n \"isOeaCertified\": true,\n \"timezone\": \"America/Chicago\"\n },\n \"appointment\": {\n \"type\": \"UNSPECIFIED\"\n },\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"inboundTransitRequirements\": {\n \"maximumExpectedMinutes\": 123,\n \"teamDriverRequired\": true,\n \"trackingRequired\": true\n },\n \"dropDurationHours\": 24,\n \"fumigation\": {\n \"requiredBefore\": true,\n \"requiredAfter\": true\n },\n \"scaleTicket\": {\n \"requiredBefore\": true,\n \"requiredAfter\": true\n },\n \"driverAssistRequired\": true\n }\n ],\n \"externalDisplayId\": \"ORD-2024-001\",\n \"externalWorkspaceId\": \"<string>\",\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"commodities\": [\n {\n \"name\": \"Crude Oil\",\n \"hazmatDetails\": {\n \"isHazmat\": true,\n \"classification\": \"CLASS_3_FLAMMABLE_LIQUIDS\",\n \"unNumber\": \"1263\",\n \"packingGroup\": \"II\"\n },\n \"dimensions\": {\n \"length\": {\n \"value\": 576,\n \"unit\": \"INCHES\"\n },\n \"width\": {\n \"value\": 120,\n \"unit\": \"INCHES\"\n },\n \"height\": {\n \"value\": 72,\n \"unit\": \"INCHES\"\n }\n },\n \"weight\": {\n \"type\": \"APPROXIMATE\",\n \"value\": 123\n },\n \"temperatureRequirements\": {\n \"minimum\": 10,\n \"maximum\": 20,\n \"unit\": \"CELSIUS\"\n },\n \"pieces\": {\n \"type\": \"PALLET\",\n \"stackable\": true,\n \"perPieceVolume\": {\n \"value\": 100,\n \"unit\": \"GALLONS\"\n },\n \"perPieceDimensions\": {\n \"length\": {\n \"value\": 576,\n \"unit\": \"INCHES\"\n },\n \"width\": {\n \"value\": 120,\n \"unit\": \"INCHES\"\n },\n \"height\": {\n \"value\": 72,\n \"unit\": \"INCHES\"\n }\n },\n \"count\": 10\n }\n }\n ],\n \"requiredEquipment\": [\n {\n \"quantity\": 500.5\n }\n ],\n \"metadata\": {\n \"tmsOrderId\": \"1314234\",\n \"customerName\": \"Acme Corp\",\n \"weight\": 4200,\n \"expedited\": true\n },\n \"roundTrip\": true,\n \"linearFeet\": 123,\n \"maxBuy\": {\n \"amount\": 500000000\n },\n \"targetRate\": {\n \"amount\": 500000000\n },\n \"externalOwnerCoverageUserId\": \"user_12345\",\n \"externalOwnerCoverageTeamId\": \"team_67890\",\n \"borderCrossings\": [\n {\n \"type\": \"BORDER_CROSSING\",\n \"externalId\": \"27924_1\",\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"requiredInspections\": [],\n \"expectedDwellTimeMinutes\": 12\n }\n ],\n \"assignedCarrier\": {\n \"carrier\": {\n \"dotNumber\": \"123456\",\n \"mcNumber\": \"248243\",\n \"mxNumber\": \"2343\",\n \"rfcNumber\": \"RUSM2344227MY4\",\n \"cvorNumber\": \"2344227MY4\",\n \"nirNumber\": \"R-23424\",\n \"nscNumber\": \"2344227MY4\",\n \"externalId\": \"GJNTMIIN\"\n },\n \"price\": {\n \"lineItems\": [\n {\n \"value\": {\n \"amount\": 500000000\n },\n \"externalId\": \"<string>\",\n \"externalCode\": \"<string>\",\n \"externalDescription\": \"<string>\"\n }\n ]\n }\n },\n \"schemaVersionNumber\": 0\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cargado.com/loads/sync")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"load\": {\n \"externalId\": \"456293\",\n \"externalCustomerId\": \"ACMECORP\",\n \"trailerRequirements\": {\n \"allowedTypes\": [\n \"DRY_VAN_53\"\n ],\n \"maxAgeYears\": 123,\n \"highCube\": true,\n \"spaceSaver\": true,\n \"foodGrade\": true,\n \"logisticPost\": true,\n \"extendable\": true,\n \"liftGate\": true,\n \"minAxles\": 123,\n \"metalEdgeProtectors\": true,\n \"airChute\": true,\n \"ctpatCompliant\": true,\n \"floorTypes\": []\n },\n \"carrierRequirements\": {\n \"ctpatCertified\": true,\n \"oeaCertified\": true,\n \"pipCertified\": true,\n \"fastCertified\": true,\n \"internationalCarrierBonded\": true,\n \"internationalCarrierBondedUS\": true,\n \"internationalCarrierBondedCA\": true,\n \"internationalCarrierBondedMX\": true,\n \"has247CustomerService\": true,\n \"minCargoInsurance\": {\n \"amount\": 500000000\n }\n },\n \"driverRequirements\": {\n \"twicCard\": true,\n \"tankerEndorsed\": true,\n \"cdl\": true\n },\n \"stops\": [\n {\n \"type\": \"PICKUP\",\n \"externalId\": \"27924_1\",\n \"location\": {\n \"place\": {\n \"type\": \"ADDRESS\",\n \"city\": \"Chicago\",\n \"street\": \"123 Main St\",\n \"neighborhood\": \"Valle Oriente\",\n \"state\": \"IL\",\n \"postalCode\": \"98335\"\n },\n \"isCtpatCertified\": true,\n \"isPipCertified\": true,\n \"isOeaCertified\": true,\n \"timezone\": \"America/Chicago\"\n },\n \"appointment\": {\n \"type\": \"UNSPECIFIED\"\n },\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"inboundTransitRequirements\": {\n \"maximumExpectedMinutes\": 123,\n \"teamDriverRequired\": true,\n \"trackingRequired\": true\n },\n \"dropDurationHours\": 24,\n \"fumigation\": {\n \"requiredBefore\": true,\n \"requiredAfter\": true\n },\n \"scaleTicket\": {\n \"requiredBefore\": true,\n \"requiredAfter\": true\n },\n \"driverAssistRequired\": true\n }\n ],\n \"externalDisplayId\": \"ORD-2024-001\",\n \"externalWorkspaceId\": \"<string>\",\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"commodities\": [\n {\n \"name\": \"Crude Oil\",\n \"hazmatDetails\": {\n \"isHazmat\": true,\n \"classification\": \"CLASS_3_FLAMMABLE_LIQUIDS\",\n \"unNumber\": \"1263\",\n \"packingGroup\": \"II\"\n },\n \"dimensions\": {\n \"length\": {\n \"value\": 576,\n \"unit\": \"INCHES\"\n },\n \"width\": {\n \"value\": 120,\n \"unit\": \"INCHES\"\n },\n \"height\": {\n \"value\": 72,\n \"unit\": \"INCHES\"\n }\n },\n \"weight\": {\n \"type\": \"APPROXIMATE\",\n \"value\": 123\n },\n \"temperatureRequirements\": {\n \"minimum\": 10,\n \"maximum\": 20,\n \"unit\": \"CELSIUS\"\n },\n \"pieces\": {\n \"type\": \"PALLET\",\n \"stackable\": true,\n \"perPieceVolume\": {\n \"value\": 100,\n \"unit\": \"GALLONS\"\n },\n \"perPieceDimensions\": {\n \"length\": {\n \"value\": 576,\n \"unit\": \"INCHES\"\n },\n \"width\": {\n \"value\": 120,\n \"unit\": \"INCHES\"\n },\n \"height\": {\n \"value\": 72,\n \"unit\": \"INCHES\"\n }\n },\n \"count\": 10\n }\n }\n ],\n \"requiredEquipment\": [\n {\n \"quantity\": 500.5\n }\n ],\n \"metadata\": {\n \"tmsOrderId\": \"1314234\",\n \"customerName\": \"Acme Corp\",\n \"weight\": 4200,\n \"expedited\": true\n },\n \"roundTrip\": true,\n \"linearFeet\": 123,\n \"maxBuy\": {\n \"amount\": 500000000\n },\n \"targetRate\": {\n \"amount\": 500000000\n },\n \"externalOwnerCoverageUserId\": \"user_12345\",\n \"externalOwnerCoverageTeamId\": \"team_67890\",\n \"borderCrossings\": [\n {\n \"type\": \"BORDER_CROSSING\",\n \"externalId\": \"27924_1\",\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"requiredInspections\": [],\n \"expectedDwellTimeMinutes\": 12\n }\n ],\n \"assignedCarrier\": {\n \"carrier\": {\n \"dotNumber\": \"123456\",\n \"mcNumber\": \"248243\",\n \"mxNumber\": \"2343\",\n \"rfcNumber\": \"RUSM2344227MY4\",\n \"cvorNumber\": \"2344227MY4\",\n \"nirNumber\": \"R-23424\",\n \"nscNumber\": \"2344227MY4\",\n \"externalId\": \"GJNTMIIN\"\n },\n \"price\": {\n \"lineItems\": [\n {\n \"value\": {\n \"amount\": 500000000\n },\n \"externalId\": \"<string>\",\n \"externalCode\": \"<string>\",\n \"externalDescription\": \"<string>\"\n }\n ]\n }\n },\n \"schemaVersionNumber\": 0\n }\n}"
response = http.request(request)
puts response.read_body{
"load": {
"externalId": "456293",
"externalCustomerId": "ACMECORP",
"status": "ON_HOLD",
"trailerRequirements": {
"allowedTypes": [
"DRY_VAN_53"
],
"powerOnlyType": "PRE_LOADED",
"doorType": "SWING",
"maxAgeYears": 123,
"highCube": true,
"spaceSaver": true,
"suspensionType": "AIR_RIDE",
"foodGrade": true,
"wallType": "SHEET_AND_POST",
"logisticPost": true,
"eTrackRails": "VERTICAL",
"eTracksDistance": "TWO_FEET",
"extendable": true,
"liftGate": true,
"minAxles": 123,
"metalEdgeProtectors": true,
"airChute": true,
"ctpatCompliant": true,
"floorTypes": [
"HARDWOOD"
]
},
"carrierRequirements": {
"ctpatCertified": true,
"oeaCertified": true,
"pipCertified": true,
"fastCertified": true,
"internationalCarrierBonded": true,
"internationalCarrierBondedUS": true,
"internationalCarrierBondedCA": true,
"internationalCarrierBondedMX": true,
"has247CustomerService": true,
"minCargoInsurance": {
"currencyCode": "USD",
"amount": 500000000
}
},
"driverRequirements": {
"twicCard": true,
"tankerEndorsed": true,
"cdl": true
},
"id": "load_c6ee2dff-f35f-4880-b7a6-9b2a1fa1476e",
"stops": [
{
"type": "PICKUP",
"externalId": "27924_1",
"location": {
"place": {
"type": "ADDRESS",
"street": "123 Main St",
"city": "Chicago",
"state": "IL",
"countryCode": "US",
"postalCode": "98335",
"neighborhood": "Valle Oriente"
},
"coordinates": {
"latitude": 49.280455,
"longitude": -123.118842
},
"isCtpatCertified": true,
"isPipCertified": true,
"isOeaCertified": true,
"carrierPreapproval": "FIXED_LIST",
"timezone": "America/Chicago"
},
"appointment": {
"type": "UNSPECIFIED"
},
"referenceNumbers": [
{
"label": "Shipment #",
"value": "1234234"
}
],
"loadingMethod": "LIVE",
"inboundTransitRequirements": {
"maximumExpectedMinutes": 123,
"securityEscortProvider": "PROVIDER",
"teamDriverRequired": true,
"trackingRequired": true
},
"dropDurationHours": 24,
"fumigation": {
"requiredBefore": true,
"requiredAfter": true
},
"scaleTicket": {
"requiredBefore": true,
"requiredAfter": true
},
"driverAssistRequired": true
}
],
"externalDisplayId": "ORD-2024-001",
"externalWorkspaceId": "<string>",
"referenceNumbers": [
{
"label": "Shipment #",
"value": "1234234"
}
],
"commodities": [
{
"hazmatDetails": {
"isHazmat": true,
"classification": "CLASS_3_FLAMMABLE_LIQUIDS",
"unNumber": "1263",
"packingGroup": "II"
},
"name": "Crude Oil",
"dimensions": {
"length": {
"value": 576,
"unit": "INCHES"
},
"width": {
"value": 120,
"unit": "INCHES"
},
"height": {
"value": 72,
"unit": "INCHES"
}
},
"weight": {
"type": "APPROXIMATE",
"value": 123,
"unit": "POUNDS"
},
"temperatureRequirements": {
"minimum": 10,
"maximum": 20,
"unit": "CELSIUS"
},
"pieces": {
"type": "PALLET",
"stackable": true,
"perPieceVolume": {
"value": 100,
"unit": "GALLONS"
},
"perPieceDimensions": {
"length": {
"value": 576,
"unit": "INCHES"
},
"width": {
"value": 120,
"unit": "INCHES"
},
"height": {
"value": 72,
"unit": "INCHES"
}
},
"count": 10
}
}
],
"requiredEquipment": [
{
"type": "LOAD_BARS",
"quantity": 500.5
}
],
"metadata": {
"tmsOrderId": "1314234",
"customerName": "Acme Corp",
"weight": 4200,
"expedited": true
},
"truckload": "FULL",
"roundTrip": true,
"linearFeet": 123,
"maxBuy": {
"currencyCode": "USD",
"amount": 500000000
},
"targetRate": {
"currencyCode": "USD",
"amount": 500000000
},
"externalOwnerCoverageUserId": "user_12345",
"externalOwnerCoverageTeamId": "team_67890",
"assignedCarrier": {
"carrier": {
"id": "<string>",
"displayName": "<string>",
"dotNumber": "<string>",
"mcNumber": "<string>",
"mxNumber": "<string>",
"rfcNumber": "<string>",
"cvorNumber": "<string>",
"nirNumber": "<string>",
"nscNumber": "<string>",
"scac": "<string>",
"contactName": "<string>",
"contactPhone": "<string>",
"contactEmail": "<string>",
"externalId": "<string>"
},
"price": {
"lineItems": [
{
"type": "<string>",
"value": {
"currencyCode": "USD",
"amount": 500000000
},
"externalId": "<string>",
"externalCode": "<string>",
"externalDescription": "<string>"
}
]
}
}
}
}{
"message": "Unauthorized"
}Loads
Sync a load
Sync a load from your TMS to Cargado, creating or updating any load details and status.
POST
/
loads
/
sync
Sync a load
curl --request POST \
--url https://api.cargado.com/loads/sync \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"load": {
"externalId": "456293",
"externalCustomerId": "ACMECORP",
"trailerRequirements": {
"allowedTypes": [
"DRY_VAN_53"
],
"maxAgeYears": 123,
"highCube": true,
"spaceSaver": true,
"foodGrade": true,
"logisticPost": true,
"extendable": true,
"liftGate": true,
"minAxles": 123,
"metalEdgeProtectors": true,
"airChute": true,
"ctpatCompliant": true,
"floorTypes": []
},
"carrierRequirements": {
"ctpatCertified": true,
"oeaCertified": true,
"pipCertified": true,
"fastCertified": true,
"internationalCarrierBonded": true,
"internationalCarrierBondedUS": true,
"internationalCarrierBondedCA": true,
"internationalCarrierBondedMX": true,
"has247CustomerService": true,
"minCargoInsurance": {
"amount": 500000000
}
},
"driverRequirements": {
"twicCard": true,
"tankerEndorsed": true,
"cdl": true
},
"stops": [
{
"type": "PICKUP",
"externalId": "27924_1",
"location": {
"place": {
"type": "ADDRESS",
"city": "Chicago",
"street": "123 Main St",
"neighborhood": "Valle Oriente",
"state": "IL",
"postalCode": "98335"
},
"isCtpatCertified": true,
"isPipCertified": true,
"isOeaCertified": true,
"timezone": "America/Chicago"
},
"appointment": {
"type": "UNSPECIFIED"
},
"referenceNumbers": [
{
"label": "Shipment #",
"value": "1234234"
}
],
"inboundTransitRequirements": {
"maximumExpectedMinutes": 123,
"teamDriverRequired": true,
"trackingRequired": true
},
"dropDurationHours": 24,
"fumigation": {
"requiredBefore": true,
"requiredAfter": true
},
"scaleTicket": {
"requiredBefore": true,
"requiredAfter": true
},
"driverAssistRequired": true
}
],
"externalDisplayId": "ORD-2024-001",
"externalWorkspaceId": "<string>",
"referenceNumbers": [
{
"label": "Shipment #",
"value": "1234234"
}
],
"commodities": [
{
"name": "Crude Oil",
"hazmatDetails": {
"isHazmat": true,
"classification": "CLASS_3_FLAMMABLE_LIQUIDS",
"unNumber": "1263",
"packingGroup": "II"
},
"dimensions": {
"length": {
"value": 576,
"unit": "INCHES"
},
"width": {
"value": 120,
"unit": "INCHES"
},
"height": {
"value": 72,
"unit": "INCHES"
}
},
"weight": {
"type": "APPROXIMATE",
"value": 123
},
"temperatureRequirements": {
"minimum": 10,
"maximum": 20,
"unit": "CELSIUS"
},
"pieces": {
"type": "PALLET",
"stackable": true,
"perPieceVolume": {
"value": 100,
"unit": "GALLONS"
},
"perPieceDimensions": {
"length": {
"value": 576,
"unit": "INCHES"
},
"width": {
"value": 120,
"unit": "INCHES"
},
"height": {
"value": 72,
"unit": "INCHES"
}
},
"count": 10
}
}
],
"requiredEquipment": [
{
"quantity": 500.5
}
],
"metadata": {
"tmsOrderId": "1314234",
"customerName": "Acme Corp",
"weight": 4200,
"expedited": true
},
"roundTrip": true,
"linearFeet": 123,
"maxBuy": {
"amount": 500000000
},
"targetRate": {
"amount": 500000000
},
"externalOwnerCoverageUserId": "user_12345",
"externalOwnerCoverageTeamId": "team_67890",
"borderCrossings": [
{
"type": "BORDER_CROSSING",
"externalId": "27924_1",
"referenceNumbers": [
{
"label": "Shipment #",
"value": "1234234"
}
],
"requiredInspections": [],
"expectedDwellTimeMinutes": 12
}
],
"assignedCarrier": {
"carrier": {
"dotNumber": "123456",
"mcNumber": "248243",
"mxNumber": "2343",
"rfcNumber": "RUSM2344227MY4",
"cvorNumber": "2344227MY4",
"nirNumber": "R-23424",
"nscNumber": "2344227MY4",
"externalId": "GJNTMIIN"
},
"price": {
"lineItems": [
{
"value": {
"amount": 500000000
},
"externalId": "<string>",
"externalCode": "<string>",
"externalDescription": "<string>"
}
]
}
},
"schemaVersionNumber": 0
}
}
'import requests
url = "https://api.cargado.com/loads/sync"
payload = { "load": {
"externalId": "456293",
"externalCustomerId": "ACMECORP",
"trailerRequirements": {
"allowedTypes": ["DRY_VAN_53"],
"maxAgeYears": 123,
"highCube": True,
"spaceSaver": True,
"foodGrade": True,
"logisticPost": True,
"extendable": True,
"liftGate": True,
"minAxles": 123,
"metalEdgeProtectors": True,
"airChute": True,
"ctpatCompliant": True,
"floorTypes": []
},
"carrierRequirements": {
"ctpatCertified": True,
"oeaCertified": True,
"pipCertified": True,
"fastCertified": True,
"internationalCarrierBonded": True,
"internationalCarrierBondedUS": True,
"internationalCarrierBondedCA": True,
"internationalCarrierBondedMX": True,
"has247CustomerService": True,
"minCargoInsurance": { "amount": 500000000 }
},
"driverRequirements": {
"twicCard": True,
"tankerEndorsed": True,
"cdl": True
},
"stops": [
{
"type": "PICKUP",
"externalId": "27924_1",
"location": {
"place": {
"type": "ADDRESS",
"city": "Chicago",
"street": "123 Main St",
"neighborhood": "Valle Oriente",
"state": "IL",
"postalCode": "98335"
},
"isCtpatCertified": True,
"isPipCertified": True,
"isOeaCertified": True,
"timezone": "America/Chicago"
},
"appointment": { "type": "UNSPECIFIED" },
"referenceNumbers": [
{
"label": "Shipment #",
"value": "1234234"
}
],
"inboundTransitRequirements": {
"maximumExpectedMinutes": 123,
"teamDriverRequired": True,
"trackingRequired": True
},
"dropDurationHours": 24,
"fumigation": {
"requiredBefore": True,
"requiredAfter": True
},
"scaleTicket": {
"requiredBefore": True,
"requiredAfter": True
},
"driverAssistRequired": True
}
],
"externalDisplayId": "ORD-2024-001",
"externalWorkspaceId": "<string>",
"referenceNumbers": [
{
"label": "Shipment #",
"value": "1234234"
}
],
"commodities": [
{
"name": "Crude Oil",
"hazmatDetails": {
"isHazmat": True,
"classification": "CLASS_3_FLAMMABLE_LIQUIDS",
"unNumber": "1263",
"packingGroup": "II"
},
"dimensions": {
"length": {
"value": 576,
"unit": "INCHES"
},
"width": {
"value": 120,
"unit": "INCHES"
},
"height": {
"value": 72,
"unit": "INCHES"
}
},
"weight": {
"type": "APPROXIMATE",
"value": 123
},
"temperatureRequirements": {
"minimum": 10,
"maximum": 20,
"unit": "CELSIUS"
},
"pieces": {
"type": "PALLET",
"stackable": True,
"perPieceVolume": {
"value": 100,
"unit": "GALLONS"
},
"perPieceDimensions": {
"length": {
"value": 576,
"unit": "INCHES"
},
"width": {
"value": 120,
"unit": "INCHES"
},
"height": {
"value": 72,
"unit": "INCHES"
}
},
"count": 10
}
}
],
"requiredEquipment": [{ "quantity": 500.5 }],
"metadata": {
"tmsOrderId": "1314234",
"customerName": "Acme Corp",
"weight": 4200,
"expedited": True
},
"roundTrip": True,
"linearFeet": 123,
"maxBuy": { "amount": 500000000 },
"targetRate": { "amount": 500000000 },
"externalOwnerCoverageUserId": "user_12345",
"externalOwnerCoverageTeamId": "team_67890",
"borderCrossings": [
{
"type": "BORDER_CROSSING",
"externalId": "27924_1",
"referenceNumbers": [
{
"label": "Shipment #",
"value": "1234234"
}
],
"requiredInspections": [],
"expectedDwellTimeMinutes": 12
}
],
"assignedCarrier": {
"carrier": {
"dotNumber": "123456",
"mcNumber": "248243",
"mxNumber": "2343",
"rfcNumber": "RUSM2344227MY4",
"cvorNumber": "2344227MY4",
"nirNumber": "R-23424",
"nscNumber": "2344227MY4",
"externalId": "GJNTMIIN"
},
"price": { "lineItems": [
{
"value": { "amount": 500000000 },
"externalId": "<string>",
"externalCode": "<string>",
"externalDescription": "<string>"
}
] }
},
"schemaVersionNumber": 0
} }
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
load: {
externalId: '456293',
externalCustomerId: 'ACMECORP',
trailerRequirements: {
allowedTypes: ['DRY_VAN_53'],
maxAgeYears: 123,
highCube: true,
spaceSaver: true,
foodGrade: true,
logisticPost: true,
extendable: true,
liftGate: true,
minAxles: 123,
metalEdgeProtectors: true,
airChute: true,
ctpatCompliant: true,
floorTypes: []
},
carrierRequirements: {
ctpatCertified: true,
oeaCertified: true,
pipCertified: true,
fastCertified: true,
internationalCarrierBonded: true,
internationalCarrierBondedUS: true,
internationalCarrierBondedCA: true,
internationalCarrierBondedMX: true,
has247CustomerService: true,
minCargoInsurance: {amount: 500000000}
},
driverRequirements: {twicCard: true, tankerEndorsed: true, cdl: true},
stops: [
{
type: 'PICKUP',
externalId: '27924_1',
location: {
place: {
type: 'ADDRESS',
city: 'Chicago',
street: '123 Main St',
neighborhood: 'Valle Oriente',
state: 'IL',
postalCode: '98335'
},
isCtpatCertified: true,
isPipCertified: true,
isOeaCertified: true,
timezone: 'America/Chicago'
},
appointment: {type: 'UNSPECIFIED'},
referenceNumbers: [{label: 'Shipment #', value: '1234234'}],
inboundTransitRequirements: {maximumExpectedMinutes: 123, teamDriverRequired: true, trackingRequired: true},
dropDurationHours: 24,
fumigation: {requiredBefore: true, requiredAfter: true},
scaleTicket: {requiredBefore: true, requiredAfter: true},
driverAssistRequired: true
}
],
externalDisplayId: 'ORD-2024-001',
externalWorkspaceId: '<string>',
referenceNumbers: [{label: 'Shipment #', value: '1234234'}],
commodities: [
{
name: 'Crude Oil',
hazmatDetails: {
isHazmat: true,
classification: 'CLASS_3_FLAMMABLE_LIQUIDS',
unNumber: '1263',
packingGroup: 'II'
},
dimensions: {
length: {value: 576, unit: 'INCHES'},
width: {value: 120, unit: 'INCHES'},
height: {value: 72, unit: 'INCHES'}
},
weight: {type: 'APPROXIMATE', value: 123},
temperatureRequirements: {minimum: 10, maximum: 20, unit: 'CELSIUS'},
pieces: {
type: 'PALLET',
stackable: true,
perPieceVolume: {value: 100, unit: 'GALLONS'},
perPieceDimensions: {
length: {value: 576, unit: 'INCHES'},
width: {value: 120, unit: 'INCHES'},
height: {value: 72, unit: 'INCHES'}
},
count: 10
}
}
],
requiredEquipment: [{quantity: 500.5}],
metadata: {
tmsOrderId: '1314234',
customerName: 'Acme Corp',
weight: 4200,
expedited: true
},
roundTrip: true,
linearFeet: 123,
maxBuy: {amount: 500000000},
targetRate: {amount: 500000000},
externalOwnerCoverageUserId: 'user_12345',
externalOwnerCoverageTeamId: 'team_67890',
borderCrossings: [
{
type: 'BORDER_CROSSING',
externalId: '27924_1',
referenceNumbers: [{label: 'Shipment #', value: '1234234'}],
requiredInspections: [],
expectedDwellTimeMinutes: 12
}
],
assignedCarrier: {
carrier: {
dotNumber: '123456',
mcNumber: '248243',
mxNumber: '2343',
rfcNumber: 'RUSM2344227MY4',
cvorNumber: '2344227MY4',
nirNumber: 'R-23424',
nscNumber: '2344227MY4',
externalId: 'GJNTMIIN'
},
price: {
lineItems: [
{
value: {amount: 500000000},
externalId: '<string>',
externalCode: '<string>',
externalDescription: '<string>'
}
]
}
},
schemaVersionNumber: 0
}
})
};
fetch('https://api.cargado.com/loads/sync', 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.cargado.com/loads/sync",
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([
'load' => [
'externalId' => '456293',
'externalCustomerId' => 'ACMECORP',
'trailerRequirements' => [
'allowedTypes' => [
'DRY_VAN_53'
],
'maxAgeYears' => 123,
'highCube' => true,
'spaceSaver' => true,
'foodGrade' => true,
'logisticPost' => true,
'extendable' => true,
'liftGate' => true,
'minAxles' => 123,
'metalEdgeProtectors' => true,
'airChute' => true,
'ctpatCompliant' => true,
'floorTypes' => [
]
],
'carrierRequirements' => [
'ctpatCertified' => true,
'oeaCertified' => true,
'pipCertified' => true,
'fastCertified' => true,
'internationalCarrierBonded' => true,
'internationalCarrierBondedUS' => true,
'internationalCarrierBondedCA' => true,
'internationalCarrierBondedMX' => true,
'has247CustomerService' => true,
'minCargoInsurance' => [
'amount' => 500000000
]
],
'driverRequirements' => [
'twicCard' => true,
'tankerEndorsed' => true,
'cdl' => true
],
'stops' => [
[
'type' => 'PICKUP',
'externalId' => '27924_1',
'location' => [
'place' => [
'type' => 'ADDRESS',
'city' => 'Chicago',
'street' => '123 Main St',
'neighborhood' => 'Valle Oriente',
'state' => 'IL',
'postalCode' => '98335'
],
'isCtpatCertified' => true,
'isPipCertified' => true,
'isOeaCertified' => true,
'timezone' => 'America/Chicago'
],
'appointment' => [
'type' => 'UNSPECIFIED'
],
'referenceNumbers' => [
[
'label' => 'Shipment #',
'value' => '1234234'
]
],
'inboundTransitRequirements' => [
'maximumExpectedMinutes' => 123,
'teamDriverRequired' => true,
'trackingRequired' => true
],
'dropDurationHours' => 24,
'fumigation' => [
'requiredBefore' => true,
'requiredAfter' => true
],
'scaleTicket' => [
'requiredBefore' => true,
'requiredAfter' => true
],
'driverAssistRequired' => true
]
],
'externalDisplayId' => 'ORD-2024-001',
'externalWorkspaceId' => '<string>',
'referenceNumbers' => [
[
'label' => 'Shipment #',
'value' => '1234234'
]
],
'commodities' => [
[
'name' => 'Crude Oil',
'hazmatDetails' => [
'isHazmat' => true,
'classification' => 'CLASS_3_FLAMMABLE_LIQUIDS',
'unNumber' => '1263',
'packingGroup' => 'II'
],
'dimensions' => [
'length' => [
'value' => 576,
'unit' => 'INCHES'
],
'width' => [
'value' => 120,
'unit' => 'INCHES'
],
'height' => [
'value' => 72,
'unit' => 'INCHES'
]
],
'weight' => [
'type' => 'APPROXIMATE',
'value' => 123
],
'temperatureRequirements' => [
'minimum' => 10,
'maximum' => 20,
'unit' => 'CELSIUS'
],
'pieces' => [
'type' => 'PALLET',
'stackable' => true,
'perPieceVolume' => [
'value' => 100,
'unit' => 'GALLONS'
],
'perPieceDimensions' => [
'length' => [
'value' => 576,
'unit' => 'INCHES'
],
'width' => [
'value' => 120,
'unit' => 'INCHES'
],
'height' => [
'value' => 72,
'unit' => 'INCHES'
]
],
'count' => 10
]
]
],
'requiredEquipment' => [
[
'quantity' => 500.5
]
],
'metadata' => [
'tmsOrderId' => '1314234',
'customerName' => 'Acme Corp',
'weight' => 4200,
'expedited' => true
],
'roundTrip' => true,
'linearFeet' => 123,
'maxBuy' => [
'amount' => 500000000
],
'targetRate' => [
'amount' => 500000000
],
'externalOwnerCoverageUserId' => 'user_12345',
'externalOwnerCoverageTeamId' => 'team_67890',
'borderCrossings' => [
[
'type' => 'BORDER_CROSSING',
'externalId' => '27924_1',
'referenceNumbers' => [
[
'label' => 'Shipment #',
'value' => '1234234'
]
],
'requiredInspections' => [
],
'expectedDwellTimeMinutes' => 12
]
],
'assignedCarrier' => [
'carrier' => [
'dotNumber' => '123456',
'mcNumber' => '248243',
'mxNumber' => '2343',
'rfcNumber' => 'RUSM2344227MY4',
'cvorNumber' => '2344227MY4',
'nirNumber' => 'R-23424',
'nscNumber' => '2344227MY4',
'externalId' => 'GJNTMIIN'
],
'price' => [
'lineItems' => [
[
'value' => [
'amount' => 500000000
],
'externalId' => '<string>',
'externalCode' => '<string>',
'externalDescription' => '<string>'
]
]
]
],
'schemaVersionNumber' => 0
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$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.cargado.com/loads/sync"
payload := strings.NewReader("{\n \"load\": {\n \"externalId\": \"456293\",\n \"externalCustomerId\": \"ACMECORP\",\n \"trailerRequirements\": {\n \"allowedTypes\": [\n \"DRY_VAN_53\"\n ],\n \"maxAgeYears\": 123,\n \"highCube\": true,\n \"spaceSaver\": true,\n \"foodGrade\": true,\n \"logisticPost\": true,\n \"extendable\": true,\n \"liftGate\": true,\n \"minAxles\": 123,\n \"metalEdgeProtectors\": true,\n \"airChute\": true,\n \"ctpatCompliant\": true,\n \"floorTypes\": []\n },\n \"carrierRequirements\": {\n \"ctpatCertified\": true,\n \"oeaCertified\": true,\n \"pipCertified\": true,\n \"fastCertified\": true,\n \"internationalCarrierBonded\": true,\n \"internationalCarrierBondedUS\": true,\n \"internationalCarrierBondedCA\": true,\n \"internationalCarrierBondedMX\": true,\n \"has247CustomerService\": true,\n \"minCargoInsurance\": {\n \"amount\": 500000000\n }\n },\n \"driverRequirements\": {\n \"twicCard\": true,\n \"tankerEndorsed\": true,\n \"cdl\": true\n },\n \"stops\": [\n {\n \"type\": \"PICKUP\",\n \"externalId\": \"27924_1\",\n \"location\": {\n \"place\": {\n \"type\": \"ADDRESS\",\n \"city\": \"Chicago\",\n \"street\": \"123 Main St\",\n \"neighborhood\": \"Valle Oriente\",\n \"state\": \"IL\",\n \"postalCode\": \"98335\"\n },\n \"isCtpatCertified\": true,\n \"isPipCertified\": true,\n \"isOeaCertified\": true,\n \"timezone\": \"America/Chicago\"\n },\n \"appointment\": {\n \"type\": \"UNSPECIFIED\"\n },\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"inboundTransitRequirements\": {\n \"maximumExpectedMinutes\": 123,\n \"teamDriverRequired\": true,\n \"trackingRequired\": true\n },\n \"dropDurationHours\": 24,\n \"fumigation\": {\n \"requiredBefore\": true,\n \"requiredAfter\": true\n },\n \"scaleTicket\": {\n \"requiredBefore\": true,\n \"requiredAfter\": true\n },\n \"driverAssistRequired\": true\n }\n ],\n \"externalDisplayId\": \"ORD-2024-001\",\n \"externalWorkspaceId\": \"<string>\",\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"commodities\": [\n {\n \"name\": \"Crude Oil\",\n \"hazmatDetails\": {\n \"isHazmat\": true,\n \"classification\": \"CLASS_3_FLAMMABLE_LIQUIDS\",\n \"unNumber\": \"1263\",\n \"packingGroup\": \"II\"\n },\n \"dimensions\": {\n \"length\": {\n \"value\": 576,\n \"unit\": \"INCHES\"\n },\n \"width\": {\n \"value\": 120,\n \"unit\": \"INCHES\"\n },\n \"height\": {\n \"value\": 72,\n \"unit\": \"INCHES\"\n }\n },\n \"weight\": {\n \"type\": \"APPROXIMATE\",\n \"value\": 123\n },\n \"temperatureRequirements\": {\n \"minimum\": 10,\n \"maximum\": 20,\n \"unit\": \"CELSIUS\"\n },\n \"pieces\": {\n \"type\": \"PALLET\",\n \"stackable\": true,\n \"perPieceVolume\": {\n \"value\": 100,\n \"unit\": \"GALLONS\"\n },\n \"perPieceDimensions\": {\n \"length\": {\n \"value\": 576,\n \"unit\": \"INCHES\"\n },\n \"width\": {\n \"value\": 120,\n \"unit\": \"INCHES\"\n },\n \"height\": {\n \"value\": 72,\n \"unit\": \"INCHES\"\n }\n },\n \"count\": 10\n }\n }\n ],\n \"requiredEquipment\": [\n {\n \"quantity\": 500.5\n }\n ],\n \"metadata\": {\n \"tmsOrderId\": \"1314234\",\n \"customerName\": \"Acme Corp\",\n \"weight\": 4200,\n \"expedited\": true\n },\n \"roundTrip\": true,\n \"linearFeet\": 123,\n \"maxBuy\": {\n \"amount\": 500000000\n },\n \"targetRate\": {\n \"amount\": 500000000\n },\n \"externalOwnerCoverageUserId\": \"user_12345\",\n \"externalOwnerCoverageTeamId\": \"team_67890\",\n \"borderCrossings\": [\n {\n \"type\": \"BORDER_CROSSING\",\n \"externalId\": \"27924_1\",\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"requiredInspections\": [],\n \"expectedDwellTimeMinutes\": 12\n }\n ],\n \"assignedCarrier\": {\n \"carrier\": {\n \"dotNumber\": \"123456\",\n \"mcNumber\": \"248243\",\n \"mxNumber\": \"2343\",\n \"rfcNumber\": \"RUSM2344227MY4\",\n \"cvorNumber\": \"2344227MY4\",\n \"nirNumber\": \"R-23424\",\n \"nscNumber\": \"2344227MY4\",\n \"externalId\": \"GJNTMIIN\"\n },\n \"price\": {\n \"lineItems\": [\n {\n \"value\": {\n \"amount\": 500000000\n },\n \"externalId\": \"<string>\",\n \"externalCode\": \"<string>\",\n \"externalDescription\": \"<string>\"\n }\n ]\n }\n },\n \"schemaVersionNumber\": 0\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
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.cargado.com/loads/sync")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"load\": {\n \"externalId\": \"456293\",\n \"externalCustomerId\": \"ACMECORP\",\n \"trailerRequirements\": {\n \"allowedTypes\": [\n \"DRY_VAN_53\"\n ],\n \"maxAgeYears\": 123,\n \"highCube\": true,\n \"spaceSaver\": true,\n \"foodGrade\": true,\n \"logisticPost\": true,\n \"extendable\": true,\n \"liftGate\": true,\n \"minAxles\": 123,\n \"metalEdgeProtectors\": true,\n \"airChute\": true,\n \"ctpatCompliant\": true,\n \"floorTypes\": []\n },\n \"carrierRequirements\": {\n \"ctpatCertified\": true,\n \"oeaCertified\": true,\n \"pipCertified\": true,\n \"fastCertified\": true,\n \"internationalCarrierBonded\": true,\n \"internationalCarrierBondedUS\": true,\n \"internationalCarrierBondedCA\": true,\n \"internationalCarrierBondedMX\": true,\n \"has247CustomerService\": true,\n \"minCargoInsurance\": {\n \"amount\": 500000000\n }\n },\n \"driverRequirements\": {\n \"twicCard\": true,\n \"tankerEndorsed\": true,\n \"cdl\": true\n },\n \"stops\": [\n {\n \"type\": \"PICKUP\",\n \"externalId\": \"27924_1\",\n \"location\": {\n \"place\": {\n \"type\": \"ADDRESS\",\n \"city\": \"Chicago\",\n \"street\": \"123 Main St\",\n \"neighborhood\": \"Valle Oriente\",\n \"state\": \"IL\",\n \"postalCode\": \"98335\"\n },\n \"isCtpatCertified\": true,\n \"isPipCertified\": true,\n \"isOeaCertified\": true,\n \"timezone\": \"America/Chicago\"\n },\n \"appointment\": {\n \"type\": \"UNSPECIFIED\"\n },\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"inboundTransitRequirements\": {\n \"maximumExpectedMinutes\": 123,\n \"teamDriverRequired\": true,\n \"trackingRequired\": true\n },\n \"dropDurationHours\": 24,\n \"fumigation\": {\n \"requiredBefore\": true,\n \"requiredAfter\": true\n },\n \"scaleTicket\": {\n \"requiredBefore\": true,\n \"requiredAfter\": true\n },\n \"driverAssistRequired\": true\n }\n ],\n \"externalDisplayId\": \"ORD-2024-001\",\n \"externalWorkspaceId\": \"<string>\",\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"commodities\": [\n {\n \"name\": \"Crude Oil\",\n \"hazmatDetails\": {\n \"isHazmat\": true,\n \"classification\": \"CLASS_3_FLAMMABLE_LIQUIDS\",\n \"unNumber\": \"1263\",\n \"packingGroup\": \"II\"\n },\n \"dimensions\": {\n \"length\": {\n \"value\": 576,\n \"unit\": \"INCHES\"\n },\n \"width\": {\n \"value\": 120,\n \"unit\": \"INCHES\"\n },\n \"height\": {\n \"value\": 72,\n \"unit\": \"INCHES\"\n }\n },\n \"weight\": {\n \"type\": \"APPROXIMATE\",\n \"value\": 123\n },\n \"temperatureRequirements\": {\n \"minimum\": 10,\n \"maximum\": 20,\n \"unit\": \"CELSIUS\"\n },\n \"pieces\": {\n \"type\": \"PALLET\",\n \"stackable\": true,\n \"perPieceVolume\": {\n \"value\": 100,\n \"unit\": \"GALLONS\"\n },\n \"perPieceDimensions\": {\n \"length\": {\n \"value\": 576,\n \"unit\": \"INCHES\"\n },\n \"width\": {\n \"value\": 120,\n \"unit\": \"INCHES\"\n },\n \"height\": {\n \"value\": 72,\n \"unit\": \"INCHES\"\n }\n },\n \"count\": 10\n }\n }\n ],\n \"requiredEquipment\": [\n {\n \"quantity\": 500.5\n }\n ],\n \"metadata\": {\n \"tmsOrderId\": \"1314234\",\n \"customerName\": \"Acme Corp\",\n \"weight\": 4200,\n \"expedited\": true\n },\n \"roundTrip\": true,\n \"linearFeet\": 123,\n \"maxBuy\": {\n \"amount\": 500000000\n },\n \"targetRate\": {\n \"amount\": 500000000\n },\n \"externalOwnerCoverageUserId\": \"user_12345\",\n \"externalOwnerCoverageTeamId\": \"team_67890\",\n \"borderCrossings\": [\n {\n \"type\": \"BORDER_CROSSING\",\n \"externalId\": \"27924_1\",\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"requiredInspections\": [],\n \"expectedDwellTimeMinutes\": 12\n }\n ],\n \"assignedCarrier\": {\n \"carrier\": {\n \"dotNumber\": \"123456\",\n \"mcNumber\": \"248243\",\n \"mxNumber\": \"2343\",\n \"rfcNumber\": \"RUSM2344227MY4\",\n \"cvorNumber\": \"2344227MY4\",\n \"nirNumber\": \"R-23424\",\n \"nscNumber\": \"2344227MY4\",\n \"externalId\": \"GJNTMIIN\"\n },\n \"price\": {\n \"lineItems\": [\n {\n \"value\": {\n \"amount\": 500000000\n },\n \"externalId\": \"<string>\",\n \"externalCode\": \"<string>\",\n \"externalDescription\": \"<string>\"\n }\n ]\n }\n },\n \"schemaVersionNumber\": 0\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cargado.com/loads/sync")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"load\": {\n \"externalId\": \"456293\",\n \"externalCustomerId\": \"ACMECORP\",\n \"trailerRequirements\": {\n \"allowedTypes\": [\n \"DRY_VAN_53\"\n ],\n \"maxAgeYears\": 123,\n \"highCube\": true,\n \"spaceSaver\": true,\n \"foodGrade\": true,\n \"logisticPost\": true,\n \"extendable\": true,\n \"liftGate\": true,\n \"minAxles\": 123,\n \"metalEdgeProtectors\": true,\n \"airChute\": true,\n \"ctpatCompliant\": true,\n \"floorTypes\": []\n },\n \"carrierRequirements\": {\n \"ctpatCertified\": true,\n \"oeaCertified\": true,\n \"pipCertified\": true,\n \"fastCertified\": true,\n \"internationalCarrierBonded\": true,\n \"internationalCarrierBondedUS\": true,\n \"internationalCarrierBondedCA\": true,\n \"internationalCarrierBondedMX\": true,\n \"has247CustomerService\": true,\n \"minCargoInsurance\": {\n \"amount\": 500000000\n }\n },\n \"driverRequirements\": {\n \"twicCard\": true,\n \"tankerEndorsed\": true,\n \"cdl\": true\n },\n \"stops\": [\n {\n \"type\": \"PICKUP\",\n \"externalId\": \"27924_1\",\n \"location\": {\n \"place\": {\n \"type\": \"ADDRESS\",\n \"city\": \"Chicago\",\n \"street\": \"123 Main St\",\n \"neighborhood\": \"Valle Oriente\",\n \"state\": \"IL\",\n \"postalCode\": \"98335\"\n },\n \"isCtpatCertified\": true,\n \"isPipCertified\": true,\n \"isOeaCertified\": true,\n \"timezone\": \"America/Chicago\"\n },\n \"appointment\": {\n \"type\": \"UNSPECIFIED\"\n },\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"inboundTransitRequirements\": {\n \"maximumExpectedMinutes\": 123,\n \"teamDriverRequired\": true,\n \"trackingRequired\": true\n },\n \"dropDurationHours\": 24,\n \"fumigation\": {\n \"requiredBefore\": true,\n \"requiredAfter\": true\n },\n \"scaleTicket\": {\n \"requiredBefore\": true,\n \"requiredAfter\": true\n },\n \"driverAssistRequired\": true\n }\n ],\n \"externalDisplayId\": \"ORD-2024-001\",\n \"externalWorkspaceId\": \"<string>\",\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"commodities\": [\n {\n \"name\": \"Crude Oil\",\n \"hazmatDetails\": {\n \"isHazmat\": true,\n \"classification\": \"CLASS_3_FLAMMABLE_LIQUIDS\",\n \"unNumber\": \"1263\",\n \"packingGroup\": \"II\"\n },\n \"dimensions\": {\n \"length\": {\n \"value\": 576,\n \"unit\": \"INCHES\"\n },\n \"width\": {\n \"value\": 120,\n \"unit\": \"INCHES\"\n },\n \"height\": {\n \"value\": 72,\n \"unit\": \"INCHES\"\n }\n },\n \"weight\": {\n \"type\": \"APPROXIMATE\",\n \"value\": 123\n },\n \"temperatureRequirements\": {\n \"minimum\": 10,\n \"maximum\": 20,\n \"unit\": \"CELSIUS\"\n },\n \"pieces\": {\n \"type\": \"PALLET\",\n \"stackable\": true,\n \"perPieceVolume\": {\n \"value\": 100,\n \"unit\": \"GALLONS\"\n },\n \"perPieceDimensions\": {\n \"length\": {\n \"value\": 576,\n \"unit\": \"INCHES\"\n },\n \"width\": {\n \"value\": 120,\n \"unit\": \"INCHES\"\n },\n \"height\": {\n \"value\": 72,\n \"unit\": \"INCHES\"\n }\n },\n \"count\": 10\n }\n }\n ],\n \"requiredEquipment\": [\n {\n \"quantity\": 500.5\n }\n ],\n \"metadata\": {\n \"tmsOrderId\": \"1314234\",\n \"customerName\": \"Acme Corp\",\n \"weight\": 4200,\n \"expedited\": true\n },\n \"roundTrip\": true,\n \"linearFeet\": 123,\n \"maxBuy\": {\n \"amount\": 500000000\n },\n \"targetRate\": {\n \"amount\": 500000000\n },\n \"externalOwnerCoverageUserId\": \"user_12345\",\n \"externalOwnerCoverageTeamId\": \"team_67890\",\n \"borderCrossings\": [\n {\n \"type\": \"BORDER_CROSSING\",\n \"externalId\": \"27924_1\",\n \"referenceNumbers\": [\n {\n \"label\": \"Shipment #\",\n \"value\": \"1234234\"\n }\n ],\n \"requiredInspections\": [],\n \"expectedDwellTimeMinutes\": 12\n }\n ],\n \"assignedCarrier\": {\n \"carrier\": {\n \"dotNumber\": \"123456\",\n \"mcNumber\": \"248243\",\n \"mxNumber\": \"2343\",\n \"rfcNumber\": \"RUSM2344227MY4\",\n \"cvorNumber\": \"2344227MY4\",\n \"nirNumber\": \"R-23424\",\n \"nscNumber\": \"2344227MY4\",\n \"externalId\": \"GJNTMIIN\"\n },\n \"price\": {\n \"lineItems\": [\n {\n \"value\": {\n \"amount\": 500000000\n },\n \"externalId\": \"<string>\",\n \"externalCode\": \"<string>\",\n \"externalDescription\": \"<string>\"\n }\n ]\n }\n },\n \"schemaVersionNumber\": 0\n }\n}"
response = http.request(request)
puts response.read_body{
"load": {
"externalId": "456293",
"externalCustomerId": "ACMECORP",
"status": "ON_HOLD",
"trailerRequirements": {
"allowedTypes": [
"DRY_VAN_53"
],
"powerOnlyType": "PRE_LOADED",
"doorType": "SWING",
"maxAgeYears": 123,
"highCube": true,
"spaceSaver": true,
"suspensionType": "AIR_RIDE",
"foodGrade": true,
"wallType": "SHEET_AND_POST",
"logisticPost": true,
"eTrackRails": "VERTICAL",
"eTracksDistance": "TWO_FEET",
"extendable": true,
"liftGate": true,
"minAxles": 123,
"metalEdgeProtectors": true,
"airChute": true,
"ctpatCompliant": true,
"floorTypes": [
"HARDWOOD"
]
},
"carrierRequirements": {
"ctpatCertified": true,
"oeaCertified": true,
"pipCertified": true,
"fastCertified": true,
"internationalCarrierBonded": true,
"internationalCarrierBondedUS": true,
"internationalCarrierBondedCA": true,
"internationalCarrierBondedMX": true,
"has247CustomerService": true,
"minCargoInsurance": {
"currencyCode": "USD",
"amount": 500000000
}
},
"driverRequirements": {
"twicCard": true,
"tankerEndorsed": true,
"cdl": true
},
"id": "load_c6ee2dff-f35f-4880-b7a6-9b2a1fa1476e",
"stops": [
{
"type": "PICKUP",
"externalId": "27924_1",
"location": {
"place": {
"type": "ADDRESS",
"street": "123 Main St",
"city": "Chicago",
"state": "IL",
"countryCode": "US",
"postalCode": "98335",
"neighborhood": "Valle Oriente"
},
"coordinates": {
"latitude": 49.280455,
"longitude": -123.118842
},
"isCtpatCertified": true,
"isPipCertified": true,
"isOeaCertified": true,
"carrierPreapproval": "FIXED_LIST",
"timezone": "America/Chicago"
},
"appointment": {
"type": "UNSPECIFIED"
},
"referenceNumbers": [
{
"label": "Shipment #",
"value": "1234234"
}
],
"loadingMethod": "LIVE",
"inboundTransitRequirements": {
"maximumExpectedMinutes": 123,
"securityEscortProvider": "PROVIDER",
"teamDriverRequired": true,
"trackingRequired": true
},
"dropDurationHours": 24,
"fumigation": {
"requiredBefore": true,
"requiredAfter": true
},
"scaleTicket": {
"requiredBefore": true,
"requiredAfter": true
},
"driverAssistRequired": true
}
],
"externalDisplayId": "ORD-2024-001",
"externalWorkspaceId": "<string>",
"referenceNumbers": [
{
"label": "Shipment #",
"value": "1234234"
}
],
"commodities": [
{
"hazmatDetails": {
"isHazmat": true,
"classification": "CLASS_3_FLAMMABLE_LIQUIDS",
"unNumber": "1263",
"packingGroup": "II"
},
"name": "Crude Oil",
"dimensions": {
"length": {
"value": 576,
"unit": "INCHES"
},
"width": {
"value": 120,
"unit": "INCHES"
},
"height": {
"value": 72,
"unit": "INCHES"
}
},
"weight": {
"type": "APPROXIMATE",
"value": 123,
"unit": "POUNDS"
},
"temperatureRequirements": {
"minimum": 10,
"maximum": 20,
"unit": "CELSIUS"
},
"pieces": {
"type": "PALLET",
"stackable": true,
"perPieceVolume": {
"value": 100,
"unit": "GALLONS"
},
"perPieceDimensions": {
"length": {
"value": 576,
"unit": "INCHES"
},
"width": {
"value": 120,
"unit": "INCHES"
},
"height": {
"value": 72,
"unit": "INCHES"
}
},
"count": 10
}
}
],
"requiredEquipment": [
{
"type": "LOAD_BARS",
"quantity": 500.5
}
],
"metadata": {
"tmsOrderId": "1314234",
"customerName": "Acme Corp",
"weight": 4200,
"expedited": true
},
"truckload": "FULL",
"roundTrip": true,
"linearFeet": 123,
"maxBuy": {
"currencyCode": "USD",
"amount": 500000000
},
"targetRate": {
"currencyCode": "USD",
"amount": 500000000
},
"externalOwnerCoverageUserId": "user_12345",
"externalOwnerCoverageTeamId": "team_67890",
"assignedCarrier": {
"carrier": {
"id": "<string>",
"displayName": "<string>",
"dotNumber": "<string>",
"mcNumber": "<string>",
"mxNumber": "<string>",
"rfcNumber": "<string>",
"cvorNumber": "<string>",
"nirNumber": "<string>",
"nscNumber": "<string>",
"scac": "<string>",
"contactName": "<string>",
"contactPhone": "<string>",
"contactEmail": "<string>",
"externalId": "<string>"
},
"price": {
"lineItems": [
{
"type": "<string>",
"value": {
"currencyCode": "USD",
"amount": 500000000
},
"externalId": "<string>",
"externalCode": "<string>",
"externalDescription": "<string>"
}
]
}
}
}
}{
"message": "Unauthorized"
}Authorizations
Body
application/json
Input interface for synchronizing load data.
Input interface for synchronizing load data.
Show child attributes
Show child attributes
Response
Ok
Output interface for synchronizing load data.
A load in the Cargado system.
Show child attributes
Show child attributes

