Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Shipping Rates

List Shipping Rates

Returns a list of your shipping rates, most recent first. Pass active to return only active or only archived rates.

get/v1/shipping_rates

Query parameters

activeboolean nullable

Only return shipping rates where active matches this value.

Only return shipping rates where active matches this value.

limitinteger nullable

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Example:10

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

offsetinteger nullable

Number of objects to skip before returning results.

Example:3

Number of objects to skip before returning results.

starting_afterstring nullable

A cursor for use in pagination. starting_after is a shipping rate ID that defines your place in the list.

Example:fshr_01J9XR8M3K7VZ8N2YB4WJ6T0RA

A cursor for use in pagination. starting_after is a shipping rate ID that defines your place in the list.

ending_beforestring nullable

A cursor for use in pagination. ending_before is a shipping rate ID that defines your place in the list.

Example:fshr_01J9XR8M3K7VZ8N2YB4WJ6T0RA

A cursor for use in pagination. ending_before is a shipping rate ID that defines your place in the list.

Response

An envelope wrapping a list of shipping rate objects.

Example response

{
  "shipping_rates": [
    {
      "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"
    }
  ]
}