store_get_available_shipping_zones
Retrieve available shipping zones for an order using country, order amount, weight, source, and product data to determine applicable shipping rates.
Instructions
Get available shipping rates
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"country": "<country>",
"totalOrderAmount": "<totalOrderAmount>",
"totalOrderWeight": "<totalOrderWeight>",
"source": "<source>",
"products": "<products>"
},
"name": "store_get_available_shipping_zones"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| altId | No | Location Id or Agency Id Defaults to GHL_LOCATION_ID when omitted. | |
| source | Yes | Source of the order | |
| address | No | Address of the customer | |
| altType | No | Defaults to GHL_LOCATION_ID when omitted. | |
| country | Yes | Country code of the customer | |
| products | Yes | An array of price IDs and quantity | |
| couponCode | No | Coupon code | |
| amountAvailable | No | it will not calculate the order amount form backend if it is true | |
| weightAvailable | No | Flag to pass when the weight is already calculated and should not calculate again | |
| totalOrderAmount | Yes | The amount of the price. ( min: 0.01 ) | |
| totalOrderWeight | Yes | Estimated weight of the order calculated from the order creation side in kg(s) |