Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Shipping::Rate

Create Rate

Add a new shipping rate to a zone

post/shipping/zones/{zone_id}/rates

Path parameters

zone_idinteger required

Request body

Example request

{
  "shipping_rate": {
    "shipping_rate": {
      "provider_name": "Tammera Kihn DO",
      "price": "10.00",
      "price_currency": "USD",
      "rates_name_id": 1,
      "live_rates_provider": null
    }
  }
}

Response

Created

idinteger

Rate ID

public_idstring nullable

Rate public ID

zone_idinteger

Zone ID

descriptionstring nullable

Rate name

provider_namestring nullable

Provider Name

pricestring

Price

price_currencystring nullable

Price Currency

rates_name_idinteger

Rate name ID

live_rates_provider'Shippo' nullable

Live Rates Provider

created_atstring date-time nullable

Added

updated_atstring date-time nullable

Updated

Example response

{
  "id": 1,
  "public_id": "InONPz",
  "zone_id": 1,
  "description": "Example Shipping Rates Name",
  "provider_name": "Tammera Kihn DO",
  "price": "10.00",
  "price_currency": "USD",
  "rates_name_id": 1,
  "live_rates_provider": null,
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}