woocommerce/woocommerce-rest-api-docs
1
0
Fork 0
mirror of https://gh.wpcy.net/https://github.com/woocommerce/woocommerce-rest-api-docs.git synced 2026-04-24 04:42:50 +08:00
Code Issues Projects Packages Activity Actions
woocommerce-rest-api-docs/source/includes/wp-api-v3/_data.md
Claudio Sanches 8abe8ae743 Updated JavaScript library examples
2019-07-29 19:55:22 -03:00

23 KiB
Raw Permalink Blame History

Data

The data API allows you to view all types of data available.

List all data

This API lets you retrieve and view a simple list of available data endpoints.

HTTP request

GET
/wp-json/wc/v3/data
curl https://example.com/wp-json/wc/v3/data \
	-u consumer_key:consumer_secret

WooCommerce.get("data")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

<?php print_r($woocommerce->get('data')); ?>

print(wcapi.get("data").json())

woocommerce.get("data").parsed_response

JSON response example:

[
	{
		"slug": "continents",
		"description": "List of supported continents, countries, and states.",
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/data/continents"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/data"
				}
			]
		}
	},
	{
		"slug": "countries",
		"description": "List of supported states in a given country.",
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/data/countries"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/data"
				}
			]
		}
	},
	{
		"slug": "currencies",
		"description": "List of supported currencies.",
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/data/currencies"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/data"
				}
			]
		}
	}
]

Data properties

Attribute Type Description
slug string Data resource ID. read-only
description string Data resource description. read-only

List all continents

This API helps you to view all the continents.

HTTP request

GET
/wp-json/wc/v3/data/continents
curl https://example.com/wp-json/wc/v3/data/continents \
	-u consumer_key:consumer_secret

WooCommerce.get("data/continents")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

<?php
print_r($woocommerce->get('data/continents'));
?>

print(wcapi.get("data/continents").json())

woocommerce.get("data/continents").parsed_response

JSON response example:

[
	{
		"code": "AF",
		"name": "Africa",
		"countries": [
			{
				"code": "AO",
				"name": "Angola",
				"states": [
					{
						"code": "BGO",
						"name": "Bengo"
					},
					{
						"code": "BLU",
						"name": "Benguela"
					},
					{
						"code": "BIE",
						"name": "Bié"
					},
					{
						"code": "CAB",
						"name": "Cabinda"
					},
					{
						"code": "CNN",
						"name": "Cunene"
					},
					{
						"code": "HUA",
						"name": "Huambo"
					},
					{
						"code": "HUI",
						"name": "Huíla"
					},
					{
						"code": "CCU",
						"name": "Kuando Kubango"
					},
					{
						"code": "CNO",
						"name": "Kwanza-Norte"
					},
					{
						"code": "CUS",
						"name": "Kwanza-Sul"
					},
					{
						"code": "LUA",
						"name": "Luanda"
					},
					{
						"code": "LNO",
						"name": "Lunda-Norte"
					},
					{
						"code": "LSU",
						"name": "Lunda-Sul"
					},
					{
						"code": "MAL",
						"name": "Malanje"
					},
					{
						"code": "MOX",
						"name": "Moxico"
					},
					{
						"code": "NAM",
						"name": "Namibe"
					},
					{
						"code": "UIG",
						"name": "Uíge"
					},
					{
						"code": "ZAI",
						"name": "Zaire"
					}
				]
			},
			{
				"code": "BF",
				"name": "Burkina Faso",
				"states": []
			},
			{
				"code": "BI",
				"name": "Burundi",
				"states": []
			}
		],
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/data/continents/af"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/data/continents"
				}
			]
		}
  }
]

Continents properties

Attribute Type Description
code string 2 character continent code. read-only
name string Full name of continent. read-only
countries array List of countries on this continent. See Continents - Countries properties read-only
Continents - Countries properties
Attribute Type Description
code string ISO3166 alpha-2 country code. read-only
currency_code string Default ISO4127 alpha-3 currency code for the country. read-only
currency_pos string Currency symbol position for this country. read-only
decimal_sep string Decimal separator for displayed prices for this country. read-only
dimension_unit string The unit lengths are defined in for this country. read-only
name string Full name of country. read-only
num_decimals integer Number of decimal points shown in displayed prices for this country. read-only
states array List of states in this country. See Continents - Countries - States properties read-only
thousand_sep string Thousands separator for displayed prices in this country. read-only
weight_unit string The unit weights are defined in for this country. read-only
Continents - Countries - States properties
Attribute Type Description
code string State code. read-only
name string Full name of state. read-only

