Skip to main content
GET
List Shipping Rates

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

active
boolean | null

Only return shipping rates where active matches this value.

Example:

false

limit
integer<int64> | null

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

Example:

10

offset
integer<int64> | null

Number of objects to skip before returning results.

Example:

3

starting_after
string | null

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

Example:

"fshr_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

ending_before
string | null

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

Example:

"fshr_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

Response

An envelope wrapping a list of shipping rate objects.

An envelope wrapping a list of shipping rate objects.

shipping_rates
object[]
required

The list of shipping rates.