The Submit Quote end-point can be used to post Quotes on requests. This end-point is only available to providers.
Additionally, providers can only quote on requests they have been invited for.
Note This end-point only applies to Providers Note Currently only Regular Air freight, NFO, OBC, Road and Ocean quotes are supported - additional freight modes will follow.
Request URI
POST https://pluto.cargobase.com/api/1/quotes
Content-Type: application/json
Authorization: Token your_token_here
Known issues
None, at the moment. If you find anything; please reach out to [email protected]
Body message
Contents of the body message can be dependant on the freight mode that you are quoting on.
At this moment, only Air freight, NFO, OBC, Road and Ocean quotes are supported. Some fields are specific to the freight mode.
The message body is constructed around 4 main object categories and 2 subcategories.
Each category is mandatory in the request, specific values are not.
Main object categories
Category parameter
Purpose
Child object
organization
Shipment references, such as Shipment ID and provider team
none
service
Details such as freight mode, quote title and other service characteristics
none
financial
Generic financial details
cost_items, additional_cost_data
schedule
Details such as expected pickup and delivery and quote validity
flights (optional)
organization values
Key
Type
Purpose
Availability
shipment_id
STRING
The shipment ID (S12345678) you are quoting on
Mandatory
provider_team
STRING
The reference number (PT12345678) of the provider team associated with the quote
Mandatory
quoted_by
STRING
E-mail address of the quotee - this has to be an activa Cargobase account
Mandatory
Note You can only reference a provider team that is invited on this quote. The available teams are different per request. The 'provider_reference' list in the 'Service'-object in the Request Detail api response contains available teams for that shipment.
service values
Key
Type
Purpose
Availability
freight_mode
STRING
The freight mode associated with the quote - see values below
Mandatory
max_weight
FLOAT
The maximum weight the Courier can travel with
Mandatory, OBC ONLY
max_weight_UOM
STRING
KG or LBS for the max_weight value
Mandatory, OBC ONLY
max_dimension
FLOAT
The maximum dimension of the Courier can travel with
Mandatory, Road Freight ONLY
max_dimension_UOM
STRING
meter or feet for the max_dimension value
Mandatory, Road Freight ONLY
road_freight_type
STRING
Freight type for the courier, see below for the availale road freight types
Mandatory, Road Freight ONLY
vessel_number
STRING
Vessel Number of the ship
Mandatory, Ocean Freight ONLY
vessel_info
JSON
Can hold new vessel info like vessel_name, vessel_operator_carrier_code , carrier_voyage_number.
Mandatory, Ocean Freight ONLY
chargeable_weight
FLOAT
Chargeable weight of air freight and NFO Quotes
Mandatory, for air freight & NFO
weight_UOM
STRING
KG or LBS for the chargeable_weight value
Mandatory, for air freight & NFO
quote_title
STRING
Title of your quote, to distinguish in case of multiple quotes
Mandatory
primary_tracking_number
STRING
Your internal reference, or future tracking number
Mandatory
road_freight_type values
Road Freight mode
API string
Full Truck Load
ftl
Less than Truck Load
ltl
Ground Expedite
ge
Specialized - Car haulers, flat-beds, dump truck
spe
Multi stop
multi-stop
Multi drop
multi-drop
freight_mode values
Freight mode
API string
Comment
On board courier (OBC)
OBC
Available now
Next flight out (NFO)
NFO
Available now
Regular air freight
Regular air freight
Available now
Air charter
Charter
1.1+
Parcel
n.a.
Will not be supported
Road freight
Road freight
Available now
Ocean freight
Ocean freight
Available now
Rail freight
Rail
1.1+
financial values
Key
Type
Purpose
Availability
quote_currency
ISO 4217:2015 STRING
Currency of all cost items in your quote
Mandatory
not_included
STRING
Description of quote scope boundaries
Mandatory
cost_details
OBJECT
Specific mandatory cost items
Mandatory
cost_details values
Key
Type
Purpose
Availability
quoted_amount
DECIMAL
OBC/Road/Ocean base fee
Mandatory, OBC/Road/Ocean ONLY
total_excess_cost
DECIMAL
Optional excess cost
Optional, OBC ONLY
air_freight_charges
DECIMAL
Regular Air and NFO per kg/lbs fee
Mandatory, for air freight & NFO
additional_cost_data
OBJECT
Optional additional cost items
Optional
additional_cost_data values
Key
Type
Purpose
Availability
additional_cost_description
STRING
Description of additional cost item
Conditional
additional_cost_item_amount
DECIMAL
Amount of the additional cost item
Conditional
Note Multiple additional cost items can be added - as dictionary objects within additional_cost_data
schedule values
Key
Type
Purpose
Availability
expected_pickup_date
STRING
Expected pickup date, format YYYY-MM-DD
Mandatory
expected_pickup_time
STRING
Expected pickup time, format HH:MM
Mandatory
expected_stop1_date
STRING
Expected delivery date, format YYYY-MM-DD
Mandatory
expected_stop1_time
STRING
Expected delivery time, format HH:MM
Mandatory
quote_valid_until_date
STRING
Quote validity date, format YYYY-MM-DD
Mandatory
quote_valid_until_time
STRING
Quote validity time, format HH:MM Note Time is in line with personal preferences - contact Support to request changes
Mandatory
vessel_departure_date
STRING
Vessel departure date, format YYYY-MM-DD
Mandatory Ocean Freight Only
vessel_arrival_date
STRING
Vessel arrival date, format YYYY-MM-DD
Mandatory Ocean Freight Only
flights
ARRAY of OBJECT
One or more commercial flight details (optional)
Optional
flights values
The flights object is an array of objects pertaining to commercial flights. The array is optional, but can contain 1 or more flights.
Since this is an array, ensure to enclose the individual flight objects in brackets, like this [{OBJECT}, {OBJECT}]
Key
Type
Purpose
Availability
airline_code
STRING
2 Character IATA code of the airline
Mandatory
flight_number
STRING
Number / reference of the flight, as a string
Mandatory
departure_date
STRING
Date as YYYY-MM-DD
Mandatory
departure_time
STRING
Time as HH:MM
Mandatory
departure_airport_code
STRING
IATA code of departure airport
Mandatory
arrival_date
STRING
Date as YYYY-MM-DD
Mandatory
arrival_time
STRING
Time as HH:MM
Mandatory
arrival_airport_code
STRING
IATA code of arrival airport
Mandatory
Status codes
Status
Description
Resolution
201
Created
Your quote has been posted
403
Forbidden
Check Authentication token
In case of a successful POST your response will contain the Quote reference number (QR12345678).
Language
Credentials
http
Response
Click Try It! to start a request and see the response here!
