get_shipping_rates
Calculate shipping rates for shipments between addresses by inputting collection and delivery details, parcel dimensions, and delivery date ranges.
Instructions
Get shipping rates for a shipment between two addresses
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| collection_address | Yes | Collection address details | |
| collection_max_date | No | ||
| collection_min_date | No | ||
| declared_value | No | Total declared value | |
| delivery_address | Yes | Delivery address details | |
| delivery_max_date | No | ||
| delivery_min_date | No | ||
| parcels | Yes | List of parcels to ship |
Input Schema (JSON Schema)
{
"properties": {
"collection_address": {
"description": "Collection address details",
"properties": {
"city": {
"type": "string"
},
"code": {
"type": "string"
},
"company": {
"type": "string"
},
"country": {
"type": "string"
},
"lat": {
"type": "number"
},
"lng": {
"type": "number"
},
"local_area": {
"type": "string"
},
"street_address": {
"type": "string"
},
"type": {
"enum": [
"residential",
"business"
],
"type": "string"
},
"zone": {
"type": "string"
}
},
"required": [
"street_address",
"city",
"code"
],
"type": "object"
},
"collection_max_date": {
"format": "date",
"type": "string"
},
"collection_min_date": {
"format": "date",
"type": "string"
},
"declared_value": {
"description": "Total declared value",
"type": "number"
},
"delivery_address": {
"description": "Delivery address details",
"properties": {
"city": {
"type": "string"
},
"code": {
"type": "string"
},
"company": {
"type": "string"
},
"country": {
"type": "string"
},
"lat": {
"type": "number"
},
"lng": {
"type": "number"
},
"local_area": {
"type": "string"
},
"street_address": {
"type": "string"
},
"type": {
"enum": [
"residential",
"business"
],
"type": "string"
},
"zone": {
"type": "string"
}
},
"required": [
"street_address",
"city",
"code"
],
"type": "object"
},
"delivery_max_date": {
"format": "date",
"type": "string"
},
"delivery_min_date": {
"format": "date",
"type": "string"
},
"parcels": {
"description": "List of parcels to ship",
"items": {
"properties": {
"description": {
"type": "string"
},
"height": {
"description": "Height in cm",
"type": "number"
},
"length": {
"description": "Length in cm",
"type": "number"
},
"reference": {
"type": "string"
},
"value": {
"type": "number"
},
"weight": {
"description": "Weight in kg",
"type": "number"
},
"width": {
"description": "Width in cm",
"type": "number"
}
},
"required": [
"length",
"width",
"height",
"weight"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"collection_address",
"delivery_address",
"parcels"
],
"type": "object"
}