{
"id": "shippingrate_abc123"
}{
"message": "<string>",
"code": "<string>",
"issues": [
{
"message": "<string>"
}
]
}Create a shipping rate
Create a shipping rate for a store. The new rate is matched against
incoming checkout sessions on country, cart subtotal, and total weight,
and surfaced via GET /checkout-sessions/:id/shipping-rates.
Conditions interact additively — a customer must satisfy all set
thresholds. Leave a field undefined to skip the corresponding check
(e.g. omit countryCodes to allow any country).
countryCodes takes ISO 3166-1 codes in any form — alpha-2 ("US"),
alpha-3 ("USA") or numeric ("840"). They are stored and matched as
numeric codes; an unknown code is rejected with a 400.
Requires the org:admin role (granted automatically to UUID-format API
keys).
{
"id": "shippingrate_abc123"
}{
"message": "<string>",
"code": "<string>",
"issues": [
{
"message": "<string>"
}
]
}Authorizations
Enter your API key as: Bearer your-api-key
Body
1Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Countries the rate applies to, as ISO 3166-1 codes — alpha-2 ("US"), alpha-3 ("USA") or numeric ("840") are all accepted and stored as numeric. Omit or pass [] for any country.
x > 0Response
Successful response