Create Loadpost By Loadpost Request

SecurityAPIKeyHeader

Request

path Parameters

loadboard_name

required

string (LoadboardType)

An enumeration.

Enum: "dat" "truckstop" "invalid_loadboard" "internal"

Request Body schema: application/json
required

load_reference required	string (Load Reference) <= 1000 characters TMS or load reference id.
load_description	string (Load Description) <= 1000 characters Load description.
status	string (StatusEnum) Default: "OPEN" Status is the enum value for storing load status: {INVALID, OPEN, COVERED, CANCELLED, EXPIRED, RESERVED} Enum: "INVALID" "OPEN" "COVERED" "CANCELLED" "EXPIRED" "RESERVED"
required	Array of objects (Itinerary) >= 2 items Sequence of stops and information for a load.
required	Array of objects (Equipment) A list of all acceptable equipment types. If multiple equipment types are used, the weight, length dimensions but be the same for some loadboards.
mode required	string (ModeEnum) Mode is the enum value for storing the load's. Some loadboards do not support a complete list of loads. If an unsupported mode is use, an invalid type will be used: {FTL, LTL, VLTL, PARTIAL, DRAYAGE, INTERMODAL, INVALID, OTHER, FINAL_MILE} Enum: "FTL" "LTL" "VLTL" "PARTIAL" "DRAYAGE" "INTERMODAL" "INVALID" "OTHER" "FINAL_MILE" "PARCEL"
required	object (Commodity) Commodity description.
	object (Contact) Contact.
shipment_id	string (Shipment Id) Optional shipment id to tie this loadboard post to.
book_now_eligible	boolean (Book Now Eligible) Default: false Indicates whether the load is eligible for book now, default is False
	object (Rate Attributes) Rate attributes are provided in the load request and response. This will use the money structure (value, currency code).
	Array of objects (Additional References) Additional references.
bid_eligible	boolean (Bid Eligible) Default: false Indicates if this load is eligible for "Bid." Default is False. If set to false, bid action will not be possible on this shipment.
allow_list_only	boolean (Allow List Only) Default: false Whether this load should only be displayed to allowlisted carriers. Default: False.
high_priority	boolean (High Priority) Indicates if load is high-priority.
	object (Actions) Load actions.
	object (Requirements) Load requirements object.
expiration_datetime	string <date-time> (Expiration Datetime) Time at which this posting should expire. It is in UTC format, e.g. 2022-10-18T16:14:38.441Z
shipper	string (Shipper) <= 1000 characters The customer of the shipment.
freight_partner	string (Freight Partner) <= 1000 characters Company that is posting the load and is responsible for moving the freight.
freight_partner_load_id	string (Freight Partner Load Id) <= 1000 characters This field will be used in any templatized redirect URLs that you provide. If you do not provide this field, we will assume that it is the same as the load_reference for this load.
terms_and_conditions	string (Terms And Conditions) <= 1000 characters Required if using BIN. The Terms object describing the terms and conditions that are associated with the load. It is not visible to carriers who do not have BIN enabled.
	object (Schedule) Rerun post or search every "rerun_in_minutes" until "until" datetime in the future.
starts_at	string <date-time> (Starts At) Starts at
expires_at	string <date-time> (Expires At) Expires at
notes	string (Notes) <= 1000 characters A notes field to share information with the carrier (e.g. is a multistop). We take this field and the load requirements array and append them together for loadboards that don't support multistop entry or structured load requirements. We will also truncate this field if it is larger than 256 characters.
use_24_hour_time	boolean (Use 24 Hour Time) Default: false Use 24 hour datetime format for the stops plan windows.

Responses

200

Successful Response

Response Schema: application/json

