Skip to content
Coritan Docs

Set up regions and shipping

Choose the countries your store sells to and their currency, then set the shipping zones, options and profiles checkout offers.

View as Markdown

Shipping sets where the store sells and how orders reach shoppers there. A shopper can buy only when their country is in a region that is turned on, and an order that ships needs a shipping option that reaches their address.

  • A region groups countries that pay in one currency, with the same tax treatment and ways to pay.
  • A shipping zone is a set of places, such as whole countries or the postcodes of a city, and holds the shipping options offered there.
  • A shipping option is a service shoppers choose at checkout, such as standard or express delivery, with its price.
  • A shipping profile groups products that ship the same way. Checkout asks for one option for each profile in the cart.
  • Every member can read the page. Changing it needs the Admin or Owner role, and the page says it is read-only for anyone else.
  • A region can hold only countries where Coritan sells as merchant of record. The dialog names any country it cannot take.
  • To say where a zone's parcels leave from, create the stock location first in Inventory.
  1. In the dashboard, open the organization, then Commerce, then Shipping.
  2. Under Regions, select New region….
  3. Enter a Name, such as Europe. Your storefront can show it to shoppers choosing their country.
  4. Choose the Currency that carts in the region pay in. A currency the store does not sell in yet is added to the store's currencies when you save.
  5. Under Countries, search by name or code and add each country. Add the 27 EU countries adds the European Union's members at once. A country already in another region shows that region's name and cannot be added.
  6. Tick Prices include tax when the prices shoppers there see already include tax, as is usual in Europe. Otherwise tax is added at checkout.
  7. Under Ways to pay, tick Card, PayPal or both. Card takes cards and wallets through Stripe. PayPal takes only currencies with two decimals.
  8. Tick Make it the default region to start carts that name no country in it. The first region is always the default.
  9. Select Create region.

A store has up to 50 regions, and a country is in one region at most. Test orders can always pay with a test payment, whatever the region allows.

Change, turn off or delete a region

Section titled Change, turn off or delete a region

Each action is in the menu on the region's row, and selecting the row opens Edit region….

Edit region…
Change anything, then select Save region. When you change the currency, carts in the region pay in the new one from then on, and a product with no price in it cannot be bought there. When you take a country out, shoppers there cannot buy until another region takes it.
Make default
Carts that name no country start in it. Turn the region on first.
Turn off…
Select Turn off region to confirm. Shoppers in its countries cannot buy until you select Turn on. Its countries and prices stay as they are.
Delete region…
Type the region's name, then select Delete region. Its countries leave it, so shoppers there cannot buy until another region takes them. Orders placed in it keep their prices.

You cannot turn off or delete the default region. Make another region the default first.

Caution

Deleting a region also deletes the prices set for it in Products, and cannot be undone.

  1. Under Shipping zones, select New zone….
  2. Enter a Name, such as European Union. Only your team sees it; shoppers see the names of its options.
  3. Optionally, choose the stock location that parcels to the zone leave from in Ships from. Orders still take stock from the location that reserved it.
  4. Under Whole countries, add the countries where every address matches.
  5. To cover only part of a country, such as a city for same-day delivery, select Add a part of a country. Choose the Country, then enter the Province or state code, such as ON, the Postcodes starting with, such as 75, 92, 93, 94, or both. An address matches when its postcode starts with one of them.
  6. Select Create zone. The zone's page opens, ready for its options.

A store has up to 200 zones. A zone holds up to 300 places, where each whole country, province and postcode beginning counts as one. When a country in the zone is in no region that is turned on, the dialog says so: add it to a region as well, or shoppers there cannot buy.

Each option belongs to one zone and one shipping profile.

  1. Under Shipping zones, select the zone to open its page.
  2. Select New option….
  3. Enter the Name that shoppers see at checkout and on their order, such as Colissimo.
  4. Choose the Kind:
    • Delivery ships to the address the shopper gives.
    • Pickup means the shopper collects the order from you.
    • Return label prices return shipping for your own returns flow. Checkout never offers it.
  5. Choose the Currency. Only carts in that currency are offered the option, so choose the currency of the regions its countries are in. The dialog warns you when they differ.
  6. Choose the Shipping profile whose products it can ship.
  7. Choose How it is priced and enter the price, as Price an option describes.
  8. Optionally, enter the Lowest order value and Highest order value it is offered for. Both read what the items it ships come to, after discounts.
  9. Optionally, enter the Fastest delivery and Slowest delivery in days, where 0 is the same day, for your storefront to show.
  10. Optionally, change its Position. Checkout lists options by position, lowest first, then by price.
  11. When a fulfilment provider packs these orders, enter the Service code it knows the service by, and choose the provider in Fulfilled by. Fulfilled by shows when the store has a fulfilment provider.
  12. Select Create option.

