跳转到主要内容

产品 - 标签 #

本节列出了所有可用于创建、编辑或以其他方式操作产品标签的 API 端点。

产品标签属性

属性 类型 描述
id integer 标签 ID(术语 ID)只读
name string 标签名称 必需
slug string 标签别名
description string 标签描述
count integer 显示此标签下的产品数量 只读

创建产品标签

此 API 帮助您创建一个新的产品标签。

HTTP 请求

POST
/wc-api/v3/products/tags

如何创建产品标签的示例:

curl -X POST https://example.com/wc-api/v3/products/tags \
	-u consumer_key:consumer_secret \
	-H "Content-Type: application/json" \
	-d '{
  "product_tag": {
    "name": "Leather Shoes"
  }
}'
var data = {
  product_tag: {
    name: 'Leather Shoes'
  }
};

WooCommerce.post('products/tags', data, function(err, data, res) {
  console.log(res);
});
<?php
$data = [
    'product_tag': [
        'name' => 'Leather Shoes'
    ]
];

print_r($woocommerce->post('products/tags', $data));
?>
data = {
    "product_tag": {
        "name": "Leather Shoes"
    }
}

print(wcapi.post("products/tags", data).json())
data = {
  product_tag: {
    name: "Leather Shoes"
  }
}

woocommerce.post("products/tags", data).parsed_response

JSON 响应示例:

{
  "product_tag": {
    "id": 37,
    "name": "Leather Shoes",
    "slug": "leather-shoes",
    "description": "",
    "count": 0
  }
}

查看产品标签

此 API 允许您通过 ID 检索产品标签。

GET
/wc-api/v3/products/tags/<id>
curl https://example.com/wc-api/v3/products/tags/37 \
	-u consumer_key:consumer_secret
WooCommerce.get('products/tags/37', function(err, data, res) {
  console.log(res);
});
<?php print_r($woocommerce->get('products/tags/37')); ?>
print(wcapi.get("products/tags/37").json())
woocommerce.get("products/tags/37").parsed_response

JSON 响应示例:

{
  "product_tag": {
    "id": 37,
    "name": "Leather Shoes",
    "slug": "leather-shoes",
    "description": "",
    "count": 0
  }
}

查看产品标签列表

此 API 允许您检索所有产品标签。

GET
/wc-api/v3/products/tags
curl https://example.com/wc-api/v3/products/tags \
	-u consumer_key:consumer_secret
WooCommerce.get('products/tags', function(err, data, res) {
  console.log(res);
});
<?php print_r($woocommerce->get('products/tags')); ?>
print(wcapi.get("products/tags").json())
woocommerce.get("products/tags").parsed_response

JSON 响应示例:

{
  "product_tags": [
    {
      "id": 37,
      "name": "Leather Shoes",
      "slug": "leather-shoes",
      "description": "",
      "count": 0
    },
    {
      "id": 38,
      "name": "Oxford Shoes",
      "slug": "oxford-shoes",
      "description": "",
      "count": 0
    }
  ]
}

更新商品标签

此 API 允许您修改商品标签。

HTTP 请求

PUT
/wc-api/v3/products/tags/<id>
curl -X PUT https://example.com/wc-api/v3/products/tags/37 \
	-u consumer_key:consumer_secret \
	-H "Content-Type: application/json" \
	-d '{
  "product_tag": {
    "description": "Genuine leather."
  }
}'
var data = {
  product_tag: {
    description: 'Genuine leather.'
  }
};

WooCommerce.put('products/tags/37', data, function(err, data, res) {
  console.log(res);
});
<?php
$data = [
    'product_tag': [
        'description': 'Genuine leather.'
    ]
];

print_r($woocommerce->put('products/tags/37', $data));
?>
data = {
    "product_tag": {
        "description": "Genuine leather."
    }
}

print(wcapi.put("products/tags/37", data).json())
data = {
  product_tag: {
    description: "Genuine leather."
  }
}

woocommerce.put("products/tags/37", data).parsed_response

JSON 响应示例:

{
  "product_tag": {
    "id": 37,
    "name": "Leather Shoes",
    "slug": "leather-shoes",
    "description": "Genuine leather.",
    "count": 0
  }
}

删除商品标签

此 API 可帮助您删除商品标签。

HTTP 请求

DELETE
/wc-api/v3/products/tags/<id>
curl -X DELETE https://example.com/wc-api/v3/products/tags/37 \
	-u consumer_key:consumer_secret
WooCommerce.delete('products/tags/37', function(err, data, res) {
  console.log(res);
});
<?php print_r($woocommerce->delete('products/tags/37')); ?>
print(wcapi.delete("products/tags/37").json())
woocommerce.delete("products/tags/37").parsed_response

JSON 响应示例:

{
  "message": "Deleted product_tag"
}