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": {
    "calculatable_type": "amount",
    "shipping_zone_id": "b42d3a3e-bcdf-443e-9f9c-958580226cf1",
    "shipping_method_id": "deeea48d-acaa-437b-a452-0bea28dda067",
    "calculatable": {
      "amount": 650,
      "min_amount": 0,
      "max_amount": 5000
    }
  }
}
'
{
  "id": "48803279-793b-4303-a322-45ba75e9f1d2",
  "object": "shipping_rate",
  "calculatable_type": "amount",
  "calculatable": {
    "currency": "usd",
    "amount": 650,
    "min_amount": 0,
    "max_amount": 5000
  },
  "shipping_method": "deeea48d-acaa-437b-a452-0bea28dda067",
  "shipping_zone": "b42d3a3e-bcdf-443e-9f9c-958580226cf1",
  "created_at": 1782485904,
  "updated_at": 1782485904
}

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.

​
calculatable_type
enum<string>

The kind of the nested calculatable.

Available options:
amount,
flat,
weight,
live
​
calculatable
object
​
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.

​
shipping_zone

Expandable – The associated shipping zone ID.

​
shipping_method

Expandable – The associated shipping method ID.