mirror of
https://gh.wpcy.net/https://github.com/woocommerce/woocommerce-rest-api-docs.git
synced 2026-04-24 04:42:50 +08:00
1885 lines
54 KiB
Markdown
1885 lines
54 KiB
Markdown
# Setting options #
|
|
|
|
## Setting option properties ##
|
|
|
|
| Attribute | Type | Description |
|
|
|---------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| `id` | string | A unique identifier for the setting. <i class="label label-info">read-only</i> |
|
|
| `label` | string | A human readable label for the setting used in interfaces. <i class="label label-info">read-only</i> |
|
|
| `description` | string | A human readable description for the setting used in interfaces. <i class="label label-info">read-only</i> |
|
|
| `value` | mixed | Setting value. |
|
|
| `default` | mixed | Default value for the setting. <i class="label label-info">read-only</i> |
|
|
| `tip` | string | Additional help text shown to the user about the setting. <i class="label label-info">read-only</i> |
|
|
| `placeholder` | string | Placeholder text to be displayed in text inputs. <i class="label label-info">read-only</i> |
|
|
| `type` | string | Type of setting. Options: `text`, `email`, `number`, `color`, `password`, `textarea`, `select`, `multiselect`, `radio`, `image_width` and `checkbox`. <i class="label label-info">read-only</i> |
|
|
| `options` | object | Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons. <i class="label label-info">read-only</i> |
|
|
| `group_id` | string | An identifier for the group this setting belongs to. <i class="label label-info">read-only</i> |
|
|
|
|
## Retrieve a setting option ##
|
|
|
|
This API lets you retrieve and view a specific setting option.
|
|
|
|
### HTTP request ###
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wp-json/wc/v3/settings/<group_id>/<id></h6>
|
|
</div>
|
|
</div>
|
|
|
|
```shell
|
|
curl https://example.com/wp-json/wc/v3/settings/general/woocommerce_allowed_countries \
|
|
-u consumer_key:consumer_secret
|
|
```
|
|
|
|
```javascript
|
|
WooCommerce.get("settings/general/woocommerce_allowed_countries")
|
|
.then((response) => {
|
|
console.log(response.data);
|
|
})
|
|
.catch((error) => {
|
|
console.log(error.response.data);
|
|
});
|
|
```
|
|
|
|
```php
|
|
<?php print_r($woocommerce->get('settings/general/woocommerce_allowed_countries')); ?>
|
|
```
|
|
|
|
```python
|
|
print(wcapi.get("settings/general/woocommerce_allowed_countries").json())
|
|
```
|
|
|
|
```ruby
|
|
woocommerce.get("settings/general/woocommerce_allowed_countries").parsed_response
|
|
```
|
|
|
|
> JSON response example:
|
|
|
|
```json
|
|
{
|
|
"id": "woocommerce_allowed_countries",
|
|
"label": "Selling location(s)",
|
|
"description": "This option lets you limit which countries you are willing to sell to.",
|
|
"type": "select",
|
|
"default": "all",
|
|
"options": {
|
|
"all": "Sell to all countries",
|
|
"all_except": "Sell to all countries, except for…",
|
|
"specific": "Sell to specific countries"
|
|
},
|
|
"tip": "This option lets you limit which countries you are willing to sell to.",
|
|
"value": "all",
|
|
"group_id": "general",
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_allowed_countries"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
## List all setting options ##
|
|
|
|
This API helps you to view all the setting options.
|
|
|
|
### HTTP request ###
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-get">GET</i>
|
|
<h6>/wp-json/wc/v3/settings/<id></h6>
|
|
</div>
|
|
</div>
|
|
|
|
```shell
|
|
curl https://example.com/wp-json/wc/v3/settings/general \
|
|
-u consumer_key:consumer_secret
|
|
```
|
|
|
|
```javascript
|
|
WooCommerce.get("settings/general")
|
|
.then((response) => {
|
|
console.log(response.data);
|
|
})
|
|
.catch((error) => {
|
|
console.log(error.response.data);
|
|
});
|
|
```
|
|
|
|
```php
|
|
<?php print_r($woocommerce->get('settings/general')); ?>
|
|
```
|
|
|
|
```python
|
|
print(wcapi.get("settings/general").json())
|
|
```
|
|
|
|
```ruby
|
|
woocommerce.get("settings/general").parsed_response
|
|
```
|
|
|
|
> JSON response example:
|
|
|
|
```json
|
|
[
|
|
{
|
|
"id": "woocommerce_allowed_countries",
|
|
"label": "Selling location(s)",
|
|
"description": "This option lets you limit which countries you are willing to sell to.",
|
|
"type": "select",
|
|
"default": "all",
|
|
"options": {
|
|
"all": "Sell to all countries",
|
|
"all_except": "Sell to all countries, except for…",
|
|
"specific": "Sell to specific countries"
|
|
},
|
|
"tip": "This option lets you limit which countries you are willing to sell to.",
|
|
"value": "all",
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_allowed_countries"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": "woocommerce_all_except_countries",
|
|
"label": "Sell to all countries, except for…",
|
|
"description": "",
|
|
"type": "multiselect",
|
|
"default": "",
|
|
"value": "",
|
|
"options": {
|
|
"AX": "Åland Islands",
|
|
"AF": "Afghanistan",
|
|
"AL": "Albania",
|
|
"DZ": "Algeria",
|
|
"AS": "American Samoa",
|
|
"AD": "Andorra",
|
|
"AO": "Angola",
|
|
"AI": "Anguilla",
|
|
"AQ": "Antarctica",
|
|
"AG": "Antigua and Barbuda",
|
|
"AR": "Argentina",
|
|
"AM": "Armenia",
|
|
"AW": "Aruba",
|
|
"AU": "Australia",
|
|
"AT": "Austria",
|
|
"AZ": "Azerbaijan",
|
|
"BS": "Bahamas",
|
|
"BH": "Bahrain",
|
|
"BD": "Bangladesh",
|
|
"BB": "Barbados",
|
|
"BY": "Belarus",
|
|
"PW": "Belau",
|
|
"BE": "Belgium",
|
|
"BZ": "Belize",
|
|
"BJ": "Benin",
|
|
"BM": "Bermuda",
|
|
"BT": "Bhutan",
|
|
"BO": "Bolivia",
|
|
"BQ": "Bonaire, Saint Eustatius and Saba",
|
|
"BA": "Bosnia and Herzegovina",
|
|
"BW": "Botswana",
|
|
"BV": "Bouvet Island",
|
|
"BR": "Brazil",
|
|
"IO": "British Indian Ocean Territory",
|
|
"VG": "British Virgin Islands",
|
|
"BN": "Brunei",
|
|
"BG": "Bulgaria",
|
|
"BF": "Burkina Faso",
|
|
"BI": "Burundi",
|
|
"KH": "Cambodia",
|
|
"CM": "Cameroon",
|
|
"CA": "Canada",
|
|
"CV": "Cape Verde",
|
|
"KY": "Cayman Islands",
|
|
"CF": "Central African Republic",
|
|
"TD": "Chad",
|
|
"CL": "Chile",
|
|
"CN": "China",
|
|
"CX": "Christmas Island",
|
|
"CC": "Cocos (Keeling) Islands",
|
|
"CO": "Colombia",
|
|
"KM": "Comoros",
|
|
"CG": "Congo (Brazzaville)",
|
|
"CD": "Congo (Kinshasa)",
|
|
"CK": "Cook Islands",
|
|
"CR": "Costa Rica",
|
|
"HR": "Croatia",
|
|
"CU": "Cuba",
|
|
"CW": "Curaçao",
|
|
"CY": "Cyprus",
|
|
"CZ": "Czech Republic",
|
|
"DK": "Denmark",
|
|
"DJ": "Djibouti",
|
|
"DM": "Dominica",
|
|
"DO": "Dominican Republic",
|
|
"EC": "Ecuador",
|
|
"EG": "Egypt",
|
|
"SV": "El Salvador",
|
|
"GQ": "Equatorial Guinea",
|
|
"ER": "Eritrea",
|
|
"EE": "Estonia",
|
|
"ET": "Ethiopia",
|
|
"FK": "Falkland Islands",
|
|
"FO": "Faroe Islands",
|
|
"FJ": "Fiji",
|
|
"FI": "Finland",
|
|
"FR": "France",
|
|
"GF": "French Guiana",
|
|
"PF": "French Polynesia",
|
|
"TF": "French Southern Territories",
|
|
"GA": "Gabon",
|
|
"GM": "Gambia",
|
|
"GE": "Georgia",
|
|
"DE": "Germany",
|
|
"GH": "Ghana",
|
|
"GI": "Gibraltar",
|
|
"GR": "Greece",
|
|
"GL": "Greenland",
|
|
"GD": "Grenada",
|
|
"GP": "Guadeloupe",
|
|
"GU": "Guam",
|
|
"GT": "Guatemala",
|
|
"GG": "Guernsey",
|
|
"GN": "Guinea",
|
|
"GW": "Guinea-Bissau",
|
|
"GY": "Guyana",
|
|
"HT": "Haiti",
|
|
"HM": "Heard Island and McDonald Islands",
|
|
"HN": "Honduras",
|
|
"HK": "Hong Kong",
|
|
"HU": "Hungary",
|
|
"IS": "Iceland",
|
|
"IN": "India",
|
|
"ID": "Indonesia",
|
|
"IR": "Iran",
|
|
"IQ": "Iraq",
|
|
"IE": "Ireland",
|
|
"IM": "Isle of Man",
|
|
"IL": "Israel",
|
|
"IT": "Italy",
|
|
"CI": "Ivory Coast",
|
|
"JM": "Jamaica",
|
|
"JP": "Japan",
|
|
"JE": "Jersey",
|
|
"JO": "Jordan",
|
|
"KZ": "Kazakhstan",
|
|
"KE": "Kenya",
|
|
"KI": "Kiribati",
|
|
"KW": "Kuwait",
|
|
"KG": "Kyrgyzstan",
|
|
"LA": "Laos",
|
|
"LV": "Latvia",
|
|
"LB": "Lebanon",
|
|
"LS": "Lesotho",
|
|
"LR": "Liberia",
|
|
"LY": "Libya",
|
|
"LI": "Liechtenstein",
|
|
"LT": "Lithuania",
|
|
"LU": "Luxembourg",
|
|
"MO": "Macao S.A.R., China",
|
|
"MK": "Macedonia",
|
|
"MG": "Madagascar",
|
|
"MW": "Malawi",
|
|
"MY": "Malaysia",
|
|
"MV": "Maldives",
|
|
"ML": "Mali",
|
|
"MT": "Malta",
|
|
"MH": "Marshall Islands",
|
|
"MQ": "Martinique",
|
|
"MR": "Mauritania",
|
|
"MU": "Mauritius",
|
|
"YT": "Mayotte",
|
|
"MX": "Mexico",
|
|
"FM": "Micronesia",
|
|
"MD": "Moldova",
|
|
"MC": "Monaco",
|
|
"MN": "Mongolia",
|
|
"ME": "Montenegro",
|
|
"MS": "Montserrat",
|
|
"MA": "Morocco",
|
|
"MZ": "Mozambique",
|
|
"MM": "Myanmar",
|
|
"NA": "Namibia",
|
|
"NR": "Nauru",
|
|
"NP": "Nepal",
|
|
"NL": "Netherlands",
|
|
"NC": "New Caledonia",
|
|
"NZ": "New Zealand",
|
|
"NI": "Nicaragua",
|
|
"NE": "Niger",
|
|
"NG": "Nigeria",
|
|
"NU": "Niue",
|
|
"NF": "Norfolk Island",
|
|
"KP": "North Korea",
|
|
"MP": "Northern Mariana Islands",
|
|
"NO": "Norway",
|
|
"OM": "Oman",
|
|
"PK": "Pakistan",
|
|
"PS": "Palestinian Territory",
|
|
"PA": "Panama",
|
|
"PG": "Papua New Guinea",
|
|
"PY": "Paraguay",
|
|
"PE": "Peru",
|
|
"PH": "Philippines",
|
|
"PN": "Pitcairn",
|
|
"PL": "Poland",
|
|
"PT": "Portugal",
|
|
"PR": "Puerto Rico",
|
|
"QA": "Qatar",
|
|
"RE": "Reunion",
|
|
"RO": "Romania",
|
|
"RU": "Russia",
|
|
"RW": "Rwanda",
|
|
"ST": "São Tomé and Príncipe",
|
|
"BL": "Saint Barthélemy",
|
|
"SH": "Saint Helena",
|
|
"KN": "Saint Kitts and Nevis",
|
|
"LC": "Saint Lucia",
|
|
"SX": "Saint Martin (Dutch part)",
|
|
"MF": "Saint Martin (French part)",
|
|
"PM": "Saint Pierre and Miquelon",
|
|
"VC": "Saint Vincent and the Grenadines",
|
|
"WS": "Samoa",
|
|
"SM": "San Marino",
|
|
"SA": "Saudi Arabia",
|
|
"SN": "Senegal",
|
|
"RS": "Serbia",
|
|
"SC": "Seychelles",
|
|
"SL": "Sierra Leone",
|
|
"SG": "Singapore",
|
|
"SK": "Slovakia",
|
|
"SI": "Slovenia",
|
|
"SB": "Solomon Islands",
|
|
"SO": "Somalia",
|
|
"ZA": "South Africa",
|
|
"GS": "South Georgia/Sandwich Islands",
|
|
"KR": "South Korea",
|
|
"SS": "South Sudan",
|
|
"ES": "Spain",
|
|
"LK": "Sri Lanka",
|
|
"SD": "Sudan",
|
|
"SR": "Suriname",
|
|
"SJ": "Svalbard and Jan Mayen",
|
|
"SZ": "Swaziland",
|
|
"SE": "Sweden",
|
|
"CH": "Switzerland",
|
|
"SY": "Syria",
|
|
"TW": "Taiwan",
|
|
"TJ": "Tajikistan",
|
|
"TZ": "Tanzania",
|
|
"TH": "Thailand",
|
|
"TL": "Timor-Leste",
|
|
"TG": "Togo",
|
|
"TK": "Tokelau",
|
|
"TO": "Tonga",
|
|
"TT": "Trinidad and Tobago",
|
|
"TN": "Tunisia",
|
|
"TR": "Turkey",
|
|
"TM": "Turkmenistan",
|
|
"TC": "Turks and Caicos Islands",
|
|
"TV": "Tuvalu",
|
|
"UG": "Uganda",
|
|
"UA": "Ukraine",
|
|
"AE": "United Arab Emirates",
|
|
"GB": "United Kingdom (UK)",
|
|
"US": "United States (US)",
|
|
"UM": "United States (US) Minor Outlying Islands",
|
|
"VI": "United States (US) Virgin Islands",
|
|
"UY": "Uruguay",
|
|
"UZ": "Uzbekistan",
|
|
"VU": "Vanuatu",
|
|
"VA": "Vatican",
|
|
"VE": "Venezuela",
|
|
"VN": "Vietnam",
|
|
"WF": "Wallis and Futuna",
|
|
"EH": "Western Sahara",
|
|
"YE": "Yemen",
|
|
"ZM": "Zambia",
|
|
"ZW": "Zimbabwe"
|
|
},
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_all_except_countries"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": "woocommerce_specific_allowed_countries",
|
|
"label": "Sell to specific countries",
|
|
"description": "",
|
|
"type": "multiselect",
|
|
"default": "",
|
|
"value": "",
|
|
"options": {
|
|
"AX": "Åland Islands",
|
|
"AF": "Afghanistan",
|
|
"AL": "Albania",
|
|
"DZ": "Algeria",
|
|
"AS": "American Samoa",
|
|
"AD": "Andorra",
|
|
"AO": "Angola",
|
|
"AI": "Anguilla",
|
|
"AQ": "Antarctica",
|
|
"AG": "Antigua and Barbuda",
|
|
"AR": "Argentina",
|
|
"AM": "Armenia",
|
|
"AW": "Aruba",
|
|
"AU": "Australia",
|
|
"AT": "Austria",
|
|
"AZ": "Azerbaijan",
|
|
"BS": "Bahamas",
|
|
"BH": "Bahrain",
|
|
"BD": "Bangladesh",
|
|
"BB": "Barbados",
|
|
"BY": "Belarus",
|
|
"PW": "Belau",
|
|
"BE": "Belgium",
|
|
"BZ": "Belize",
|
|
"BJ": "Benin",
|
|
"BM": "Bermuda",
|
|
"BT": "Bhutan",
|
|
"BO": "Bolivia",
|
|
"BQ": "Bonaire, Saint Eustatius and Saba",
|
|
"BA": "Bosnia and Herzegovina",
|
|
"BW": "Botswana",
|
|
"BV": "Bouvet Island",
|
|
"BR": "Brazil",
|
|
"IO": "British Indian Ocean Territory",
|
|
"VG": "British Virgin Islands",
|
|
"BN": "Brunei",
|
|
"BG": "Bulgaria",
|
|
"BF": "Burkina Faso",
|
|
"BI": "Burundi",
|
|
"KH": "Cambodia",
|
|
"CM": "Cameroon",
|
|
"CA": "Canada",
|
|
"CV": "Cape Verde",
|
|
"KY": "Cayman Islands",
|
|
"CF": "Central African Republic",
|
|
"TD": "Chad",
|
|
"CL": "Chile",
|
|
"CN": "China",
|
|
"CX": "Christmas Island",
|
|
"CC": "Cocos (Keeling) Islands",
|
|
"CO": "Colombia",
|
|
"KM": "Comoros",
|
|
"CG": "Congo (Brazzaville)",
|
|
"CD": "Congo (Kinshasa)",
|
|
"CK": "Cook Islands",
|
|
"CR": "Costa Rica",
|
|
"HR": "Croatia",
|
|
"CU": "Cuba",
|
|
"CW": "Curaçao",
|
|
"CY": "Cyprus",
|
|
"CZ": "Czech Republic",
|
|
"DK": "Denmark",
|
|
"DJ": "Djibouti",
|
|
"DM": "Dominica",
|
|
"DO": "Dominican Republic",
|
|
"EC": "Ecuador",
|
|
"EG": "Egypt",
|
|
"SV": "El Salvador",
|
|
"GQ": "Equatorial Guinea",
|
|
"ER": "Eritrea",
|
|
"EE": "Estonia",
|
|
"ET": "Ethiopia",
|
|
"FK": "Falkland Islands",
|
|
"FO": "Faroe Islands",
|
|
"FJ": "Fiji",
|
|
"FI": "Finland",
|
|
"FR": "France",
|
|
"GF": "French Guiana",
|
|
"PF": "French Polynesia",
|
|
"TF": "French Southern Territories",
|
|
"GA": "Gabon",
|
|
"GM": "Gambia",
|
|
"GE": "Georgia",
|
|
"DE": "Germany",
|
|
"GH": "Ghana",
|
|
"GI": "Gibraltar",
|
|
"GR": "Greece",
|
|
"GL": "Greenland",
|
|
"GD": "Grenada",
|
|
"GP": "Guadeloupe",
|
|
"GU": "Guam",
|
|
"GT": "Guatemala",
|
|
"GG": "Guernsey",
|
|
"GN": "Guinea",
|
|
"GW": "Guinea-Bissau",
|
|
"GY": "Guyana",
|
|
"HT": "Haiti",
|
|
"HM": "Heard Island and McDonald Islands",
|
|
"HN": "Honduras",
|
|
"HK": "Hong Kong",
|
|
"HU": "Hungary",
|
|
"IS": "Iceland",
|
|
"IN": "India",
|
|
"ID": "Indonesia",
|
|
"IR": "Iran",
|
|
"IQ": "Iraq",
|
|
"IE": "Ireland",
|
|
"IM": "Isle of Man",
|
|
"IL": "Israel",
|
|
"IT": "Italy",
|
|
"CI": "Ivory Coast",
|
|
"JM": "Jamaica",
|
|
"JP": "Japan",
|
|
"JE": "Jersey",
|
|
"JO": "Jordan",
|
|
"KZ": "Kazakhstan",
|
|
"KE": "Kenya",
|
|
"KI": "Kiribati",
|
|
"KW": "Kuwait",
|
|
"KG": "Kyrgyzstan",
|
|
"LA": "Laos",
|
|
"LV": "Latvia",
|
|
"LB": "Lebanon",
|
|
"LS": "Lesotho",
|
|
"LR": "Liberia",
|
|
"LY": "Libya",
|
|
"LI": "Liechtenstein",
|
|
"LT": "Lithuania",
|
|
"LU": "Luxembourg",
|
|
"MO": "Macao S.A.R., China",
|
|
"MK": "Macedonia",
|
|
"MG": "Madagascar",
|
|
"MW": "Malawi",
|
|
"MY": "Malaysia",
|
|
"MV": "Maldives",
|
|
"ML": "Mali",
|
|
"MT": "Malta",
|
|
"MH": "Marshall Islands",
|
|
"MQ": "Martinique",
|
|
"MR": "Mauritania",
|
|
"MU": "Mauritius",
|
|
"YT": "Mayotte",
|
|
"MX": "Mexico",
|
|
"FM": "Micronesia",
|
|
"MD": "Moldova",
|
|
"MC": "Monaco",
|
|
"MN": "Mongolia",
|
|
"ME": "Montenegro",
|
|
"MS": "Montserrat",
|
|
"MA": "Morocco",
|
|
"MZ": "Mozambique",
|
|
"MM": "Myanmar",
|
|
"NA": "Namibia",
|
|
"NR": "Nauru",
|
|
"NP": "Nepal",
|
|
"NL": "Netherlands",
|
|
"NC": "New Caledonia",
|
|
"NZ": "New Zealand",
|
|
"NI": "Nicaragua",
|
|
"NE": "Niger",
|
|
"NG": "Nigeria",
|
|
"NU": "Niue",
|
|
"NF": "Norfolk Island",
|
|
"KP": "North Korea",
|
|
"MP": "Northern Mariana Islands",
|
|
"NO": "Norway",
|
|
"OM": "Oman",
|
|
"PK": "Pakistan",
|
|
"PS": "Palestinian Territory",
|
|
"PA": "Panama",
|
|
"PG": "Papua New Guinea",
|
|
"PY": "Paraguay",
|
|
"PE": "Peru",
|
|
"PH": "Philippines",
|
|
"PN": "Pitcairn",
|
|
"PL": "Poland",
|
|
"PT": "Portugal",
|
|
"PR": "Puerto Rico",
|
|
"QA": "Qatar",
|
|
"RE": "Reunion",
|
|
"RO": "Romania",
|
|
"RU": "Russia",
|
|
"RW": "Rwanda",
|
|
"ST": "São Tomé and Príncipe",
|
|
"BL": "Saint Barthélemy",
|
|
"SH": "Saint Helena",
|
|
"KN": "Saint Kitts and Nevis",
|
|
"LC": "Saint Lucia",
|
|
"SX": "Saint Martin (Dutch part)",
|
|
"MF": "Saint Martin (French part)",
|
|
"PM": "Saint Pierre and Miquelon",
|
|
"VC": "Saint Vincent and the Grenadines",
|
|
"WS": "Samoa",
|
|
"SM": "San Marino",
|
|
"SA": "Saudi Arabia",
|
|
"SN": "Senegal",
|
|
"RS": "Serbia",
|
|
"SC": "Seychelles",
|
|
"SL": "Sierra Leone",
|
|
"SG": "Singapore",
|
|
"SK": "Slovakia",
|
|
"SI": "Slovenia",
|
|
"SB": "Solomon Islands",
|
|
"SO": "Somalia",
|
|
"ZA": "South Africa",
|
|
"GS": "South Georgia/Sandwich Islands",
|
|
"KR": "South Korea",
|
|
"SS": "South Sudan",
|
|
"ES": "Spain",
|
|
"LK": "Sri Lanka",
|
|
"SD": "Sudan",
|
|
"SR": "Suriname",
|
|
"SJ": "Svalbard and Jan Mayen",
|
|
"SZ": "Swaziland",
|
|
"SE": "Sweden",
|
|
"CH": "Switzerland",
|
|
"SY": "Syria",
|
|
"TW": "Taiwan",
|
|
"TJ": "Tajikistan",
|
|
"TZ": "Tanzania",
|
|
"TH": "Thailand",
|
|
"TL": "Timor-Leste",
|
|
"TG": "Togo",
|
|
"TK": "Tokelau",
|
|
"TO": "Tonga",
|
|
"TT": "Trinidad and Tobago",
|
|
"TN": "Tunisia",
|
|
"TR": "Turkey",
|
|
"TM": "Turkmenistan",
|
|
"TC": "Turks and Caicos Islands",
|
|
"TV": "Tuvalu",
|
|
"UG": "Uganda",
|
|
"UA": "Ukraine",
|
|
"AE": "United Arab Emirates",
|
|
"GB": "United Kingdom (UK)",
|
|
"US": "United States (US)",
|
|
"UM": "United States (US) Minor Outlying Islands",
|
|
"VI": "United States (US) Virgin Islands",
|
|
"UY": "Uruguay",
|
|
"UZ": "Uzbekistan",
|
|
"VU": "Vanuatu",
|
|
"VA": "Vatican",
|
|
"VE": "Venezuela",
|
|
"VN": "Vietnam",
|
|
"WF": "Wallis and Futuna",
|
|
"EH": "Western Sahara",
|
|
"YE": "Yemen",
|
|
"ZM": "Zambia",
|
|
"ZW": "Zimbabwe"
|
|
},
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_specific_allowed_countries"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": "woocommerce_ship_to_countries",
|
|
"label": "Shipping location(s)",
|
|
"description": "Choose which countries you want to ship to, or choose to ship to all locations you sell to.",
|
|
"type": "select",
|
|
"default": "",
|
|
"options": {
|
|
"": "Ship to all countries you sell to",
|
|
"all": "Ship to all countries",
|
|
"specific": "Ship to specific countries only",
|
|
"disabled": "Disable shipping & shipping calculations"
|
|
},
|
|
"tip": "Choose which countries you want to ship to, or choose to ship to all locations you sell to.",
|
|
"value": "",
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_ship_to_countries"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": "woocommerce_specific_ship_to_countries",
|
|
"label": "Ship to specific countries",
|
|
"description": "",
|
|
"type": "multiselect",
|
|
"default": "",
|
|
"value": "",
|
|
"options": {
|
|
"AX": "Åland Islands",
|
|
"AF": "Afghanistan",
|
|
"AL": "Albania",
|
|
"DZ": "Algeria",
|
|
"AS": "American Samoa",
|
|
"AD": "Andorra",
|
|
"AO": "Angola",
|
|
"AI": "Anguilla",
|
|
"AQ": "Antarctica",
|
|
"AG": "Antigua and Barbuda",
|
|
"AR": "Argentina",
|
|
"AM": "Armenia",
|
|
"AW": "Aruba",
|
|
"AU": "Australia",
|
|
"AT": "Austria",
|
|
"AZ": "Azerbaijan",
|
|
"BS": "Bahamas",
|
|
"BH": "Bahrain",
|
|
"BD": "Bangladesh",
|
|
"BB": "Barbados",
|
|
"BY": "Belarus",
|
|
"PW": "Belau",
|
|
"BE": "Belgium",
|
|
"BZ": "Belize",
|
|
"BJ": "Benin",
|
|
"BM": "Bermuda",
|
|
"BT": "Bhutan",
|
|
"BO": "Bolivia",
|
|
"BQ": "Bonaire, Saint Eustatius and Saba",
|
|
"BA": "Bosnia and Herzegovina",
|
|
"BW": "Botswana",
|
|
"BV": "Bouvet Island",
|
|
"BR": "Brazil",
|
|
"IO": "British Indian Ocean Territory",
|
|
"VG": "British Virgin Islands",
|
|
"BN": "Brunei",
|
|
"BG": "Bulgaria",
|
|
"BF": "Burkina Faso",
|
|
"BI": "Burundi",
|
|
"KH": "Cambodia",
|
|
"CM": "Cameroon",
|
|
"CA": "Canada",
|
|
"CV": "Cape Verde",
|
|
"KY": "Cayman Islands",
|
|
"CF": "Central African Republic",
|
|
"TD": "Chad",
|
|
"CL": "Chile",
|
|
"CN": "China",
|
|
"CX": "Christmas Island",
|
|
"CC": "Cocos (Keeling) Islands",
|
|
"CO": "Colombia",
|
|
"KM": "Comoros",
|
|
"CG": "Congo (Brazzaville)",
|
|
"CD": "Congo (Kinshasa)",
|
|
"CK": "Cook Islands",
|
|
"CR": "Costa Rica",
|
|
"HR": "Croatia",
|
|
"CU": "Cuba",
|
|
"CW": "Curaçao",
|
|
"CY": "Cyprus",
|
|
"CZ": "Czech Republic",
|
|
"DK": "Denmark",
|
|
"DJ": "Djibouti",
|
|
"DM": "Dominica",
|
|
"DO": "Dominican Republic",
|
|
"EC": "Ecuador",
|
|
"EG": "Egypt",
|
|
"SV": "El Salvador",
|
|
"GQ": "Equatorial Guinea",
|
|
"ER": "Eritrea",
|
|
"EE": "Estonia",
|
|
"ET": "Ethiopia",
|
|
"FK": "Falkland Islands",
|
|
"FO": "Faroe Islands",
|
|
"FJ": "Fiji",
|
|
"FI": "Finland",
|
|
"FR": "France",
|
|
"GF": "French Guiana",
|
|
"PF": "French Polynesia",
|
|
"TF": "French Southern Territories",
|
|
"GA": "Gabon",
|
|
"GM": "Gambia",
|
|
"GE": "Georgia",
|
|
"DE": "Germany",
|
|
"GH": "Ghana",
|
|
"GI": "Gibraltar",
|
|
"GR": "Greece",
|
|
"GL": "Greenland",
|
|
"GD": "Grenada",
|
|
"GP": "Guadeloupe",
|
|
"GU": "Guam",
|
|
"GT": "Guatemala",
|
|
"GG": "Guernsey",
|
|
"GN": "Guinea",
|
|
"GW": "Guinea-Bissau",
|
|
"GY": "Guyana",
|
|
"HT": "Haiti",
|
|
"HM": "Heard Island and McDonald Islands",
|
|
"HN": "Honduras",
|
|
"HK": "Hong Kong",
|
|
"HU": "Hungary",
|
|
"IS": "Iceland",
|
|
"IN": "India",
|
|
"ID": "Indonesia",
|
|
"IR": "Iran",
|
|
"IQ": "Iraq",
|
|
"IE": "Ireland",
|
|
"IM": "Isle of Man",
|
|
"IL": "Israel",
|
|
"IT": "Italy",
|
|
"CI": "Ivory Coast",
|
|
"JM": "Jamaica",
|
|
"JP": "Japan",
|
|
"JE": "Jersey",
|
|
"JO": "Jordan",
|
|
"KZ": "Kazakhstan",
|
|
"KE": "Kenya",
|
|
"KI": "Kiribati",
|
|
"KW": "Kuwait",
|
|
"KG": "Kyrgyzstan",
|
|
"LA": "Laos",
|
|
"LV": "Latvia",
|
|
"LB": "Lebanon",
|
|
"LS": "Lesotho",
|
|
"LR": "Liberia",
|
|
"LY": "Libya",
|
|
"LI": "Liechtenstein",
|
|
"LT": "Lithuania",
|
|
"LU": "Luxembourg",
|
|
"MO": "Macao S.A.R., China",
|
|
"MK": "Macedonia",
|
|
"MG": "Madagascar",
|
|
"MW": "Malawi",
|
|
"MY": "Malaysia",
|
|
"MV": "Maldives",
|
|
"ML": "Mali",
|
|
"MT": "Malta",
|
|
"MH": "Marshall Islands",
|
|
"MQ": "Martinique",
|
|
"MR": "Mauritania",
|
|
"MU": "Mauritius",
|
|
"YT": "Mayotte",
|
|
"MX": "Mexico",
|
|
"FM": "Micronesia",
|
|
"MD": "Moldova",
|
|
"MC": "Monaco",
|
|
"MN": "Mongolia",
|
|
"ME": "Montenegro",
|
|
"MS": "Montserrat",
|
|
"MA": "Morocco",
|
|
"MZ": "Mozambique",
|
|
"MM": "Myanmar",
|
|
"NA": "Namibia",
|
|
"NR": "Nauru",
|
|
"NP": "Nepal",
|
|
"NL": "Netherlands",
|
|
"NC": "New Caledonia",
|
|
"NZ": "New Zealand",
|
|
"NI": "Nicaragua",
|
|
"NE": "Niger",
|
|
"NG": "Nigeria",
|
|
"NU": "Niue",
|
|
"NF": "Norfolk Island",
|
|
"KP": "North Korea",
|
|
"MP": "Northern Mariana Islands",
|
|
"NO": "Norway",
|
|
"OM": "Oman",
|
|
"PK": "Pakistan",
|
|
"PS": "Palestinian Territory",
|
|
"PA": "Panama",
|
|
"PG": "Papua New Guinea",
|
|
"PY": "Paraguay",
|
|
"PE": "Peru",
|
|
"PH": "Philippines",
|
|
"PN": "Pitcairn",
|
|
"PL": "Poland",
|
|
"PT": "Portugal",
|
|
"PR": "Puerto Rico",
|
|
"QA": "Qatar",
|
|
"RE": "Reunion",
|
|
"RO": "Romania",
|
|
"RU": "Russia",
|
|
"RW": "Rwanda",
|
|
"ST": "São Tomé and Príncipe",
|
|
"BL": "Saint Barthélemy",
|
|
"SH": "Saint Helena",
|
|
"KN": "Saint Kitts and Nevis",
|
|
"LC": "Saint Lucia",
|
|
"SX": "Saint Martin (Dutch part)",
|
|
"MF": "Saint Martin (French part)",
|
|
"PM": "Saint Pierre and Miquelon",
|
|
"VC": "Saint Vincent and the Grenadines",
|
|
"WS": "Samoa",
|
|
"SM": "San Marino",
|
|
"SA": "Saudi Arabia",
|
|
"SN": "Senegal",
|
|
"RS": "Serbia",
|
|
"SC": "Seychelles",
|
|
"SL": "Sierra Leone",
|
|
"SG": "Singapore",
|
|
"SK": "Slovakia",
|
|
"SI": "Slovenia",
|
|
"SB": "Solomon Islands",
|
|
"SO": "Somalia",
|
|
"ZA": "South Africa",
|
|
"GS": "South Georgia/Sandwich Islands",
|
|
"KR": "South Korea",
|
|
"SS": "South Sudan",
|
|
"ES": "Spain",
|
|
"LK": "Sri Lanka",
|
|
"SD": "Sudan",
|
|
"SR": "Suriname",
|
|
"SJ": "Svalbard and Jan Mayen",
|
|
"SZ": "Swaziland",
|
|
"SE": "Sweden",
|
|
"CH": "Switzerland",
|
|
"SY": "Syria",
|
|
"TW": "Taiwan",
|
|
"TJ": "Tajikistan",
|
|
"TZ": "Tanzania",
|
|
"TH": "Thailand",
|
|
"TL": "Timor-Leste",
|
|
"TG": "Togo",
|
|
"TK": "Tokelau",
|
|
"TO": "Tonga",
|
|
"TT": "Trinidad and Tobago",
|
|
"TN": "Tunisia",
|
|
"TR": "Turkey",
|
|
"TM": "Turkmenistan",
|
|
"TC": "Turks and Caicos Islands",
|
|
"TV": "Tuvalu",
|
|
"UG": "Uganda",
|
|
"UA": "Ukraine",
|
|
"AE": "United Arab Emirates",
|
|
"GB": "United Kingdom (UK)",
|
|
"US": "United States (US)",
|
|
"UM": "United States (US) Minor Outlying Islands",
|
|
"VI": "United States (US) Virgin Islands",
|
|
"UY": "Uruguay",
|
|
"UZ": "Uzbekistan",
|
|
"VU": "Vanuatu",
|
|
"VA": "Vatican",
|
|
"VE": "Venezuela",
|
|
"VN": "Vietnam",
|
|
"WF": "Wallis and Futuna",
|
|
"EH": "Western Sahara",
|
|
"YE": "Yemen",
|
|
"ZM": "Zambia",
|
|
"ZW": "Zimbabwe"
|
|
},
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_specific_ship_to_countries"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": "woocommerce_default_customer_address",
|
|
"label": "Default customer location",
|
|
"description": "",
|
|
"type": "select",
|
|
"default": "geolocation",
|
|
"options": {
|
|
"": "No location by default",
|
|
"base": "Shop base address",
|
|
"geolocation": "Geolocate",
|
|
"geolocation_ajax": "Geolocate (with page caching support)"
|
|
},
|
|
"tip": "This option determines a customers default location. The MaxMind GeoLite Database will be periodically downloaded to your wp-content directory if using geolocation.",
|
|
"value": "geolocation",
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_default_customer_address"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": "woocommerce_calc_taxes",
|
|
"label": "Enable taxes",
|
|
"description": "Enable taxes and tax calculations",
|
|
"type": "checkbox",
|
|
"default": "no",
|
|
"value": "yes",
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_calc_taxes"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": "woocommerce_demo_store",
|
|
"label": "Store notice",
|
|
"description": "Enable site-wide store notice text",
|
|
"type": "checkbox",
|
|
"default": "no",
|
|
"value": "no",
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_demo_store"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": "woocommerce_demo_store_notice",
|
|
"label": "Store notice text",
|
|
"description": "",
|
|
"type": "textarea",
|
|
"default": "This is a demo store for testing purposes — no orders shall be fulfilled.",
|
|
"value": "This is a demo store for testing purposes — no orders shall be fulfilled.",
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_demo_store_notice"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": "woocommerce_currency",
|
|
"label": "Currency",
|
|
"description": "This controls what currency prices are listed at in the catalog and which currency gateways will take payments in.",
|
|
"type": "select",
|
|
"default": "GBP",
|
|
"options": {
|
|
"AED": "United Arab Emirates dirham (د.إ)",
|
|
"AFN": "Afghan afghani (؋)",
|
|
"ALL": "Albanian lek (L)",
|
|
"AMD": "Armenian dram (AMD)",
|
|
"ANG": "Netherlands Antillean guilder (ƒ)",
|
|
"AOA": "Angolan kwanza (Kz)",
|
|
"ARS": "Argentine peso ($)",
|
|
"AUD": "Australian dollar ($)",
|
|
"AWG": "Aruban florin (ƒ)",
|
|
"AZN": "Azerbaijani manat (AZN)",
|
|
"BAM": "Bosnia and Herzegovina convertible mark (KM)",
|
|
"BBD": "Barbadian dollar ($)",
|
|
"BDT": "Bangladeshi taka (৳ )",
|
|
"BGN": "Bulgarian lev (лв.)",
|
|
"BHD": "Bahraini dinar (.د.ب)",
|
|
"BIF": "Burundian franc (Fr)",
|
|
"BMD": "Bermudian dollar ($)",
|
|
"BND": "Brunei dollar ($)",
|
|
"BOB": "Bolivian boliviano (Bs.)",
|
|
"BRL": "Brazilian real (R$)",
|
|
"BSD": "Bahamian dollar ($)",
|
|
"BTC": "Bitcoin (฿)",
|
|
"BTN": "Bhutanese ngultrum (Nu.)",
|
|
"BWP": "Botswana pula (P)",
|
|
"BYR": "Belarusian ruble (Br)",
|
|
"BZD": "Belize dollar ($)",
|
|
"CAD": "Canadian dollar ($)",
|
|
"CDF": "Congolese franc (Fr)",
|
|
"CHF": "Swiss franc (CHF)",
|
|
"CLP": "Chilean peso ($)",
|
|
"CNY": "Chinese yuan (¥)",
|
|
"COP": "Colombian peso ($)",
|
|
"CRC": "Costa Rican colón (₡)",
|
|
"CUC": "Cuban convertible peso ($)",
|
|
"CUP": "Cuban peso ($)",
|
|
"CVE": "Cape Verdean escudo ($)",
|
|
"CZK": "Czech koruna (Kč)",
|
|
"DJF": "Djiboutian franc (Fr)",
|
|
"DKK": "Danish krone (DKK)",
|
|
"DOP": "Dominican peso (RD$)",
|
|
"DZD": "Algerian dinar (د.ج)",
|
|
"EGP": "Egyptian pound (EGP)",
|
|
"ERN": "Eritrean nakfa (Nfk)",
|
|
"ETB": "Ethiopian birr (Br)",
|
|
"EUR": "Euro (€)",
|
|
"FJD": "Fijian dollar ($)",
|
|
"FKP": "Falkland Islands pound (£)",
|
|
"GBP": "Pound sterling (£)",
|
|
"GEL": "Georgian lari (ლ)",
|
|
"GGP": "Guernsey pound (£)",
|
|
"GHS": "Ghana cedi (₵)",
|
|
"GIP": "Gibraltar pound (£)",
|
|
"GMD": "Gambian dalasi (D)",
|
|
"GNF": "Guinean franc (Fr)",
|
|
"GTQ": "Guatemalan quetzal (Q)",
|
|
"GYD": "Guyanese dollar ($)",
|
|
"HKD": "Hong Kong dollar ($)",
|
|
"HNL": "Honduran lempira (L)",
|
|
"HRK": "Croatian kuna (Kn)",
|
|
"HTG": "Haitian gourde (G)",
|
|
"HUF": "Hungarian forint (Ft)",
|
|
"IDR": "Indonesian rupiah (Rp)",
|
|
"ILS": "Israeli new shekel (₪)",
|
|
"IMP": "Manx pound (£)",
|
|
"INR": "Indian rupee (₹)",
|
|
"IQD": "Iraqi dinar (ع.د)",
|
|
"IRR": "Iranian rial (﷼)",
|
|
"IRT": "Iranian toman (تومان)",
|
|
"ISK": "Icelandic króna (kr.)",
|
|
"JEP": "Jersey pound (£)",
|
|
"JMD": "Jamaican dollar ($)",
|
|
"JOD": "Jordanian dinar (د.ا)",
|
|
"JPY": "Japanese yen (¥)",
|
|
"KES": "Kenyan shilling (KSh)",
|
|
"KGS": "Kyrgyzstani som (сом)",
|
|
"KHR": "Cambodian riel (៛)",
|
|
"KMF": "Comorian franc (Fr)",
|
|
"KPW": "North Korean won (₩)",
|
|
"KRW": "South Korean won (₩)",
|
|
"KWD": "Kuwaiti dinar (د.ك)",
|
|
"KYD": "Cayman Islands dollar ($)",
|
|
"KZT": "Kazakhstani tenge (KZT)",
|
|
"LAK": "Lao kip (₭)",
|
|
"LBP": "Lebanese pound (ل.ل)",
|
|
"LKR": "Sri Lankan rupee (රු)",
|
|
"LRD": "Liberian dollar ($)",
|
|
"LSL": "Lesotho loti (L)",
|
|
"LYD": "Libyan dinar (ل.د)",
|
|
"MAD": "Moroccan dirham (د.م.)",
|
|
"MDL": "Moldovan leu (MDL)",
|
|
"MGA": "Malagasy ariary (Ar)",
|
|
"MKD": "Macedonian denar (ден)",
|
|
"MMK": "Burmese kyat (Ks)",
|
|
"MNT": "Mongolian tögrög (₮)",
|
|
"MOP": "Macanese pataca (P)",
|
|
"MRO": "Mauritanian ouguiya (UM)",
|
|
"MUR": "Mauritian rupee (₨)",
|
|
"MVR": "Maldivian rufiyaa (.ރ)",
|
|
"MWK": "Malawian kwacha (MK)",
|
|
"MXN": "Mexican peso ($)",
|
|
"MYR": "Malaysian ringgit (RM)",
|
|
"MZN": "Mozambican metical (MT)",
|
|
"NAD": "Namibian dollar ($)",
|
|
"NGN": "Nigerian naira (₦)",
|
|
"NIO": "Nicaraguan córdoba (C$)",
|
|
"NOK": "Norwegian krone (kr)",
|
|
"NPR": "Nepalese rupee (₨)",
|
|
"NZD": "New Zealand dollar ($)",
|
|
"OMR": "Omani rial (ر.ع.)",
|
|
"PAB": "Panamanian balboa (B/.)",
|
|
"PEN": "Peruvian nuevo sol (S/.)",
|
|
"PGK": "Papua New Guinean kina (K)",
|
|
"PHP": "Philippine peso (₱)",
|
|
"PKR": "Pakistani rupee (₨)",
|
|
"PLN": "Polish złoty (zł)",
|
|
"PRB": "Transnistrian ruble (р.)",
|
|
"PYG": "Paraguayan guaraní (₲)",
|
|
"QAR": "Qatari riyal (ر.ق)",
|
|
"RON": "Romanian leu (lei)",
|
|
"RSD": "Serbian dinar (дин.)",
|
|
"RUB": "Russian ruble (₽)",
|
|
"RWF": "Rwandan franc (Fr)",
|
|
"SAR": "Saudi riyal (ر.س)",
|
|
"SBD": "Solomon Islands dollar ($)",
|
|
"SCR": "Seychellois rupee (₨)",
|
|
"SDG": "Sudanese pound (ج.س.)",
|
|
"SEK": "Swedish krona (kr)",
|
|
"SGD": "Singapore dollar ($)",
|
|
"SHP": "Saint Helena pound (£)",
|
|
"SLL": "Sierra Leonean leone (Le)",
|
|
"SOS": "Somali shilling (Sh)",
|
|
"SRD": "Surinamese dollar ($)",
|
|
"SSP": "South Sudanese pound (£)",
|
|
"STD": "São Tomé and Príncipe dobra (Db)",
|
|
"SYP": "Syrian pound (ل.س)",
|
|
"SZL": "Swazi lilangeni (L)",
|
|
"THB": "Thai baht (฿)",
|
|
"TJS": "Tajikistani somoni (ЅМ)",
|
|
"TMT": "Turkmenistan manat (m)",
|
|
"TND": "Tunisian dinar (د.ت)",
|
|
"TOP": "Tongan paʻanga (T$)",
|
|
"TRY": "Turkish lira (₺)",
|
|
"TTD": "Trinidad and Tobago dollar ($)",
|
|
"TWD": "New Taiwan dollar (NT$)",
|
|
"TZS": "Tanzanian shilling (Sh)",
|
|
"UAH": "Ukrainian hryvnia (₴)",
|
|
"UGX": "Ugandan shilling (UGX)",
|
|
"USD": "United States dollar ($)",
|
|
"UYU": "Uruguayan peso ($)",
|
|
"UZS": "Uzbekistani som (UZS)",
|
|
"VEF": "Venezuelan bolívar (Bs F)",
|
|
"VND": "Vietnamese đồng (₫)",
|
|
"VUV": "Vanuatu vatu (Vt)",
|
|
"WST": "Samoan tālā (T)",
|
|
"XAF": "Central African CFA franc (Fr)",
|
|
"XCD": "East Caribbean dollar ($)",
|
|
"XOF": "West African CFA franc (Fr)",
|
|
"XPF": "CFP franc (Fr)",
|
|
"YER": "Yemeni rial (﷼)",
|
|
"ZAR": "South African rand (R)",
|
|
"ZMW": "Zambian kwacha (ZK)"
|
|
},
|
|
"tip": "This controls what currency prices are listed at in the catalog and which currency gateways will take payments in.",
|
|
"value": "USD",
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_currency"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": "woocommerce_currency_pos",
|
|
"label": "Currency position",
|
|
"description": "This controls the position of the currency symbol.",
|
|
"type": "select",
|
|
"default": "left",
|
|
"options": {
|
|
"left": "Left ($99.99)",
|
|
"right": "Right (99.99$)",
|
|
"left_space": "Left with space ($ 99.99)",
|
|
"right_space": "Right with space (99.99 $)"
|
|
},
|
|
"tip": "This controls the position of the currency symbol.",
|
|
"value": "left",
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_currency_pos"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": "woocommerce_price_thousand_sep",
|
|
"label": "Thousand separator",
|
|
"description": "This sets the thousand separator of displayed prices.",
|
|
"type": "text",
|
|
"default": ",",
|
|
"tip": "This sets the thousand separator of displayed prices.",
|
|
"value": ",",
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_price_thousand_sep"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": "woocommerce_price_decimal_sep",
|
|
"label": "Decimal separator",
|
|
"description": "This sets the decimal separator of displayed prices.",
|
|
"type": "text",
|
|
"default": ".",
|
|
"tip": "This sets the decimal separator of displayed prices.",
|
|
"value": ".",
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_price_decimal_sep"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": "woocommerce_price_num_decimals",
|
|
"label": "Number of decimals",
|
|
"description": "This sets the number of decimal points shown in displayed prices.",
|
|
"type": "number",
|
|
"default": "2",
|
|
"tip": "This sets the number of decimal points shown in displayed prices.",
|
|
"value": "2",
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_price_num_decimals"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
```
|
|
|
|
## Update a setting option ##
|
|
|
|
This API lets you make changes to a setting option.
|
|
|
|
### HTTP request ###
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-put">PUT</i>
|
|
<h6>/wp-json/wc/v3/settings/<group_id>/<id></h6>
|
|
</div>
|
|
</div>
|
|
|
|
```shell
|
|
curl -X PUT https://example.com/wp-json/wc/v3/settings/general/woocommerce_allowed_countries \
|
|
-u consumer_key:consumer_secret \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"value": "all_except"
|
|
}'
|
|
```
|
|
|
|
```javascript
|
|
const data = {
|
|
value: "all_except"
|
|
};
|
|
|
|
WooCommerce.put("settings/general/woocommerce_allowed_countries", data)
|
|
.then((response) => {
|
|
console.log(response.data);
|
|
})
|
|
.catch((error) => {
|
|
console.log(error.response.data);
|
|
});
|
|
```
|
|
|
|
```php
|
|
<?php
|
|
$data = [
|
|
'value' => 'all_except'
|
|
];
|
|
|
|
print_r($woocommerce->put('settings/general/woocommerce_allowed_countries', $data));
|
|
?>
|
|
```
|
|
|
|
```python
|
|
data = {
|
|
"value": "all_except"
|
|
}
|
|
|
|
print(wcapi.put("settings/general/woocommerce_allowed_countries", data).json())
|
|
```
|
|
|
|
```ruby
|
|
data = {
|
|
value: "all_except"
|
|
}
|
|
|
|
woocommerce.put("settings/general/woocommerce_allowed_countries", data).parsed_response
|
|
```
|
|
|
|
> JSON response example:
|
|
|
|
```json
|
|
{
|
|
"id": "woocommerce_allowed_countries",
|
|
"label": "Selling location(s)",
|
|
"description": "This option lets you limit which countries you are willing to sell to.",
|
|
"type": "select",
|
|
"default": "all",
|
|
"options": {
|
|
"all": "Sell to all countries",
|
|
"all_except": "Sell to all countries, except for…",
|
|
"specific": "Sell to specific countries"
|
|
},
|
|
"tip": "This option lets you limit which countries you are willing to sell to.",
|
|
"value": "all_except",
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_allowed_countries"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
## Batch update setting options ##
|
|
|
|
This API helps you to batch update multiple setting options.
|
|
|
|
<aside class="notice">
|
|
Note: By default it's limited to up to 100 objects to be created, updated or deleted.
|
|
</aside>
|
|
|
|
### HTTP request ###
|
|
|
|
<div class="api-endpoint">
|
|
<div class="endpoint-data">
|
|
<i class="label label-post">POST</i>
|
|
<h6>/wp-json/wc/v3/settings/<id>/batch</h6>
|
|
</div>
|
|
</div>
|
|
|
|
```shell
|
|
curl -X POST https://example.com/wp-json/wc/v3/settings/general/batch \
|
|
-u consumer_key:consumer_secret \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"update": [
|
|
{
|
|
"id": "woocommerce_allowed_countries",
|
|
"value": "all"
|
|
},
|
|
{
|
|
"id": "woocommerce_demo_store",
|
|
"value": "yes"
|
|
},
|
|
{
|
|
"id": "woocommerce_currency",
|
|
"value": "GBP"
|
|
}
|
|
]
|
|
}'
|
|
```
|
|
|
|
```javascript
|
|
const data = {
|
|
create: [
|
|
{
|
|
regular_price: "10.00",
|
|
attributes: [
|
|
{
|
|
id: 6,
|
|
option: "Blue"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
regular_price: "10.00",
|
|
attributes: [
|
|
{
|
|
id: 6,
|
|
option: "White"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
update: [
|
|
{
|
|
id: 733,
|
|
regular_price: "10.00"
|
|
}
|
|
],
|
|
delete: [
|
|
732
|
|
]
|
|
};
|
|
|
|
WooCommerce.post("products/22/settings/general/batch", data)
|
|
.then((response) => {
|
|
console.log(response.data);
|
|
})
|
|
.catch((error) => {
|
|
console.log(error.response.data);
|
|
});
|
|
```
|
|
|
|
```php
|
|
<?php
|
|
$data = [
|
|
'create' => [
|
|
[
|
|
'regular_price' => '10.00',
|
|
'attributes' => [
|
|
[
|
|
'id' => 6,
|
|
'option' => 'Blue'
|
|
]
|
|
]
|
|
],
|
|
[
|
|
'regular_price' => '10.00',
|
|
'attributes' => [
|
|
[
|
|
'id' => 6,
|
|
'option' => 'White'
|
|
]
|
|
]
|
|
]
|
|
],
|
|
'update' => [
|
|
[
|
|
'id' => 733,
|
|
'regular_price' => '10.00'
|
|
]
|
|
],
|
|
'delete' => [
|
|
732
|
|
]
|
|
];
|
|
|
|
print_r($woocommerce->post('products/22/settings/general/batch', $data));
|
|
?>
|
|
```
|
|
|
|
```python
|
|
data = {
|
|
"create": [
|
|
{
|
|
"regular_price": "10.00",
|
|
"attributes": [
|
|
{
|
|
"id": 6,
|
|
"option": "Blue"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"regular_price": "10.00",
|
|
"attributes": [
|
|
{
|
|
"id": 6,
|
|
"option": "White"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"update": [
|
|
{
|
|
"id": 733,
|
|
"regular_price": "10.00"
|
|
}
|
|
],
|
|
"delete": [
|
|
732
|
|
]
|
|
}
|
|
|
|
print(wcapi.post("products/22/settings/general/batch", data).json())
|
|
```
|
|
|
|
```ruby
|
|
data = {
|
|
create: [
|
|
{
|
|
regular_price: "10.00",
|
|
attributes: [
|
|
{
|
|
id: 6,
|
|
option: "Blue"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
regular_price: "10.00",
|
|
attributes: [
|
|
{
|
|
id: 6,
|
|
option: "White"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
update: [
|
|
{
|
|
id: 733,
|
|
regular_price: "10.00"
|
|
}
|
|
],
|
|
delete: [
|
|
732
|
|
]
|
|
}
|
|
|
|
woocommerce.post("products/22/settings/general/batch", data).parsed_response
|
|
```
|
|
|
|
> JSON response example:
|
|
|
|
```json
|
|
{
|
|
"update": [
|
|
{
|
|
"id": "woocommerce_allowed_countries",
|
|
"label": "Selling location(s)",
|
|
"description": "This option lets you limit which countries you are willing to sell to.",
|
|
"type": "select",
|
|
"default": "all",
|
|
"options": {
|
|
"all": "Sell to all countries",
|
|
"all_except": "Sell to all countries, except for…",
|
|
"specific": "Sell to specific countries"
|
|
},
|
|
"tip": "This option lets you limit which countries you are willing to sell to.",
|
|
"value": "all",
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_allowed_countries"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": "woocommerce_demo_store",
|
|
"label": "Store notice",
|
|
"description": "Enable site-wide store notice text",
|
|
"type": "checkbox",
|
|
"default": "no",
|
|
"value": "yes",
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_demo_store"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": "woocommerce_currency",
|
|
"label": "Currency",
|
|
"description": "This controls what currency prices are listed at in the catalog and which currency gateways will take payments in.",
|
|
"type": "select",
|
|
"default": "GBP",
|
|
"options": {
|
|
"AED": "United Arab Emirates dirham (د.إ)",
|
|
"AFN": "Afghan afghani (؋)",
|
|
"ALL": "Albanian lek (L)",
|
|
"AMD": "Armenian dram (AMD)",
|
|
"ANG": "Netherlands Antillean guilder (ƒ)",
|
|
"AOA": "Angolan kwanza (Kz)",
|
|
"ARS": "Argentine peso ($)",
|
|
"AUD": "Australian dollar ($)",
|
|
"AWG": "Aruban florin (ƒ)",
|
|
"AZN": "Azerbaijani manat (AZN)",
|
|
"BAM": "Bosnia and Herzegovina convertible mark (KM)",
|
|
"BBD": "Barbadian dollar ($)",
|
|
"BDT": "Bangladeshi taka (৳ )",
|
|
"BGN": "Bulgarian lev (лв.)",
|
|
"BHD": "Bahraini dinar (.د.ب)",
|
|
"BIF": "Burundian franc (Fr)",
|
|
"BMD": "Bermudian dollar ($)",
|
|
"BND": "Brunei dollar ($)",
|
|
"BOB": "Bolivian boliviano (Bs.)",
|
|
"BRL": "Brazilian real (R$)",
|
|
"BSD": "Bahamian dollar ($)",
|
|
"BTC": "Bitcoin (฿)",
|
|
"BTN": "Bhutanese ngultrum (Nu.)",
|
|
"BWP": "Botswana pula (P)",
|
|
"BYR": "Belarusian ruble (Br)",
|
|
"BZD": "Belize dollar ($)",
|
|
"CAD": "Canadian dollar ($)",
|
|
"CDF": "Congolese franc (Fr)",
|
|
"CHF": "Swiss franc (CHF)",
|
|
"CLP": "Chilean peso ($)",
|
|
"CNY": "Chinese yuan (¥)",
|
|
"COP": "Colombian peso ($)",
|
|
"CRC": "Costa Rican colón (₡)",
|
|
"CUC": "Cuban convertible peso ($)",
|
|
"CUP": "Cuban peso ($)",
|
|
"CVE": "Cape Verdean escudo ($)",
|
|
"CZK": "Czech koruna (Kč)",
|
|
"DJF": "Djiboutian franc (Fr)",
|
|
"DKK": "Danish krone (DKK)",
|
|
"DOP": "Dominican peso (RD$)",
|
|
"DZD": "Algerian dinar (د.ج)",
|
|
"EGP": "Egyptian pound (EGP)",
|
|
"ERN": "Eritrean nakfa (Nfk)",
|
|
"ETB": "Ethiopian birr (Br)",
|
|
"EUR": "Euro (€)",
|
|
"FJD": "Fijian dollar ($)",
|
|
"FKP": "Falkland Islands pound (£)",
|
|
"GBP": "Pound sterling (£)",
|
|
"GEL": "Georgian lari (ლ)",
|
|
"GGP": "Guernsey pound (£)",
|
|
"GHS": "Ghana cedi (₵)",
|
|
"GIP": "Gibraltar pound (£)",
|
|
"GMD": "Gambian dalasi (D)",
|
|
"GNF": "Guinean franc (Fr)",
|
|
"GTQ": "Guatemalan quetzal (Q)",
|
|
"GYD": "Guyanese dollar ($)",
|
|
"HKD": "Hong Kong dollar ($)",
|
|
"HNL": "Honduran lempira (L)",
|
|
"HRK": "Croatian kuna (Kn)",
|
|
"HTG": "Haitian gourde (G)",
|
|
"HUF": "Hungarian forint (Ft)",
|
|
"IDR": "Indonesian rupiah (Rp)",
|
|
"ILS": "Israeli new shekel (₪)",
|
|
"IMP": "Manx pound (£)",
|
|
"INR": "Indian rupee (₹)",
|
|
"IQD": "Iraqi dinar (ع.د)",
|
|
"IRR": "Iranian rial (﷼)",
|
|
"IRT": "Iranian toman (تومان)",
|
|
"ISK": "Icelandic króna (kr.)",
|
|
"JEP": "Jersey pound (£)",
|
|
"JMD": "Jamaican dollar ($)",
|
|
"JOD": "Jordanian dinar (د.ا)",
|
|
"JPY": "Japanese yen (¥)",
|
|
"KES": "Kenyan shilling (KSh)",
|
|
"KGS": "Kyrgyzstani som (сом)",
|
|
"KHR": "Cambodian riel (៛)",
|
|
"KMF": "Comorian franc (Fr)",
|
|
"KPW": "North Korean won (₩)",
|
|
"KRW": "South Korean won (₩)",
|
|
"KWD": "Kuwaiti dinar (د.ك)",
|
|
"KYD": "Cayman Islands dollar ($)",
|
|
"KZT": "Kazakhstani tenge (KZT)",
|
|
"LAK": "Lao kip (₭)",
|
|
"LBP": "Lebanese pound (ل.ل)",
|
|
"LKR": "Sri Lankan rupee (රු)",
|
|
"LRD": "Liberian dollar ($)",
|
|
"LSL": "Lesotho loti (L)",
|
|
"LYD": "Libyan dinar (ل.د)",
|
|
"MAD": "Moroccan dirham (د.م.)",
|
|
"MDL": "Moldovan leu (MDL)",
|
|
"MGA": "Malagasy ariary (Ar)",
|
|
"MKD": "Macedonian denar (ден)",
|
|
"MMK": "Burmese kyat (Ks)",
|
|
"MNT": "Mongolian tögrög (₮)",
|
|
"MOP": "Macanese pataca (P)",
|
|
"MRO": "Mauritanian ouguiya (UM)",
|
|
"MUR": "Mauritian rupee (₨)",
|
|
"MVR": "Maldivian rufiyaa (.ރ)",
|
|
"MWK": "Malawian kwacha (MK)",
|
|
"MXN": "Mexican peso ($)",
|
|
"MYR": "Malaysian ringgit (RM)",
|
|
"MZN": "Mozambican metical (MT)",
|
|
"NAD": "Namibian dollar ($)",
|
|
"NGN": "Nigerian naira (₦)",
|
|
"NIO": "Nicaraguan córdoba (C$)",
|
|
"NOK": "Norwegian krone (kr)",
|
|
"NPR": "Nepalese rupee (₨)",
|
|
"NZD": "New Zealand dollar ($)",
|
|
"OMR": "Omani rial (ر.ع.)",
|
|
"PAB": "Panamanian balboa (B/.)",
|
|
"PEN": "Peruvian nuevo sol (S/.)",
|
|
"PGK": "Papua New Guinean kina (K)",
|
|
"PHP": "Philippine peso (₱)",
|
|
"PKR": "Pakistani rupee (₨)",
|
|
"PLN": "Polish złoty (zł)",
|
|
"PRB": "Transnistrian ruble (р.)",
|
|
"PYG": "Paraguayan guaraní (₲)",
|
|
"QAR": "Qatari riyal (ر.ق)",
|
|
"RON": "Romanian leu (lei)",
|
|
"RSD": "Serbian dinar (дин.)",
|
|
"RUB": "Russian ruble (₽)",
|
|
"RWF": "Rwandan franc (Fr)",
|
|
"SAR": "Saudi riyal (ر.س)",
|
|
"SBD": "Solomon Islands dollar ($)",
|
|
"SCR": "Seychellois rupee (₨)",
|
|
"SDG": "Sudanese pound (ج.س.)",
|
|
"SEK": "Swedish krona (kr)",
|
|
"SGD": "Singapore dollar ($)",
|
|
"SHP": "Saint Helena pound (£)",
|
|
"SLL": "Sierra Leonean leone (Le)",
|
|
"SOS": "Somali shilling (Sh)",
|
|
"SRD": "Surinamese dollar ($)",
|
|
"SSP": "South Sudanese pound (£)",
|
|
"STD": "São Tomé and Príncipe dobra (Db)",
|
|
"SYP": "Syrian pound (ل.س)",
|
|
"SZL": "Swazi lilangeni (L)",
|
|
"THB": "Thai baht (฿)",
|
|
"TJS": "Tajikistani somoni (ЅМ)",
|
|
"TMT": "Turkmenistan manat (m)",
|
|
"TND": "Tunisian dinar (د.ت)",
|
|
"TOP": "Tongan paʻanga (T$)",
|
|
"TRY": "Turkish lira (₺)",
|
|
"TTD": "Trinidad and Tobago dollar ($)",
|
|
"TWD": "New Taiwan dollar (NT$)",
|
|
"TZS": "Tanzanian shilling (Sh)",
|
|
"UAH": "Ukrainian hryvnia (₴)",
|
|
"UGX": "Ugandan shilling (UGX)",
|
|
"USD": "United States dollar ($)",
|
|
"UYU": "Uruguayan peso ($)",
|
|
"UZS": "Uzbekistani som (UZS)",
|
|
"VEF": "Venezuelan bolívar (Bs F)",
|
|
"VND": "Vietnamese đồng (₫)",
|
|
"VUV": "Vanuatu vatu (Vt)",
|
|
"WST": "Samoan tālā (T)",
|
|
"XAF": "Central African CFA franc (Fr)",
|
|
"XCD": "East Caribbean dollar ($)",
|
|
"XOF": "West African CFA franc (Fr)",
|
|
"XPF": "CFP franc (Fr)",
|
|
"YER": "Yemeni rial (﷼)",
|
|
"ZAR": "South African rand (R)",
|
|
"ZMW": "Zambian kwacha (ZK)"
|
|
},
|
|
"tip": "This controls what currency prices are listed at in the catalog and which currency gateways will take payments in.",
|
|
"value": "GBP",
|
|
"_links": {
|
|
"self": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general/woocommerce_currency"
|
|
}
|
|
],
|
|
"collection": [
|
|
{
|
|
"href": "https://example.com/wp-json/wc/v3/settings/general"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
```
|