v1

latestOpenAPI 3.0.12026-08-04671711.0 MB

Loads

Create tender

Tender a load to Loadsmart. The load could be either a spot or contracted one. If the endpoint returns a successful status code, it means that we have received the load.

In order to see if the load was accepted or rejected, you must listen for the load:accepted and load:rejected webhooks, respectively. See Load Webhooks section.

Important: the uuid returned identifies a load uniquely in Loadsmart systems. This means that, for two or more responses, if they contain the same uuid, they are related to the exact same load.

Quotes that have been created using the /quote endpoint can be booked with the tender endpoint if the quote_id parameter, provided by the Create Quote endpoint, is sent.

post/api/v2/loads/tender

Request body

mode'FTL' | 'LTL'

The transportation mode of the load. Allowed values are:

FTL: Full Truckload
LTL: Less-than-Truckload

equipment_type'DRV' | 'FBE' | 'RFR' | 'CON' | 'CUR' | 'DDP' | 'IMC' | 'SDK' | 'STK' | 'BLK' | 'TNK' | 'OTH' required

Equipment required to transport the shipment. Recognized equipments are:

DRV: Dry Van
FBE: Flatbed
RFR: Reefer
CON: Conestoga
CUR: Curtainside
DDP: Double Drop
IMC: Intermodal
SDK: Step Deck
STK: Straight truck
BLK: Bulk
TNK: Tanker
OTH: Other equipment not explicited listed

customer_refstring required

Internal client's reference, such as an ID, of the tender

quote_idstring

Reference for the quote that should be used to book the load

commoditystring

Name of the commodity that will be shipped

sourcestring

Field used to indicate the context where the tender request was made (in a contract, routing guide process or spot bid, for example)

propertiesobject

General information about the load. This is an open JSON field that allows passing special properties with meaning on the customer context, such as the order numbers, must_arrive_by_date, and others.

bol_numberstring

the bill of lading number for the tender

Response

Tender was posted