GET /shipping-rate-zones/{id}.json

GET /shipping-rate-zones/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.


  • 200

    Successful response

    Hide response attributes Show response attributes object
    • bandType string | null Required

      Band type

      Values are fixed, weight, price, or carrier. Default value is price.

    • countries array[string] | null Required


      Default value is [] (empty).

    • countriesFilter string | null Required

      Countries filter

      Values are all, domestic, rest_of_world, exclude, or include. Default value is all.

    • createdAt string(date-time)

      Created at

    • customCarriers string | null Required

      Custom carriers

      Values are all or selected. Default value is all.

    • id integer(int32)


    • Integration filtering endpoint

    • name string | null


    • Service filtering endpoint

    • shippingRateId integer(int32) Required

      Shipping rate

    • states array[string] | null Required


      Default value is [] (empty).

    • statesFilter string | null Required

      States filter

      Values are all, exclude, or include. Default value is all.

    • tags array[string] | null Required


      Default value is [] (empty).

    • tagsFilter string | null Required

      Tags filter

      Values are all, exclude, or include. Default value is all.

    • updatedAt string(date-time)

      Updated at

    • Use integration filtering endpoint

    • Use service filtering endpoint

    • zips array[string] | null Required


      Default value is [] (empty).

    • zipsFilter string | null Required

      Zips filter

      Values are all, exclude, include, or startsWith. Default value is all.

GET /shipping-rate-zones/{id}.json
curl \
 -X GET{id}.json
Response examples (200)
  "bandType": "price",
  "countries": [],
  "countriesFilter": "all",
  "createdAt": "2023-05-04T09:42:00+00:00",
  "customCarriers": "all",
  "id": 42,
  "integrationFilteringEndpoint": "string",
  "name": "string",
  "serviceFilteringEndpoint": "string",
  "shippingRateId": 42,
  "states": [],
  "statesFilter": "all",
  "tags": [],
  "tagsFilter": "all",
  "updatedAt": "2023-05-04T09:42:00+00:00",
  "useIntegrationFilteringEndpoint": true,
  "useServiceFilteringEndpoint": true,
  "zips": [],
  "zipsFilter": "all"