checkout_rates
Create a checkout rates configuration
Create a checkout rates configuration together with its initial delivery options and shared settings. The configuration is returned with a generated config_id and, for each option, a generated option_id.
For live_rate and local_delivery options, each service's carrier_id and service_code are validated and resolved against the carriers connected to your account.
post/v1/checkout_rates
Request body
Example request
{
"options": [
{
"name": "Standard Shipping",
"type": "live_rate",
"services": [
{
"carrier_id": "se-1234567",
"service_code": "usps_priority_mail"
}
],
"fee_mode": "add",
"fee_percentage": 10,
"fallback_mode": "flat_rate",
"fallback_rate_amount": 5,
"fallback_rate_currency": "USD",
"fallback_percentage": 5,
"amount": 4.99,
"currency": "USD"
}
],
"shared_settings": {
"calculation_method": "by_volume"
}
}Response
The checkout rates configuration was created.
Example response
{
"config_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"options": [
{
"option_id": 100001,
"config_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Standard Shipping",
"type": "live_rate",
"services": [
{
"carrier_id": "se-1234567",
"service_code": "usps_priority_mail"
}
],
"fee_mode": "add",
"fee_percentage": 10,
"fallback_mode": "flat_rate",
"fallback_rate_amount": 5,
"fallback_rate_currency": "USD",
"fallback_percentage": 5,
"currency": "USD",
"is_active": true,
"created_at": "2026-05-15T18:30:00Z"
}
],
"shared_settings": {
"calculation_method": "by_volume"
},
"created_at": "2026-05-15T18:30:00Z"
}