A store has up to 500 shipping options.

Flat price
The same Price for every order. 0 makes it free.
Flat price, free from an order value
The Price, until the items it ships come to the Free from amount after discounts. From there it is free.
By weight
Tiers of Weighs up to, in kilograms, each with a Price. The parcel costs the price of the first tier it weighs no more than, from the weights set on the products' variants.
By order value
Tiers of Order value up to, each with a Price, read from what the items it ships come to after discounts.

For a tiered price, Add a tier adds a row, and each tier must end above the one before. Only the last tier can be left open, to cover everything above the tier before it. When every tier has an end, the option is not offered above the last one. An option has up to 50 tiers.

Change, turn off or delete a zone or an option

Section titled Change, turn off or delete a zone or an option

A zone's actions are in the menu on its row and on its page, where Edit zone… is at the top.

Edit zone…
Change the name, where it ships from and its places, then select Save zone.
Turn off…
Select Turn off zone to confirm. Checkout stops offering its options, and carts that chose one choose again. Turn on offers them again.
Delete zone…
Type the zone's name, then select Delete zone. Its options go with it, and orders keep the shipping they were charged. This cannot be undone.

An option's actions are in the menu on its row, and selecting the row opens Edit option…, which saves with Save option. Turn off stops checkout offering it at once, and Turn on offers it again. Delete option… asks you to type the option's name, then Delete option deletes it. Carts that chose it choose again, and orders keep the name and price they were charged.

Group products with shipping profiles

Section titled Group products with shipping profiles

Shipping profiles lists the profiles, the options that use each one and the countries its products can reach under Ships to. The store makes its Default profile when you create the first option, and a product that names no profile ships under it. Gift cards need no shipping.

  1. Under Shipping profiles, select New profile….
  2. Enter a Name, such as Oversized and heavy. Shoppers do not see it.
  3. Select Create profile.
  4. Choose the profile on each product that ships this way, under Shipping profile in Products.
  5. Add an option for the profile in each zone those products ship to.

Rename… in a profile's menu changes its name, then Save name saves it. Delete profile… works once no option uses the profile and no product names it. The default profile cannot be deleted. A store has up to 50 profiles.

  • Shoppers in a region's countries can buy in its currency. Checkout offers them the options of every zone that is turned on and matches their address, in the cart's currency, one for each profile in the cart.
  • When a country that a region sells to has no option in the region's currency, a warning at the top of Shipping names it. Shoppers there can buy only what needs no shipping, such as gift cards.
A country cannot be added to a region
It is already in another region, whose name shows next to it, or Coritan does not sell into it yet. Take it out of the other region first.
Shoppers in a country cannot buy
No region that is turned on includes the country. Add it to a region, or turn its region on.
Checkout offers no shipping to an address
No zone that is turned on matches the address with an option in the cart's currency for each profile in the cart. Check the warning at the top of Shipping, and the Ships to column of the profile.
A region shows Test payments only
It takes no live payment, so live orders cannot be paid there. Edit it and tick Card or PayPal.
Shoppers are not offered PayPal
The region's currency does not have two decimals, such as JPY. PayPal takes only currencies with two decimals.
Turn off… or Delete region… cannot be selected
It is the default region. Make another region the default first.
Delete profile… cannot be selected
It is the default profile, or shipping options use it. Delete those options first. If products still name the profile, move them to another profile in Products.
The zone's page says its location is turned off
Parcels cannot leave from a location that is turned off. Edit the zone and choose another location in Ships from.

Regions are under https://api.coritan.com/api/v1/orgs/{org_slug}/commerce/regions, and shipping under /commerce/shipping-zones, /commerce/shipping-options and /commerce/shipping-profiles. Add regions and Set up shipping have the details.

Shell
curl "https://api.coritan.com/api/v1/orgs/acme/commerce/shipping-zones" \
  -H "Authorization: Bearer $CORITAN_TOKEN"