Skip to main content
POST
/
v1
/
shipping_rates
Create
curl --request POST \
  --url https://{defaultHost}/v1/shipping_rates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shipping_rate": {
    "amount": 650,
    "rate_type": "amount",
    "shipping_zone_id": "c1fae71e-55cf-4a5a-9094-260121312284",
    "shipping_method_id": "4d4001a2-b2d2-478a-98f8-b8d47b9ad58f",
    "min_amount": 0,
    "max_amount": 5000
  }
}
'
{
  "id": "355de2c7-1126-4b29-96b3-5b3ac1804fef",
  "object": "shipping_rate",
  "amount": 650,
  "currency": "usd",
  "max_amount": 5000,
  "min_amount": 0,
  "max_weight": null,
  "min_weight": 0,
  "rate_type": "amount",
  "weight_unit": "lb",
  "shipping_method": "4d4001a2-b2d2-478a-98f8-b8d47b9ad58f",
  "shipping_zone": "c1fae71e-55cf-4a5a-9094-260121312284",
  "created_at": 1767909773,
  "updated_at": 1767909773
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
shipping_rate
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
amount
integer

The amount in cents to be charged, represented as a whole integer. For example 9900 is equivalent to $99.

​
rate_type
string

The calculation strategy for this shipping rate – one of amount, flat, or weight. If amount, this shipping rate will be applicable to checkouts that have a subtotal_amount within the min/max amount range. If flat, this rate will be applicable to all line items. If weight, this rate will be applicable to line items that have a combined weight within the min/max weight range.

​
min_amount
integer

The minimum subtotal_amount of a checkout for this rate to apply.

​
max_amount
integer | null

The maximum subtotal_amount of a checkout for this rate to apply.

​
min_weight
number

The minimum combined weight of a line item for this rate to apply.

​
max_weight
number | null

The maximum combined weight of a line item for this rate to apply.

​
weight_unit
string

The weight unit for this shipping rate – one of lb, oz, kg, g.

​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.

​
currency
string

Three-letter ISO currency code, in lowercase. This value will match the Account currency.

​
shipping_zone

Expandable – The associated shipping zone ID.

​
shipping_method

Expandable – The associated shipping method ID.