WIwithflex
Shipping Rates

List Shipping Rates

Changed on

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

get/v1/shipping_rates

Request

  • Base URL
    https://api.withflex.com
  • URL
    https://api.withflex.com/v1/shipping_rates
  • Auth
    HTTP bearer

Query parameters

activeboolean nullable

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
offsetinteger nullable

Number of objects to skip before returning results.

Example:3
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
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

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"
    }
  ]
}

Changes

  • eec642897a22Revision changes
    • warning

      for the query request parameter limit, the max was set to 9007199254740991.00

    • warning

      for the query request parameter offset, the max was set to 9007199254740991.00

    • warning

      for the query request parameter limit, the min was set to -9007199254740991.00

    • warning

      for the query request parameter offset, the min was set to -9007199254740991.00