Retrieve continent data

This API lets you retrieve and view a continent data.

HTTP request

GET
/wp-json/wc/v3/data/continents/<location>
curl https://example.com/wp-json/wc/v3/data/continents/eu \
	-u consumer_key:consumer_secret

WooCommerce.get("data/continents/eu")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

<?php
print_r($woocommerce->get('data/continents/eu'));
?>

print(wcapi.get("data/continents/eu").json())

woocommerce.get("data/continents/eu").parsed_response

JSON response example:

{
	"code": "EU",
	"name": "Europe",
	"countries": [
		{
			"code": "AD",
			"name": "Andorra",
			"states": []
		},
		{
			"code": "AL",
			"name": "Albania",
			"states": []
		},
		{
			"code": "AT",
			"name": "Austria",
			"states": []
		},
		{
			"code": "AX",
			"name": "&#197;land Islands",
			"states": []
		},
		{
			"code": "BA",
			"name": "Bosnia and Herzegovina",
			"states": []
		},
		{
			"code": "BE",
			"name": "Belgium",
			"currency_code": "EUR",
			"currency_pos": "left",
			"decimal_sep": ",",
			"dimension_unit": "cm",
			"num_decimals": 2,
			"thousand_sep": " ",
			"weight_unit": "kg",
			"states": []
		},
		{
			"code": "BG",
			"name": "Bulgaria",
			"states": [
				{
					"code": "BG-01",
					"name": "Blagoevgrad"
				},
				{
					"code": "BG-02",
					"name": "Burgas"
				},
				{
					"code": "BG-08",
					"name": "Dobrich"
				},
				{
					"code": "BG-07",
					"name": "Gabrovo"
				},
				{
					"code": "BG-26",
					"name": "Haskovo"
				},
				{
					"code": "BG-09",
					"name": "Kardzhali"
				},
				{
					"code": "BG-10",
					"name": "Kyustendil"
				},
				{
					"code": "BG-11",
					"name": "Lovech"
				},
				{
					"code": "BG-12",
					"name": "Montana"
				},
				{
					"code": "BG-13",
					"name": "Pazardzhik"
				},
				{
					"code": "BG-14",
					"name": "Pernik"
				},
				{
					"code": "BG-15",
					"name": "Pleven"
				},
				{
					"code": "BG-16",
					"name": "Plovdiv"
				},
				{
					"code": "BG-17",
					"name": "Razgrad"
				},
				{
					"code": "BG-18",
					"name": "Ruse"
				},
				{
					"code": "BG-27",
					"name": "Shumen"
				},
				{
					"code": "BG-19",
					"name": "Silistra"
				},
				{
					"code": "BG-20",
					"name": "Sliven"
				},
				{
					"code": "BG-21",
					"name": "Smolyan"
				},
				{
					"code": "BG-23",
					"name": "Sofia"
				},
				{
					"code": "BG-22",
					"name": "Sofia-Grad"
				},
				{
					"code": "BG-24",
					"name": "Stara Zagora"
				},
				{
					"code": "BG-25",
					"name": "Targovishte"
				},
				{
					"code": "BG-03",
					"name": "Varna"
				},
				{
					"code": "BG-04",
					"name": "Veliko Tarnovo"
				},
				{
					"code": "BG-05",
					"name": "Vidin"
				},
				{
					"code": "BG-06",
					"name": "Vratsa"
				},
				{
					"code": "BG-28",
					"name": "Yambol"
				}
			]
		}
	],
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/data/continents/eu"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/data/continents"
			}
		]
	}
}

Continent properties

See list of continents properties.

List all countries

This API helps you to view all the countries.

HTTP request

GET
/wp-json/wc/v3/data/countries
curl https://example.com/wp-json/wc/v3/data/countries \
	-u consumer_key:consumer_secret

WooCommerce.get("data/countries")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

<?php
print_r($woocommerce->get('data/countries'));
?>

print(wcapi.get("data/countries").json())

woocommerce.get("data/countries").parsed_response

JSON response example:

