v1
latestOpenAPI 3.1.02026-07-2684271522.2 KBShipping Rates
Update Shipping Rate
Updates the specified shipping rate. You can update active and metadata; both are overwritten with the values passed, and omitting metadata clears it. The shipping rate's display_name and amount are immutable.
put/v1/shipping_rates/{id}
Path parameters
idstring required
Example:fshr_01J9XR8M3K7VZ8N2YB4WJ6T0RA
Request body
Example request
{
"shipping_rate": {
"metadata": {
"order_id": "8842",
"channel": "shopify"
},
"active": false
}
}Response
An envelope wrapping a single shipping rate object.
Example response
{
"shipping_rate": {
"shipping_rate_id": "fshr_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"active": false,
"display_name": "Example",
"amount": 2500,
"metadata": {
"order_id": "8842",
"channel": "shopify"
},
"created_at": "2026-06-15T14:30:00Z"
}
}