Skip to navigation
EndpointsOffers

Create an offer

Create a new offer for a load.

Authentication: Supports API key and bearer token authentication.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Organization-IDstring or nullOptional
Idempotency-KeystringOptional<=255 characters

A unique key (up to 255 printable ASCII characters, e.g. a UUID) that makes a retry of this request safe. Envoy stores the response for 24 hours; a retry with the same key and the same request returns it again with Idempotent-Replayed: true instead of running twice. The same key with a different request returns 422 idempotency_key_reused; while the first request is still running, 409 idempotency_key_in_progress. 5xx and 429 responses are not stored.

Request

This endpoint expects an object.
load_idstringRequiredformat: "uuid"

Load ID (prefixed or raw UUID)

offer_amountdoubleRequired

Amount offered (positive)

tms_load_idstring or nullOptional
External load identifier from TMS
carrier_idstring or nullOptionalformat: "uuid"

Carrier making the offer (prefixed or raw UUID)

statusenumOptionalDefaults to pending
Status of the offer
Allowed values:
notesstring or nullOptional
Notes or comments about the offer
sourcestringOptionalDefaults to internal
Source of the offer

Response

Successful Response
idstringformat: "^ofr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
tms_load_idstring
load_idstringformat: "^load_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
offer_amountdouble
statusenum
Allowed values:
sourcestring
created_atdatetime
updated_atdatetime
carrier_idstring or nullOptionalformat: "^car_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
contact_idstring or nullOptionalformat: "^con_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
call_idstring or nullOptionalformat: "^call_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
email_message_idstring or nullOptional
notesstring or nullOptional
channelenum or nullOptional

Which conversation produced the offer: voice (a call), email, or messaging (WhatsApp). Null when a rep or an API client entered it.

Allowed values:
accepted_atdatetime or nullOptional
When the load was booked on this offer
created_by_idstring or nullOptionalformat: "^usr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
updated_by_idstring or nullOptionalformat: "^usr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
truck_numberstring or nullOptional
trailer_numberstring or nullOptional
driver_namestring or nullOptional
driver_phonestring or nullOptional
load_numberstring or nullOptional
carrierobject or nullOptional

v1 carrier response - wraps domain CarrierModel with prefixed IDs.

contact_namestring or nullOptional
contact_phonestring or nullOptional
email_conversation_idstring or nullOptional
rep_namestring or nullOptional

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error