[
	{
		"code": "US",
		"name": "United States (US)",
		"states": [
			{
				"code": "AL",
				"name": "Alabama"
			},
			{
				"code": "AK",
				"name": "Alaska"
			},
			{
				"code": "AZ",
				"name": "Arizona"
			},
			{
				"code": "AR",
				"name": "Arkansas"
			},
			{
				"code": "CA",
				"name": "California"
			},
			{
				"code": "CO",
				"name": "Colorado"
			},
			{
				"code": "CT",
				"name": "Connecticut"
			},
			{
				"code": "DE",
				"name": "Delaware"
			},
			{
				"code": "DC",
				"name": "District Of Columbia"
			},
			{
				"code": "FL",
				"name": "Florida"
			},
			{
				"code": "GA",
				"name": "Georgia"
			},
			{
				"code": "HI",
				"name": "Hawaii"
			},
			{
				"code": "ID",
				"name": "Idaho"
			},
			{
				"code": "IL",
				"name": "Illinois"
			},
			{
				"code": "IN",
				"name": "Indiana"
			},
			{
				"code": "IA",
				"name": "Iowa"
			},
			{
				"code": "KS",
				"name": "Kansas"
			},
			{
				"code": "KY",
				"name": "Kentucky"
			},
			{
				"code": "LA",
				"name": "Louisiana"
			},
			{
				"code": "ME",
				"name": "Maine"
			},
			{
				"code": "MD",
				"name": "Maryland"
			},
			{
				"code": "MA",
				"name": "Massachusetts"
			},
			{
				"code": "MI",
				"name": "Michigan"
			},
			{
				"code": "MN",
				"name": "Minnesota"
			},
			{
				"code": "MS",
				"name": "Mississippi"
			},
			{
				"code": "MO",
				"name": "Missouri"
			},
			{
				"code": "MT",
				"name": "Montana"
			},
			{
				"code": "NE",
				"name": "Nebraska"
			},
			{
				"code": "NV",
				"name": "Nevada"
			},
			{
				"code": "NH",
				"name": "New Hampshire"
			},
			{
				"code": "NJ",
				"name": "New Jersey"
			},
			{
				"code": "NM",
				"name": "New Mexico"
			},
			{
				"code": "NY",
				"name": "New York"
			},
			{
				"code": "NC",
				"name": "North Carolina"
			},
			{
				"code": "ND",
				"name": "North Dakota"
			},
			{
				"code": "OH",
				"name": "Ohio"
			},
			{
				"code": "OK",
				"name": "Oklahoma"
			},
			{
				"code": "OR",
				"name": "Oregon"
			},
			{
				"code": "PA",
				"name": "Pennsylvania"
			},
			{
				"code": "RI",
				"name": "Rhode Island"
			},
			{
				"code": "SC",
				"name": "South Carolina"
			},
			{
				"code": "SD",
				"name": "South Dakota"
			},
			{
				"code": "TN",
				"name": "Tennessee"
			},
			{
				"code": "TX",
				"name": "Texas"
			},
			{
				"code": "UT",
				"name": "Utah"
			},
			{
				"code": "VT",
				"name": "Vermont"
			},
			{
				"code": "VA",
				"name": "Virginia"
			},
			{
				"code": "WA",
				"name": "Washington"
			},
			{
				"code": "WV",
				"name": "West Virginia"
			},
			{
				"code": "WI",
				"name": "Wisconsin"
			},
			{
				"code": "WY",
				"name": "Wyoming"
			},
			{
				"code": "AA",
				"name": "Armed Forces (AA)"
			},
			{
				"code": "AE",
				"name": "Armed Forces (AE)"
			},
			{
				"code": "AP",
				"name": "Armed Forces (AP)"
			}
		],
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/data/countries/us"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/data/countries"
				}
			]
		}
	}
]

Countries properties

Attribute Type Description
code string ISO3166 alpha-2 country code. read-only
name string Full name of country. read-only
states array List of states in this country. See Countries - States properties read-only
Countries - States properties
Attribute Type Description
code string State code. read-only
name string Full name of state. read-only

Retrieve country data

This API lets you retrieve and view a country data.

HTTP request

GET
/wp-json/wc/v3/data/countries/<location>
curl https://example.com/wp-json/wc/v3/data/countries/br \
	-u consumer_key:consumer_secret

WooCommerce.get("data/countries/br")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

<?php
print_r($woocommerce->get('data/countries/br'));
?>

print(wcapi.get("data/countries/br").json())

woocommerce.get("data/countries/br").parsed_response

JSON response example:

