curl --request POST \
--url https://api.cargado.com/bids/update \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"bidId": "<string>",
"externalId": "<string>"
}
'import requests
url = "https://api.cargado.com/bids/update"
payload = {
"bidId": "<string>",
"externalId": "<string>"
}
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({bidId: '<string>', externalId: '<string>'})
};
fetch('https://api.cargado.com/bids/update', 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/bids/update",
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([
'bidId' => '<string>',
'externalId' => '<string>'
]),
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/bids/update"
payload := strings.NewReader("{\n \"bidId\": \"<string>\",\n \"externalId\": \"<string>\"\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/bids/update")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"bidId\": \"<string>\",\n \"externalId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cargado.com/bids/update")
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 \"bidId\": \"<string>\",\n \"externalId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"externalId": "<string>",
"rateDetails": {
"type": "ItemizedBid",
"totalAmount": {
"amount": 500000000
},
"lineItems": [
{
"type": "AllIn",
"totalAmount": {
"amount": 500000000
}
}
]
},
"loadsPerPeriod": 1,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"counterBid": {
"id": "<string>",
"rateDetails": {
"type": "SimpleCounterBid",
"totalAmount": {
"amount": 500000000
}
},
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"message": "Unauthorized"
}{
"message": "Bid with ID bid_… not found"
}Update a bid
Patch a Bid. Omitted fields are left unchanged; sending null
explicitly clears the field. Currently only externalId is
patchable. Returns the updated bid.
curl --request POST \
--url https://api.cargado.com/bids/update \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"bidId": "<string>",
"externalId": "<string>"
}
'import requests
url = "https://api.cargado.com/bids/update"
payload = {
"bidId": "<string>",
"externalId": "<string>"
}
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({bidId: '<string>', externalId: '<string>'})
};
fetch('https://api.cargado.com/bids/update', 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/bids/update",
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([
'bidId' => '<string>',
'externalId' => '<string>'
]),
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/bids/update"
payload := strings.NewReader("{\n \"bidId\": \"<string>\",\n \"externalId\": \"<string>\"\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/bids/update")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"bidId\": \"<string>\",\n \"externalId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cargado.com/bids/update")
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 \"bidId\": \"<string>\",\n \"externalId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"externalId": "<string>",
"rateDetails": {
"type": "ItemizedBid",
"totalAmount": {
"amount": 500000000
},
"lineItems": [
{
"type": "AllIn",
"totalAmount": {
"amount": 500000000
}
}
]
},
"loadsPerPeriod": 1,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"counterBid": {
"id": "<string>",
"rateDetails": {
"type": "SimpleCounterBid",
"totalAmount": {
"amount": 500000000
}
},
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"message": "Unauthorized"
}{
"message": "Bid with ID bid_… not found"
}Authorizations
Body
Patch a Bid. Omitted fields are left unchanged; sending a field with
null explicitly clears it; sending a value sets it.
Response
Ok
Cargado-issued identifier for this bid (prefix: bid_).
The lifecycle status of a bid.
ACTIVE— the bid is live and awaiting a response from the broker.ACCEPTED— the bid has been accepted by the broker.REJECTED— the bid has been rejected by the broker.REVOKED— the carrier withdrew the bid before a response.COUNTERED— the broker has issued a counter on this bid.COUNTER_ACCEPTED— a counter on this bid was accepted; the bid is settled at the countered rate.CLOSED— the bid is no longer actionable (for example, the posting ended or another bid was accepted).
ACTIVE, ACCEPTED, REJECTED, REVOKED, COUNTERED, COUNTER_ACCEPTED, CLOSED The unique id for this bid/offer object in your TMS. This identifier will not be displayed outside your organization. Examples: "456293", "TMS232423"
1 - 255"456293"
Pricing details for this bid, broken out by line item.
Show child attributes
Show child attributes
The number of loads the carrier is able to cover at this rate during the lane period. Null for single-load bids; populated for lane bids.
x >= 0The time the bid was created, as an ISO-8601 timestamp.
The time the bid was last updated, as an ISO-8601 timestamp.
The current active counter on this bid, if any. Null when no counter is in progress (or when the bid has never been countered).
Show child attributes
Show child attributes