load_reference required	string (Load Reference) <= 1000 characters TMS or load reference id.
load_description	string (Load Description) <= 1000 characters Load description.
status	string (StatusEnum) Default: "OPEN" Status is the enum value for storing load status: {INVALID, OPEN, COVERED, CANCELLED, EXPIRED, RESERVED} Enum: "INVALID" "OPEN" "COVERED" "CANCELLED" "EXPIRED" "RESERVED"
required	Array of objects (Itinerary) >= 2 items Sequence of stops and information for a load.
required	Array of objects (Equipment) A list of all acceptable equipment types. If multiple equipment types are used, the weight, length dimensions but be the same for some loadboards.
mode required	string (ModeEnum) Mode is the enum value for storing the load's. Some loadboards do not support a complete list of loads. If an unsupported mode is use, an invalid type will be used: {FTL, LTL, VLTL, PARTIAL, DRAYAGE, INTERMODAL, INVALID, OTHER, FINAL_MILE} Enum: "FTL" "LTL" "VLTL" "PARTIAL" "DRAYAGE" "INTERMODAL" "INVALID" "OTHER" "FINAL_MILE" "PARCEL"
required	object (Commodity) Commodity description.
	object (Contact) Contact.
shipment_id	string (Shipment Id) Optional shipment id to tie this loadboard post to.
book_now_eligible	boolean (Book Now Eligible) Default: false Indicates whether the load is eligible for book now, default is False
	object (Rate Attributes) Rate attributes are provided in the load request and response. This will use the money structure (value, currency code).
	Array of objects (Additional References) Additional references.
bid_eligible	boolean (Bid Eligible) Default: false Indicates if this load is eligible for "Bid." Default is False. If set to false, bid action will not be possible on this shipment.
allow_list_only	boolean (Allow List Only) Default: false Whether this load should only be displayed to allowlisted carriers. Default: False.
high_priority	boolean (High Priority) Indicates if load is high-priority.
	object (Actions) Load actions.
	object (Requirements) Load requirements object.
expiration_datetime	string <date-time> (Expiration Datetime) Time at which this posting should expire. It is in UTC format, e.g. 2022-10-18T16:14:38.441Z
shipper	string (Shipper) <= 1000 characters The customer of the shipment.
freight_partner	string (Freight Partner) <= 1000 characters Company that is posting the load and is responsible for moving the freight.
freight_partner_load_id	string (Freight Partner Load Id) <= 1000 characters This field will be used in any templatized redirect URLs that you provide. If you do not provide this field, we will assume that it is the same as the load_reference for this load.
terms_and_conditions	string (Terms And Conditions) <= 1000 characters Required if using BIN. The Terms object describing the terms and conditions that are associated with the load. It is not visible to carriers who do not have BIN enabled.
	object (Schedule) Rerun post or search every "rerun_in_minutes" until "until" datetime in the future.
starts_at	string <date-time> (Starts At) Starts at
expires_at	string <date-time> (Expires At) Expires at
notes	string (Notes) <= 1000 characters A notes field to share information with the carrier (e.g. is a multistop). We take this field and the load requirements array and append them together for loadboards that don't support multistop entry or structured load requirements. We will also truncate this field if it is larger than 256 characters.
use_24_hour_time	boolean (Use 24 Hour Time) Default: false Use 24 hour datetime format for the stops plan windows.
loadboard_id	string (Loadboard Id) <= 1000 characters The id of the loadboard on which the request was made.
loadpost_id required	string (Loadpost Id) Tabula unique id for the loadpost
loadboard_post_id	string (Loadboard Post Id) <= 1000 characters The loadboard post id (will be unique for the loadboard_id).
loadboard_post_request_id	string (Loadboard Post Request Id) <= 1000 characters Unique id for the loadboard post request.
required	LoadPostingResponse (object) or TSLoadResponse (object) (Loadboard Response) JSON Blob of the loadboard response for all requests on loadboard_post_id. e.g. first is POST, second is a PUT, than PUT overrides the POST.
created_at required	string <date-time> (Created At)
updated_at required	string <date-time> (Updated At)
deleted_at	string <date-time> (Deleted At)

400

Validation Error

post/loadboards/{loadboard_name}/loadpost

Request samples

application/json