{
	"code": "BR",
	"name": "Brazil",
	"states": [
		{
			"code": "AC",
			"name": "Acre"
		},
		{
			"code": "AL",
			"name": "Alagoas"
		},
		{
			"code": "AP",
			"name": "Amap&aacute;"
		},
		{
			"code": "AM",
			"name": "Amazonas"
		},
		{
			"code": "BA",
			"name": "Bahia"
		},
		{
			"code": "CE",
			"name": "Cear&aacute;"
		},
		{
			"code": "DF",
			"name": "Distrito Federal"
		},
		{
			"code": "ES",
			"name": "Esp&iacute;rito Santo"
		},
		{
			"code": "GO",
			"name": "Goi&aacute;s"
		},
		{
			"code": "MA",
			"name": "Maranh&atilde;o"
		},
		{
			"code": "MT",
			"name": "Mato Grosso"
		},
		{
			"code": "MS",
			"name": "Mato Grosso do Sul"
		},
		{
			"code": "MG",
			"name": "Minas Gerais"
		},
		{
			"code": "PA",
			"name": "Par&aacute;"
		},
		{
			"code": "PB",
			"name": "Para&iacute;ba"
		},
		{
			"code": "PR",
			"name": "Paran&aacute;"
		},
		{
			"code": "PE",
			"name": "Pernambuco"
		},
		{
			"code": "PI",
			"name": "Piau&iacute;"
		},
		{
			"code": "RJ",
			"name": "Rio de Janeiro"
		},
		{
			"code": "RN",
			"name": "Rio Grande do Norte"
		},
		{
			"code": "RS",
			"name": "Rio Grande do Sul"
		},
		{
			"code": "RO",
			"name": "Rond&ocirc;nia"
		},
		{
			"code": "RR",
			"name": "Roraima"
		},
		{
			"code": "SC",
			"name": "Santa Catarina"
		},
		{
			"code": "SP",
			"name": "S&atilde;o Paulo"
		},
		{
			"code": "SE",
			"name": "Sergipe"
		},
		{
			"code": "TO",
			"name": "Tocantins"
		}
	],
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/data/countries/br"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/data/countries"
			}
		]
	}
}

Country properties

See list of countries properties.

List all currencies

This API helps you to view all the currencies.

HTTP request

GET
/wp-json/wc/v3/data/currencies
curl https://example.com/wp-json/wc/v3/data/currencies \
	-u consumer_key:consumer_secret

WooCommerce.get("data/currencies")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

<?php
print_r($woocommerce->get('data/currencies'));
?>

print(wcapi.get("data/currencies").json())

woocommerce.get("data/currencies").parsed_response

JSON response example:

[
	{
		"code": "BTC",
		"name": "Bitcoin",
		"symbol": "&#3647;",
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/data/currencies/BTC"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/data/currencies"
				}
			]
		}
	},
	{
		"code": "EUR",
		"name": "Euro",
		"symbol": "&euro;",
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/data/currencies/EUR"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/data/currencies"
				}
			]
		}
	},
	{
		"code": "USD",
		"name": "United States (US) dollar",
		"symbol": "&#36;",
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/data/currencies/USD"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/data/currencies"
				}
			]
		}
	}
]

Currencies properties

Attribute Type Description
code string ISO4217 currency code. read-only
name string Full name of currency. read-only
symbol string Currency symbol. read-only

Retrieve currency data

This API lets you retrieve and view a currency data.

HTTP request

GET
/wp-json/wc/v3/data/currencies/<currency>
curl https://example.com/wp-json/wc/v3/data/currencies/brl \
	-u consumer_key:consumer_secret

WooCommerce.get("data/currencies/brl")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

<?php
print_r($woocommerce->get('data/currencies/brl'));
?>

print(wcapi.get("data/currencies/brl").json())

woocommerce.get("data/currencies/brl").parsed_response

JSON response example:

{
	"code": "BRL",
	"name": "Brazilian real",
	"symbol": "&#82;&#36;",
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/data/currencies/BRL"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/data/currencies"
			}
		]
	}
}

Currency properties

See list of currencies properties.

Retrieve current currency

This API lets you retrieve and view store's current currency data.

HTTP request

GET
/wp-json/wc/v3/data/currencies/current
curl https://example.com/wp-json/wc/v3/data/currencies/current \
	-u consumer_key:consumer_secret

WooCommerce.get("data/currencies/current")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

<?php
print_r($woocommerce->get('data/currencies/current'));
?>

print(wcapi.get("data/currencies/current").json())

woocommerce.get("data/currencies/current").parsed_response

JSON response example:

{
	"code": "USD",
	"name": "United States (US) dollar",
	"symbol": "&#36;",
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/data/currencies/USD"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/data/currencies"
			}
		]
	}
}

Currency properties

See list of currencies properties.