Shipping Zone Object

{
   "id":"string",
   "name":"string",
   "locations":[
      {
         "country":"string",
         "region":"string"
      }
   ],
   "postal_codes":[
      "string"
   ],
   "has_automated_shipping":true,
   "shipping_methods":[
      {
         "id":"string",
         "type":"UNKNOWN",
         "name":"string",
         "min_delivery_time_in_days":0,
         "max_delivery_time_in_days":0,
         "rates":[
            {
               "price":0,
               "min_cart_weight":0,
               "max_cart_weight":0,
               "min_cart_value":0,
               "max_cart_value":0
            }
         ]
      }
   ]
}

shipping_zone

Property	Description
id string	System identifier generated by duda native ecommerce. Is prefixed with sz_
name string	Merchant defined string name for a shipping zone, this is not visible to a customer e.g. North America.
locations object	Locations where the shipping zone applies. Can be left empty for a catch-all zone.
postal_codes string[]	Hashset of postal codes pattern to restrict a shipping zone. e.g. 90210, 10*(will match all postal code starting with 10 e.g. 10123) …
has_automated_rates boolean	Enables live rates by Easyship for this shipping zone if the store is already configured with Easyship
shipping_methods object[]	Built-in shipping methods to create in the shipping zone

locations

Property	Description
country string	ISO 3166-2 country code where the shipping zone applies.
region string	ISO 3166-2 region code where the shipping zone applies. Can be left empty to apply to the whole country..

shipping_methods

Property	Description
id string	System identifier generated by duda native ecommerce. Prefixed with sm_.
type string	Calculation type of the shipping method. This property will dictate the validation rules for the array of `rates`. Can be UNKNOWN, FREE, FLAT_RATE, CART_PRICE_BASED, CART_WEIGHT_BASED.
name object	Display name for the method at checkout.
min_delivery_time_in_days integer	Customer facing information about the estimated minimum delivery time in days for the specific method.
max_delivery_time_in_days integer	Customer facing information about the estimated maximum delivery time in days for the specific method.
rates object[]	Array of rates for the shipping method.

rates

Property	Description
price number	String decimal value of the price the customer must pay for shipping.
min_cart_weight integer	Minimum weight in grams of a cart for the rate to be valid.
max_cart_weight integer	Maximum weight in grams of a cart to have for the rate to be valid (can be left empty for the last rate to catch all carts above a defined weight).
min_cart_value number	Minimum value of the cart's subtotal for the rate to be valid.
max_cart_value number	Maximum value of the cart's subtotal for the rate to be valid.