Introduction
The Shipping Rate object provides detailed information about available shipping options for a given shipping address and list of cart items (buy requests). This allows users to select the most suitable rate based on factors like cost, delivery speed, and carrier.
Shipping Rate Object
Core Parameters
id
A unique identifier.
carrier
Example "UPS".
service
Example "NextDayAir"
rate
The cost of the shipping option in US dollars ($).
delivery_days
The number of days the delivery would take.
shipment_id
A unique identifier.
carrier_account_id
Id of the carrier account.
Generate Shipping Rates Payload
Core Parameters
address
The id of the shipping address for which the shipping rates are to be generated.
buyRequestIds
An array of ids of the buy requests for which the shipping rates are to be generated.