MYmyclickfunnels
Shipping::Rate

List Rates

Changed on

List shipping rates for a zone

get/shipping/zones/{zone_id}/rates

Request

Path parameters

zone_idstring required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

per_pageinteger

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

OK

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

Changes

  • 511d88b30aeaRevision changes
    • warning

      added the new undefined enum value to the / response property for the response status

    • info

      added the new optional query request parameter per_page

    • info

      for the path request parameter zone_id, the type was generalized from integer to string

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status