post https://staging-api.shipmates.app/v1/quote
Before booking a shipment, there are times that you want to know how much delivery could be for two addresses, several couriers, and a few other options. The Quote endpoint allows you to check how much a shipment could be.
Quote Discrepancy
Quotes are subject to change when the actual shipment is booked. The factors that could affect the pricing could be things like surge pricing, courier pricing adjustments, etc. This endpoint should only be used to gauge the price range of potential shipments.
| Parameters | Required? | Description |
|---|---|---|
| from_address object | Required | The address for the shipment's pickup. |
| to_address object | Required | The customer's address for the shipment. |
| items object | Required | The list of items of the shipment. |
| amount_total float | Required | The declared value of the shipment in PHP (Philippine Pesos). |
| amount_cod float | Optional, default is 0 | The Cash on Delivery amount of the shipment in PHP (Philippine Pesos). If the value is greater than zero, the shipment will be tagged as Cash on Delivery. |
| options object | Optional | The different options available for the shipment. See the Options table. |
The Address object
| Parameters | Required? | Description |
|---|---|---|
| contact_name string | Required | The name of the contact person. |
| contact_number string | Required | The mobile number of the contact person. |
| contact_email string | Optional | The email address of the contact person. |
| address1 string | Required | The street/house/building number of the address. |
| address2 string | Required | The barangay of the address. |
| city string | Required | |
| province string | Required | |
| country string | Required | The country of the address. We only do Philippines shipments at the moment. |
| zip string | Required | |
| landmark string | Optional | A landmark for the couriers to help find the address. |
| remarks string | Optional | Additional remarks for the couriers |
| latitude string | Required for on-demand, not required for next-day shipments | E.g 14.5440787 |
| longitude string | Required for on-demand, not required for next-day shipments | E.g. 121.0652003 |
| google_places_id string | Optional |
The Item object:
| Attributes | Required? | Description |
|---|---|---|
| name string | Required | |
| description string | Required | |
| quantity integer | Required | |
| price integer | Required | The declared value of a single item in PHP (Philippine Pesos). |
The Options object:
| Attributes | Required? | Description |
|---|---|---|
| insurance boolean | Optional for on-demand, required for next-day shipments | If you want to insure your shipment, set this to true. Not all on-demand couriers have insurance. |
| insulated_box boolean (On-demand only) | Optional | If you need an insulated box for your on-demand shipment. |
| driver_assistance boolean (On-demand only) | Optional | If you need help from the driver to carry things around for you. |