Skip to main content
POST
Update a bid

Authorizations

api-key
string
header
required

Body

application/json

Patch a Bid. Omitted fields are left unchanged; sending a field with null explicitly clears it; sending a value sets it.

bidId
string
required

The id of the Bid to update.

Required string length: 1 - 64
externalId
string | null

The id of the bid in the integration's TMS. Send a string to set, null to clear, or omit to leave unchanged.

Required string length: 1 - 255

Response

Ok

id
string
required

Cargado-issued identifier for this bid (prefix: bid_).

status
enum<string>
required

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).
Available options:
ACTIVE,
ACCEPTED,
REJECTED,
REVOKED,
COUNTERED,
COUNTER_ACCEPTED,
CLOSED
externalId
string | null
required

The unique id for this bid/offer object in your TMS. This identifier will not be displayed outside your organization. Examples: "456293", "TMS232423"

Required string length: 1 - 255
Example:

"456293"

rateDetails
object
required

Pricing details for this bid, broken out by line item.

loadsPerPeriod
number<double> | null
required

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.

Required range: x >= 0
createdAt
string<date-time>
required

The time the bid was created, as an ISO-8601 timestamp.

updatedAt
string<date-time>
required

The time the bid was last updated, as an ISO-8601 timestamp.

counterBid
object | null
required

The current active counter on this bid, if any. Null when no counter is in progress (or when the bid has never been countered).