Ships to
The countries and regions a product is visible and orderable in, and how they are decided.
Overview
ships_to lists the countries and regions your product can be bought in. Products are only visible
to buyers in the countries and regions listed against them.
It is not a field you submit. ships_to is derived: a product ships to exactly the countries and
regions it has an approved price list for. Approve a price for a new country
and the product becomes visible there; there is no separate shipping-areas payload or endpoint to
keep in step.
When to use
Read-only. Sending ships_to in a product payload has no effect — the value is ignored. To change
where a product can be bought, create or archive price lists for the countries concerned.
Format
ships_to is returned on the product and variant detail responses as an array of objects, one per
distinct country/region pair.
| Field | ships_to (response only) |
|---|---|
| Type | Array of objects, each with a country and an optional region |
| Country codes | ISO 3166-1 alpha-2, for example CH for Switzerland |
| Set by | Approved price lists, not the product payload |
What this means in practice
- To open a new market, create a price list with that
country_codeand have it approved. See Price Lists. - To target a region within a country, set
region_codeon the price list. The region must belong to the country given incountry_code. - To withdraw from a market, archive the price lists for that country. Once no approved price
remains, the country drops out of
ships_toand buyers there stop seeing the product. - A product with no approved price ships nowhere. It exists in your catalogue but no buyer can see or order it.
Note
Shipping areas — where a product can be bought — are different from shipping rules, which set what delivery costs. A country needs an approved price before any shipping rule applies to it.