v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Shipping Rates

Create Shipping Rate

Creates a new shipping rate. The rate is a fixed amount denominated in USD. New shipping rates are active by default.

post/v1/shipping_rates

Request body

Example request

{
  "shipping_rate": {
    "display_name": "Example",
    "amount": 2500,
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    }
  }
}

Response

An envelope wrapping a single shipping rate object.

Example response

{
  "shipping_rate": {
    "shipping_rate_id": "fshr_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "active": false,
    "display_name": "Example",
    "amount": 2500,
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    },
    "created_at": "2026-06-15T14:30:00Z"
  }
}