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).

Requires the org:admin role (granted automatically to UUID-format API keys).

POST /api/public/v1/shipping-rates

Create a shipping rate

cURL

curl --request POST \
  --url http://app.localhost:3000/api/public/v1/shipping-rates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shippingRateName": "<string>",
  "amount": {},
  "storeId": "<string>",
  "isFree": true,
  "isPickupPoint": true,
  "id": "<string>",
  "description": "<string>",
  "icon": "<string>",
  "highlighted": true,
  "shippingRateMinAmount": {},
  "shippingRateMaxAmount": {},
  "shippingRateMinWeight": 123,
  "shippingRateMaxWeight": 123,
  "countryCodes": [
    "<string>"
  ],
  "pickupPointCarriers": [
    "<string>"
  ],
  "estimatedDeliveryTime": 1
}
'

default

{
  "message": "<string>",
  "code": "<string>",
  "issues": [
    {
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

shippingRateName · string · required

Minimum string length: 1

amount · object · required

Show child attributes

storeId · string · required

isFree · boolean · required

isPickupPoint · boolean · required

id · string

description · string

icon · string

highlighted · boolean

shippingRateMinAmount · object

Show child attributes

shippingRateMaxAmount · object

Show child attributes

shippingRateMinWeight · number | null

shippingRateMaxWeight · number | null

countryCodes · string[]

pickupPointCarriers · string[] | null

estimatedDeliveryTime · integer | null

Required range: x > 0

Response

200

application/json

Successful response