Skip to main content
POST
/
v1
/
shipping_rates
Create Shipping Rate
curl --request POST \
  --url https://api.withflex.com/v1/shipping_rates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shipping_rate": {
    "display_name": "Example",
    "amount": 0,
    "metadata": {}
  }
}
'
{
  "shipping_rate": {
    "shipping_rate_id": "obj_01EXAMPLE00000000000000000",
    "active": false,
    "display_name": "Example",
    "amount": 0,
    "metadata": {},
    "created_at": "2024-01-01T00:00:00Z"
  }
}

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access this API.

Body

application/json
​
shipping_rate
object
required
Example:
{
  "display_name": "Example",
  "amount": 0,
  "metadata": {}
}

Response

Success

​
shipping_rate
object
required
Example:
{
  "shipping_rate_id": "obj_01EXAMPLE00000000000000000",
  "active": false,
  "display_name": "Example",
  "amount": 0,
  "metadata": {},
  "created_at": "2024-01-01T00:00:00Z"
}