Pickup and Zones

Sometimes you want a rate to only show up for certain areas. Sometimes this is a set of countries or states, other times it is a set of zip codes or post codes around your store.

NOTE: Zip Codes should be entered as 5 digits with no space, like this: 90210 and Post Codes should be entered with one space in between, like this: K2J 0G3

Pickup

If you want to setup a pickup zone around your store you simply create a zone with a radius of postal codes.

"Flat": {
    "enabled": true,
    "services": [
        {
            "code": "PICKUP",
            "total_price": 0,
            "zone": {
                "postal_code": [
                    "90028",
                    "90038",
                    "90004"
                ]
            }
        }
    ]
}

This will show the pickup rate only if the destination zip code (or post code) is included in the postal_code list.

If you need to find a set of US zip codes and UK post codes in a radius, a great website can be found here.

States/Provinces

If you would like to limit to a set of states/provinces, you can add their 2 letter abbreviation to the zone. To make things easier the provice and state lists are combined so use which ever feels more natural.

"Flat": {
    "enabled": true,
    "services": [
        {
            "code": "SUPER_SHIP",
            "total_price": 500,
            "zone": {
                "country": ["ALL"],
                "province": [
                    "ON", "QC"
                ],
                "state": [
                    "WI", "MI"
                ]
            }
        }
    ]
}

In the above example, this fictional carrier only delivers to the states of Wisconsin and Michigan in the USA and to the provinces of Ontario and Quebec in Canada. It would make no difference if all of them were under states or all were under province.

Countries

Last but not least, you can limit the countries. The default is always "ORIGIN" which covers all countries for which the rate is valid. Flat rates by default are domestic only, so adding "country": "ALL" will make it international. The country can be specified as a 2 digit ISO code or the country name.

"Flat": {
    "enabled": true,
    "services": [
        {
            "code": "SUPER_SHIP",
            "total_price": 500,
            "zone": {
                "country": ["CA", "United States of America", "Northern Ireland"]
            }
        }
    ]
}

The names can get more accurate for example "GB" is the ISO code for "United Kingdom" which includes "Northern Ireland" and "Great Britain". The valid names are:

"ALL",
"ORIGIN",
"Andorra",
"United Arab Emirates",
"Afghanistan",
"Antigua",
"Barbuda",
"Anguilla",
"Albania",
"Armenia",
"Angola",
"Argentina",
"American Samoa",
"Austria",
"Australia",
"Aruba",
"Aland Islands",
"Azerbaijan",
"Bosnia and Herzegovina",
"Barbados",
"Bangladesh",
"Belgium",
"Burkina Faso",
"Bulgaria",
"Bahrain",
"Burundi",
"Benin",
"Saint Barthelemy",
"Bermuda",
"Brunei Darussalam",
"Bolivia",
"Bonaire",
"Saba",
"Sint Eustatius",
"Brazil",
"Bahamas",
"Bhutan",
"Botswana",
"Belarus",
"Belize",
"Canada",
"Cocos Islands",
"The Democratic Republic of Congo",
"Central African Republic",
"Congo",
"Switzerland",
"Ivory Coast",
"Cook Islands",
"Chile",
"Cameroon",
"People's Republic of China",
"Colombia",
"Costa Rica",
"Cape Verde Islands",
"Curacao",
"Christmas Island",
"Cyprus",
"Czech Republic",
"Germany",
"Djibouti",
"Denmark",
"Dominica",
"Dominican Republic",
"Algeria",
"Ecuador",
"Estonia",
"Egypt",
"Eritrea",
"Spain",
"Ethiopia",
"Finland",
"Fiji",
"Falkland Islands",
"Micronesia",
"Faroe Islands",
"France",
"Gabon",
"Great Britain",
"Northern Ireland",
"United Kingdom",
"Grenada",
"Republic of Georgia",
"French Guiana",
"Guernsey",
"Ghana",
"Gibraltar",
"Greenland",
"Gambia",
"Guinea",
"Guadeloupe",
"Equatorial Guinea",
"Greece",
"South Georgia",
"the South Sandwich Islands",
"Guatemala",
"Guam",
"Guinea-Bissau",
"Guyana",
"Hong Kong",
"Honduras",
"Croatia",
"Haiti",
"Hungary",
"Canary Islands",
"Indonesia",
"Ireland",
"Israel",
"Isle of Man",
"India",
"Iraq",
"Iceland",
"Italy",
"Jersey",
"Jamaica",
"Jordan",
"Japan",
"Kenya",
"Kyrgyzstan",
"Cambodia",
"Kiribati",
"Comoros",
"Nevis",
"Saint Kitts",
"South Korea",
"Kuwait",
"Cayman Islands",
"Kazakhstan",
"Laos",
"Lebanon",
"Saint Lucia",
"Liechtenstein",
"Sri Lanka",
"Liberia",
"Lesotho",
"Lithuania",
"Luxembourg",
"Latvia",
"Libya",
"Morocco",
"Monaco",
"Moldova",
"Montenegro",
"Saint Martin",
"Madagascar",
"Marshall Islands",
"Republic of Macedonia",
"Mali",
"Myanmar",
"Mongolia",
"Macao",
"Northern Mariana Islands",
"Martinique",
"Mauritania",
"Montserrat",
"Malta",
"Mauritius",
"Maldives",
"Malawi",
"Mexico",
"Malaysia",
"Mozambique",
"Namibia",
"New Caledonia",
"Niger",
"Norfolk Island",
"Nigeria",
"Nicaragua",
"Netherlands",
"Norway",
"Nepal",
"Nauru",
"Niue",
"New Zealand",
"Oman",
"Panama",
"Peru",
"French Polynesia",
"Tahiti",
"Papua New Guinea",
"Philippines",
"Pakistan",
"Poland",
"Miquelon",
"Saint Pierre",
"Pitcairn Island",
"Puerto Rico",
"Palestinian Territory",
"Portugal",
"Palau",
"Paraguay",
"Qatar",
"Reunion",
"Romania",
"Serbia",
"Russia",
"Rwanda",
"Saudi Arabia",
"Solomon Islands",
"Seychelles",
"Sweden",
"Singapore",
"Saint Helena",
"Tristan da Cunha",
"Slovenia",
"Slovakia",
"Sierra Leone",
"San Marino",
"Senegal",
"Suriname",
"Sao Tome and Principe",
"El Salvador",
"Sint Maarten",
"Syria",
"Swaziland",
"Caicos Islands",
"Turks",
"Chad",
"Togo",
"Thailand",
"Tajikistan",
"Tokelau",
"Timor-Leste",
"Turkmenistan",
"Tunisia",
"Tonga",
"Turkey",
"Trinidad",
"Tobago",
"Tuvalu",
"Taiwan",
"Tanzania",
"Ukraine",
"Uganda",
"United States Minor Outlying Islands",
"United States of America",
"Uruguay",
"Uzbekistan",
"Vatican City",
"Grenadines",
"Saint Vincent",
"Venezuela",
"British Virgin Islands",
"United States Virgin Islands",
"Vietnam",
"Vanuatu",
"Futuna Islands",
"Wallis",
"Samoa",
"Kosovo",
"Yemen",
"Mayotte",
"South Africa",
"Zambia",
"Zimbabwe"