The Update Quote end-point can be used to update existing Quotes submitted by you. This end-point is only available to providers.
Not all details can be updated - in some cases you should cancel the existing quote and submit an alternative.
You can use this end-point to submit a cancelation.
Note This end-point only applies to Providers
Request URI
PUT https://pluto.cargobase.com/api/1/quotes/{quote_reference}
Content-Type: application/json
Authorization: Token your_token_here
{quote_reference} = The 9 character quote reference, starting with a 'Q'
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 OBC, Regular Air Freight and Next Flight Out quotes are supported.
The body message of the update is very similar to the original quote submitted by you.
However, certain fields cannot be updated and others are mandatory.
Additional cost details can only be replaced in full.
The description below compares the body message of the Update to the original Quote message.
Main object categories
| Category parameter | Purpose | Requirement |
|---|---|---|
| organization | Shipment references, such as Shipment ID and provider team | Contains mandatory elements |
| service | Details such as freight mode, quote title and other service characteristics | Fully optional, can be omitted from update |
| financial | Generic financial details | Fully optional, can be omitted from update |
| cost_items | Specific mandatory cost items | ully optional, can be omitted from update |
| additional_cost_data | Additional individual cost items | should be omitted, or replaced in full! |
| schedule | Details such as expected pickup and delivery and quote validity | Fully optional, can be omitted from update |
organization values
| Key | Value | Purpose | Instruction |
|---|---|---|---|
| shipment_id | STRING | The shipment ID (S12345678) | Should not be sent - cannot be updated |
| request_status | STRING | (Open, Canceled, Confirmed) | Mandatory |
| provider_team | STRING | Should not be sent - cannot be updated | Should not be sent - cannot be updated |
| quoted_by | STRING | E-mail address of the quotee - this has to be an activa Cargobase account | Optional, can be updated |
service values
| Key | Value | Purpose | Instruction |
|---|---|---|---|
| freight_mode | STRING | Should not be sent - cannot be updated | Should not be sent - cannot be updated |
| max_weight | FLOAT | The maximum weight the Courier can travel with | Optional, can be updated - OBC Only |
| max_weight_UOM | BOOLEAN | KG or LBS for the max_weight value | Optional, can be updated - OBC Only |
| chargeable_weight | FLOAT | Chargeable weight for shipment | Optional, can be updated - Air freight / NFO Only |
| weight_UOM | FLOAT | KG or LBS for the chargeable_weight value | Optional, can be updated - Air freight / NFO Only |
| quote_title | BOOLEAN | Title of your quote, to distinguish in case of multiple quotes | Optional, can be updated |
| primary_tracking_number | BOOLEAN | Your internal reference, or future tracking number | Optional, can be updated |
financial values
| Key | Value | Purpose | Instruction |
|---|---|---|---|
| quote_currency | ISO 4217:2015 STRING | Currency of all cost items in your quote | Optional, can be updated |
| not_included | STRING | Description of quote scope boundaries | Optional, can be updated |
| cost_details | OBJECT | Specific mandatory cost items | Optional, can be updated |
cost_details values
| Key | Value | Purpose | Instruction |
|---|---|---|---|
| quoted_amount | DECIMAL | OBC base fee | Optional, can be updated - OBC Only |
| total_excess_cost | DECIMAL | Optional excess cost | Optional, can be updated - OBC Only |
| air_freight_charges | DECIMAL | Air freight / NFO base fee | Optional, can be updated - Regular air freight / NFO Only |
| additional_cost_data | OBJECT | Optional additional cost items | Optional - can only be updated in full! |
additional_cost_data values
Note Additional cost items can only be updated in full. You cannot update a single cost item - all items should be sent in again.
| Key | Value | Purpose | Instruction |
|---|---|---|---|
| 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 | Value | Purpose | Instruction |
|---|---|---|---|
| expected_pickup_date | TIMESTAMP | Expected pickup date, format YYYY-MM-DD | Optional, can be updated |
| expected_pickup_time | TIMESTAMP | Expected pickup time, format HH:MM | Optional, can be updated |
| expected_stop1_date | TIMESTAMP | Expected delivery date, format YYYY-MM-DD | Optional, can be updated |
| expected_stop1_time | TIMESTAMP | Expected delivery time, format HH:MM | Optional, can be updated |
| quote_validity_date | STRING | Quote validity date, format YYYY-MM-DD | Optional, can be updated |
| quote_validity_time | STRING | Quote validity time, format HH:MM Please note, time is in line with personal preferences - contact Support to request changes | Optional, can be updated |
Error Messages
| Description | Resolution |
|---|---|
| Status is missing | Please ensure your update includes the right status |
| Shipment is no longer available | Shipment is no longer available for quotations |
| An issue occurs with total quoted value, or underlying cost items | An issue exists with the total quoted amount or underlying cost items |