Get Shipping Rates
teapplix_get_ratesGet shipping rates for a shipment without an existing order. [DEMO]
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| To | Yes | Destination address. | |
| From | Yes | Ship-from address OR a saved shipping profile — supply exactly one shape. | |
| Packages | Yes | One or more packages to rate. Each package must include Method; Weight and Dimensions set the package size for the rate query. All packages must use the same carrier. To compare carriers, prefer a RATESHOP method; otherwise make separate calls per carrier. | |
| ShipDate | No | Ship date (YYYY-MM-DD). Defaults to today. Interpreted as Pacific timezone. | |
| CustomsDeclaration | No | International shipments only. Omit unless shipping outside US. Fields: ReasonForExport, IOssNumber, Items: [{Description, Quantity, Value, Weight, HSTariffNumber, CountryOfOrigin}]. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| Rate | No | Rate for the requested method when it succeeded. Absent means the requested method failed — inspect AltRates for carrier suggestions. For RATESHOP, this is the winning (lowest-cost) candidate. | |
| Zone | No | Carrier zone for the selected rate (e.g. "3"). | |
| AltRates | No | Carrier-provided alternate quotes. May appear alongside a successful Rate (carrier suggestions) or without Rate (requested method failed). Items with Error set are methods the carrier could not quote. For RATESHOP, all non-winning evaluated candidates — valid higher-cost quotes and failed methods. | |
| Warnings | No | optional warning message, you can safely ignore |