get_opt_in_rates
Retrieve optional add-on shipping rates by providing collection and delivery addresses to calculate additional service costs for shipments.
Instructions
Get optional add-on rates for a shipment
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| collection_address | Yes | Collection address | |
| delivery_address | Yes | Delivery address |
Input Schema (JSON Schema)
{
"properties": {
"collection_address": {
"description": "Collection address",
"properties": {
"city": {
"type": "string"
},
"code": {
"type": "string"
},
"country": {
"type": "string"
},
"street_address": {
"type": "string"
},
"type": {
"enum": [
"residential",
"business"
],
"type": "string"
}
},
"required": [
"street_address",
"city",
"code"
],
"type": "object"
},
"delivery_address": {
"description": "Delivery address",
"properties": {
"city": {
"type": "string"
},
"code": {
"type": "string"
},
"country": {
"type": "string"
},
"street_address": {
"type": "string"
},
"type": {
"enum": [
"residential",
"business"
],
"type": "string"
}
},
"required": [
"street_address",
"city",
"code"
],
"type": "object"
}
},
"required": [
"collection_address",
"delivery_address"
],
"type": "object"
}