{"load_reference": "string",
"load_description": "string",
"status": "OPEN",
"itinerary": [{"sequence_number": 1,
"location": {"address": {"country": "st",
"line_1": "515 Congress Ave",
"line_2": "Suite 2650",
"line_3": "line 3",
"locality": "string",
"postal_code": "string",
"region": "str",
"urbanization": "string",
"residential": false,
"geolocation": {"latitude": "string",
"longitude": "string"
}
},
"location_number": "SWHQ",
"location_name": "Shipwell HQ",
"company_name": "string",
"location_type": "OTHER",
"timezone": "America/Chicago"
},
"type": "PRELOADED_TRAILER_PICKUP",
"plan_window": {"arrival": "2019-08-24T14:15:22Z",
"departure": "2019-08-24T14:15:22Z"
},
"references": [{"key": "string",
"value": "string"
}
],
"instructions": "Must set appointment ahead of time.",
"appointment": {"begin": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"type": "FCFS"
},
"contacts": [{"contact_type": "ACCOUNT_REP",
"company_name": "Shipwell",
"person_name": "Sally Shipwell",
"email": "user@example.com",
"phone": "string",
"fax": "string"
}
]
},
{"sequence_number": 1,
"location": {"address": {"country": "st",
"line_1": "515 Congress Ave",
"line_2": "Suite 2650",
"line_3": "line 3",
"locality": "string",
"postal_code": "string",
"region": "str",
"urbanization": "string",
"residential": false,
"geolocation": {"latitude": "string",
"longitude": "string"
}
},
"location_number": "SWHQ",
"location_name": "Shipwell HQ",
"company_name": "string",
"location_type": "OTHER",
"timezone": "America/Chicago"
},
"type": "PRELOADED_TRAILER_PICKUP",
"plan_window": {"arrival": "2019-08-24T14:15:22Z",
"departure": "2019-08-24T14:15:22Z"
},
"references": [{"key": "string",
"value": "string"
}
],
"instructions": "Must set appointment ahead of time.",
"appointment": {"begin": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"type": "FCFS"
},
"contacts": [{"contact_type": "ACCOUNT_REP",
"company_name": "Shipwell",
"person_name": "Sally Shipwell",
"email": "user@example.com",
"phone": "string",
"fax": "string"
}
]
}
],
"equipment": [{"equipment_type": "DRY_VAN",
"gross_weight": {"unit": "KG",
"value": "string"
},
"temperature": {"unit": "C",
"minimum": "string",
"maximum": "string"
},
"dimensions": {"unit": "CM",
"length": "string",
"height": "string",
"width": "string"
}
}
],
"mode": "FTL",
"commodity": {"id": "string",
"name": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"code": "string"
},
"contact": {"contact_type": "ACCOUNT_REP",
"company_name": "Shipwell",
"person_name": "Sally Shipwell",
"email": "user@example.com",
"phone": "string",
"fax": "string",
"preferred_contact_method": "PRIMARY_PHONE"
},
"shipment_id": "string",
"book_now_eligible": false,
"rate_attributes": {"offer_all_in_rate": {"value": "string",
"currency_code": "USD"
},
"target_rate": {"value": "string",
"currency_code": "USD"
},
"book_now_or_tender_rate": {"value": "string",
"currency_code": "USD"
}
},
"additional_references": [{"qualifier": "PO#",
"value": "12345"
}
],
"bid_eligible": false,
"allow_list_only": false,
"high_priority": true,
"actions": {"post": true,
"tender": true
},
"requirements": {"max_temperature": "string",
"min_temperature": "string",
"pre_cool_temperature": "string",
"dimension_unit": "CM",
"temperature_units": "C",
"hazmat_identification_numbers": "string",
"strap_count": 10000000,
"high_value": true,
"tarp_size": "string",
"pallet_exchange": true,
"alcohol_permit": true,
"oversized_length": "string",
"oversized_width": "string",
"oversized_height": "string",
"blind": true,
"floor_loaded": true,
"driver_assist": true,
"lift_gate": true,
"twic_card": true,
"escorts": true,
"team": true,
"hot_shot": true,
"carb": true,
"cargo_value_insurance_amount": "string",
"cargo_value_insurance_currency_code": "string",
"tanker_endorsement": true,
"tracking_required": true
},
"expiration_datetime": "2019-08-24T14:15:22Z",
"shipper": "string",
"freight_partner": "string",
"freight_partner_load_id": "string",
"terms_and_conditions": "string",
"schedule": {"rerun_in_minutes": 0,
"until": "2019-08-24T14:15:22Z"
},
"starts_at": "2019-08-24T14:15:22Z",
"expires_at": "2019-08-24T14:15:22Z",
"notes": "string",
"use_24_hour_time": false
}

Response samples