Country Code
The code designating a country/region, which generally follows ISO 3166-1 alpha-2 guidelines.
If a territory doesn't have a country code value in the enum, then it might be considered a subdivision
of another country. For example, the territories associated with Spain are represented by the country code ,
and the territories associated with the United States of America are represented by the country code .
Anchor to Valid valuesValid values
- AC
- AD
- AE
- AF
- AG
- AI
- AL
- AM
- AN
- AO
- AR
- AT
- AU
- AW
- AX
- AZ
- BA
- BB
- BD
- BE
- BF
- BG
- BH
- BI
- BJ
- BL
- BM
- BN
- BO
- BQ
- BR
- BS
- BT
- BV
- BW
- BY
- BZ
- CA
- CC
- CD
- CF
- CG
- CH
- CI
- CK
- CL
- CM
- CN
- CO
- CR
- CU
- CV
- CW
- CX
- CY
- CZ
- DE
- DJ
- DK
- DM
- DO
- DZ
- EC
- EE
- EG
- EH
- ER
- ES
- ET
- FI
- FJ
- FK
- FO
- FR
- GA
- GB
- GD
- GE
- GF
- GG
- GH
- GI
- GL
- GM
- GN
- GP
- GQ
- GR
- GS
- GT
- GW
- GY
- HK
- HM
- HN
- HR
- HT
- HU
- ID
- IE
- IL
- IM
- IN
- IO
- IQ
- IR
- IS
- IT
- JE
- JM
- JO
- JP
- KE
- KG
- KH
- KI
- KM
- KN
- KP
- KR
- KW
- KY
- KZ
- LA
- LB
- LC
- LI
- LK
- LR
- LS
- LT
- LU
- LV
- LY
- MA
- MC
- MD
- ME
- MF
- MG
- MK
- ML
- MM
- MN
- MO
- MQ
- MR
- MS
- MT
- MU
- MV
- MW
- MX
- MY
- MZ
- NA
- NC
- NE
- NF
- NG
- NI
- NL
- NO
- NP
- NR
- NU
- NZ
- OM
- PA
- PE
- PF
- PG
- PH
- PK
- PL
- PM
- PN
- PS
- PT
- PY
- QA
- RE
- RO
- RS
- RU
- RW
- SA
- SB
- SC
- SD
- SE
- SG
- SH
- SI
- SJ
- SK
- SL
- SM
- SN
- SO
- SR
- SS
- ST
- SV
- SX
- SY
- SZ
- TA
- TC
- TD
- TF
- TG
- TH
- TJ
- TK
- TL
- TM
- TN
- TO
- TR
- TT
- TV
- TW
- TZ
- UA
- UG
- UM
- US
- UY
- UZ
- VA
- VC
- VE
- VG
- VN
- VU
- WF
- WS
- XK
- YE
- YT
- ZA
- ZM
- ZW
- ZZ
Ascension Island.
Andorra.
United Arab Emirates.
Afghanistan.
Antigua & Barbuda.
Anguilla.
Albania.
Armenia.
Netherlands Antilles.
Angola.
Argentina.
Austria.
Australia.
Aruba.
Ã…land Islands.
Azerbaijan.
Bosnia & Herzegovina.
Barbados.
Bangladesh.
Belgium.
Burkina Faso.
Bulgaria.
Bahrain.
Burundi.
Benin.
St. Barthélemy.
Bermuda.
Brunei.
Bolivia.
Caribbean Netherlands.
Brazil.
Bahamas.
Bhutan.
Bouvet Island.
Botswana.
Belarus.
Belize.
Canada.
Cocos (Keeling) Islands.
Congo - Kinshasa.
Central African Republic.
Congo - Brazzaville.
Switzerland.
Côte d’Ivoire.
Cook Islands.
Chile.
Cameroon.
China.
Colombia.
Costa Rica.
Cuba.
Cape Verde.
Curaçao.
Christmas Island.
Cyprus.
Czechia.
Germany.
Djibouti.
Denmark.
Dominica.
Dominican Republic.
Algeria.
Ecuador.
Estonia.
Egypt.
Western Sahara.
Eritrea.
Spain.
Ethiopia.
Finland.
Fiji.
Falkland Islands.
Faroe Islands.
France.
Gabon.
United Kingdom.
Grenada.
Georgia.
French Guiana.
Guernsey.
Ghana.
Gibraltar.
Greenland.
Gambia.
Guinea.
Guadeloupe.
Equatorial Guinea.
Greece.
South Georgia & South Sandwich Islands.
Guatemala.
Guinea-Bissau.
Guyana.
Hong Kong SAR.
Heard & McDonald Islands.
Honduras.
Croatia.
Haiti.
Hungary.
Indonesia.
Ireland.
Israel.
Isle of Man.
India.
British Indian Ocean Territory.
Iraq.
Iran.
Iceland.
Italy.
Jersey.
Jamaica.
Jordan.
Japan.
Kenya.
Kyrgyzstan.
Cambodia.
Kiribati.
Comoros.
St. Kitts & Nevis.
North Korea.
South Korea.
Kuwait.
Cayman Islands.
Kazakhstan.
Laos.
Lebanon.
St. Lucia.
Liechtenstein.
Sri Lanka.
Liberia.
Lesotho.
Lithuania.
Luxembourg.
Latvia.
Libya.
Morocco.
Monaco.
Moldova.
Montenegro.
St. Martin.
Madagascar.
North Macedonia.
Mali.
Myanmar (Burma).
Mongolia.
Macao SAR.
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.
Papua New Guinea.
Philippines.
Pakistan.
Poland.
St. Pierre & Miquelon.
Pitcairn Islands.
Palestinian Territories.
Portugal.
Paraguay.
Qatar.
Réunion.
Romania.
Serbia.
Russia.
Rwanda.
Saudi Arabia.
Solomon Islands.
Seychelles.
Sudan.
Sweden.
Singapore.
St. Helena.
Slovenia.
Svalbard & Jan Mayen.
Slovakia.
Sierra Leone.
San Marino.
Senegal.
Somalia.
Suriname.
South Sudan.
São Tomé & PrÃncipe.
El Salvador.
Sint Maarten.
Syria.
Eswatini.
Tristan da Cunha.
Turks & Caicos Islands.
Chad.
French Southern Territories.
Togo.
Thailand.
Tajikistan.
Tokelau.
Timor-Leste.
Turkmenistan.
Tunisia.
Tonga.
Türkiye.
Trinidad & Tobago.
Tuvalu.
Taiwan.
Tanzania.
Ukraine.
Uganda.
U.S. Outlying Islands.
United States.
Uruguay.
Uzbekistan.
Vatican City.
St. Vincent & Grenadines.
Venezuela.
British Virgin Islands.
Vietnam.
Vanuatu.
Wallis & Futuna.
Samoa.
Kosovo.
Yemen.
Mayotte.
South Africa.
Zambia.
Zimbabwe.
Unknown Region.
Anchor to FieldsFields
- •OBJECT
Contact information about the buyer interacting with a cart. The buyer's country determines international pricing and should match their shipping address.
For B2B scenarios, the
field identifies the company and location on whose behalf a business customer purchases. Thepreferencesfield stores delivery and wallet settings that prefill checkout fields to streamline the buying process.- •INPUT OBJECT
The input fields for identifying the buyer associated with a cart. Buyer identity determines international pricing and should match the customer's shipping address.
Used by
andto set contact information, location, and checkout preferences.NotePreferences prefill fields at checkout but don't sync back to the cart if overwritten.
Note:Preferences prefill fields at checkout but don't sync back to the cart if overwritten.
Note: Preferences prefill fields at checkout but don't sync back to the cart if overwritten.
- •INPUT OBJECT
The input fields to create or update a cart address.
- Anchor to CartDeliveryCoordinatesPreference.countryCodeCart•OBJECT
Delivery Coordinates Preference.countryCode Preferred location used to find the closest pick up point based on coordinates.
- Anchor to CartDeliveryCoordinatesPreferenceInput.countryCodeCart•INPUT OBJECT
Delivery Coordinates Preference Input.countryCode Preferred location used to find the closest pick up point based on coordinates.
- •OBJECT
A country.
- •OBJECT
A physical mailing address associated with a
CustomerorOrder. Stores standard address components including street address, city, province, country, and postal code, along with customer name and company information.The address includes geographic coordinates and provides pre-formatted output through the
formattedfield, which can optionally include or exclude name and company details.- •OBJECT
Settings related to payments.
- •OBJECT
Shop represents a collection of the general settings and information about the shop.