Responses

• 200 application/json

  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

    Countries

    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)

    Id

  • integrationFilteringEndpoint string | null

    Integration filtering endpoint

  • name string | null

    Name

  • serviceFilteringEndpoint string | null

    Service filtering endpoint

  • shippingRateId integer(int32) Required

    Shipping rate

  • states array[string] | null Required

    States

    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

    Tags

    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

  • useIntegrationFilteringEndpoint boolean | null

    Use integration filtering endpoint

  • useServiceFilteringEndpoint boolean | null

    Use service filtering endpoint

  • variantScope string | null Required

    Variant scope

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

  • zips array[string] | null Required

    Zips

    Default value is [] (empty).

  • zipsFilter string | null Required

    Zips filter

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