Get Loadpost Request By Shipment Id Request

SecurityAPIKeyHeader
Request
path Parameters
shipment_id
required
string (Shipment Id)
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.

400

Validation Error

get/loadboards/loadpost-requests/{shipment_id}
Request samples 
Response samples 
application/json
{
  • "load_reference": "string",
  • "load_description": "string",
  • "status": "OPEN",
  • "itinerary": [
    ],
  • "equipment": [
    ],
  • "mode": "FTL",
  • "commodity": {
    },
  • "contact": {
    },
  • "shipment_id": "string",
  • "book_now_eligible": false,
  • "rate_attributes": {
    },
  • "additional_references": [
    ],
  • "bid_eligible": false,
  • "allow_list_only": false,
  • "high_priority": true,
  • "actions": {
    },
  • "requirements": {
    },
  • "expiration_datetime": "2019-08-24T14:15:22Z",
  • "shipper": "string",
  • "freight_partner": "string",
  • "freight_partner_load_id": "string",
  • "terms_and_conditions": "string",
  • "schedule": {
    },
  • "starts_at": "2019-08-24T14:15:22Z",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "use_24_hour_time": false
}
Copyright © Shipwell 2024. All right reserved.