POST /shipping-rate-zones.json

POST /shipping-rate-zones.json
application/json

Body Required

  • 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.

  • customCarriers string | null Required

    Custom carriers

    Values are all or selected. Default value is all.

  • Integration filtering endpoint

  • name string | null

    Name

  • 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.

  • Use integration filtering endpoint

  • 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.

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

    • Integration filtering endpoint

    • name string | null

      Name

    • 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

    • Use integration filtering endpoint

    • 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.

POST /shipping-rate-zones.json
curl \
 -X POST http://api.example.com/v1/shipping-rate-zones.json \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"bandType":"price","countries":[],"countriesFilter":"all","customCarriers":"all","integrationFilteringEndpoint":"string","name":"string","serviceFilteringEndpoint":"string","shippingRateId":42,"states":[],"statesFilter":"all","tags":[],"tagsFilter":"all","useIntegrationFilteringEndpoint":true,"useServiceFilteringEndpoint":true,"variantScope":"all","zips":[],"zipsFilter":"all"}'
Request example
{
  "bandType": "price",
  "countries": [],
  "countriesFilter": "all",
  "customCarriers": "all",
  "integrationFilteringEndpoint": "string",
  "name": "string",
  "serviceFilteringEndpoint": "string",
  "shippingRateId": 42,
  "states": [],
  "statesFilter": "all",
  "tags": [],
  "tagsFilter": "all",
  "useIntegrationFilteringEndpoint": true,
  "useServiceFilteringEndpoint": true,
  "variantScope": "all",
  "zips": [],
  "zipsFilter": "all"
}
Response examples (200)
{
  "bandType": "price",
  "countries": [],
  "countriesFilter": "all",
  "createdAt": "2024-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": "2024-05-04T09:42:00+00:00",
  "useIntegrationFilteringEndpoint": true,
  "useServiceFilteringEndpoint": true,
  "variantScope": "all",
  "zips": [],
  "zipsFilter": "all"
}