Get My Price

Retrieves shipping lane price data for an individual company and returns the retrieved prices to the caller.

  • equipment_type: Equipment type the lane was run with - DRY_VAN, REEFER or FLATBED

  • stops: List of stops in the format country:US|postal_code:78701

Request
Security:
query Parameters
equipment_type
required
string (EquipmentType)

An enumeration.

Enum: "DRY_VAN" "REEFER" "FLATBED"
stops
required
Array of strings (List of Stops) country:US\|postal_code:[0-9]{5}(?:-[0-9]{4})...

List of stops in the format country:US|postal_code:78701

pickup_radius
required
integer (Pickup Radius) >= 0
drop_off_radius
required
integer (Drop Off Radius) >= 0
shipment_type
string (ShipmentType)

An enumeration.

Enum: "Spot" "Contract"
pickup_date.gte
string <date> (Pickup Date.Gte)
filter
string (Filter Expression) ((reference_id|carrier_name)=~([\w\d\s]*)),*

Comma delimited list of fields, operators and values to filter on

sort
string (Sort)
page
integer (Page)
Default: 1
limit
integer (Limit)
Default: 50
Responses
200

Successful Response

Response Schema: application/json
Array of objects (Errors)
Default: []
required
object (MyPriceData)
page
integer (Page)
Default: 1
limit
integer (Limit)
Default: 50
total_pages
integer (Total Pages)
object (Links)
Default: {"last":""}
422

Validation Error

get/historical
Request samples
curl -i -X GET \
  'https://api.shipwell.com/pricing/historical?equipment_type=DRY_VAN&stops=string&pickup_radius=0&drop_off_radius=0&shipment_type=Spot&pickup_date.gte=2019-08-24&filter=string&sort=string&page=1&limit=50' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "errors": [ ],
  • "data": {
    },
  • "page": 1,
  • "limit": 50,
  • "total_pages": 0,
  • "links": {
    }
}
Copyright © Shipwell 2022. All right reserved.