Product tags

The product tags API allows you to create, view, update, and delete individual, or a batch, of product tags.

Product tag properties

Attribute	Type	Description
id	integer	Unique identifier for the resource. READ-ONLY
name	string	Tag name. REQUIRED
slug	string	An alphanumeric identifier for the resource unique to its type.
description	string	HTML description of the resource.
count	integer	Number of published products for the resource. READ-ONLY

Create a product tag

This API helps you to create a new product tag.

POST /wp-json/wc/v1/products/tags

Example of how to create a product tag:

cURL

curl -X POST https://example.com/wp-json/wc/v1/products/tags \
	-u consumer_key:consumer_secret \
	-H "Content-Type: application/json" \
	-d '{
  "name": "Leather Shoes"
}'

JavaScript

const data = {
  name: "Leather Shoes"
};

WooCommerce.post("products/tags", data)
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

PHP

<?php
$data = [
    'name' => 'Leather Shoes'
];

print_r($woocommerce->post('products/tags', $data));
?>

Python

data = {
    "name": "Leather Shoes"
}

print(wcapi.post("products/tags", data).json())

Ruby

data = {
  name: "Leather Shoes"
}

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

JSON Response

{
  "id": 34,
  "name": "Leather Shoes",
  "slug": "leather-shoes",
  "description": "",
  "count": 0,
  "_links": {
    "self": [
      {
        "href": "https://example.com/wp-json/wc/v1/products/tags/34"
      }
    ],
    "collection": [
      {
        "href": "https://example.com/wp-json/wc/v1/products/tags"
      }
    ]
  }
}

Retrieve a product tag

This API lets you retrieve a product tag by ID.

GET /wp-json/wc/v1/products/tags/<id>

cURL

curl https://example.com/wp-json/wc/v1/products/tags/34 \
	-u consumer_key:consumer_secret

JavaScript

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

PHP

<?php print_r($woocommerce->get('products/tags/34')); ?>

Python

print(wcapi.get("products/tags/34").json())

Ruby

woocommerce.get("products/tags/34").parsed_response

JSON Response

{
  "id": 34,
  "name": "Leather Shoes",
  "slug": "leather-shoes",
  "description": "",
  "count": 0,
  "_links": {
    "self": [
      {
        "href": "https://example.com/wp-json/wc/v1/products/tags/34"
      }
    ],
    "collection": [
      {
        "href": "https://example.com/wp-json/wc/v1/products/tags"
      }
    ]
  }
}

List all product tags

This API lets you retrieve all product tag.

GET /wp-json/wc/v1/products/tags

cURL

curl https://example.com/wp-json/wc/v1/products/tags \
	-u consumer_key:consumer_secret

JavaScript

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

PHP

<?php print_r($woocommerce->get('products/tags')); ?>

Python

print(wcapi.get("products/tags").json())

Ruby

woocommerce.get("products/tags").parsed_response

JSON Response

[
  {
    "id": 34,
    "name": "Leather Shoes",
    "slug": "leather-shoes",
    "description": "",
    "count": 0,
    "_links": {
      "self": [
        {
          "href": "https://example.com/wp-json/wc/v1/products/tags/34"
        }
      ],
      "collection": [
        {
          "href": "https://example.com/wp-json/wc/v1/products/tags"
        }
      ]
    }
  },
  {
    "id": 35,
    "name": "Oxford Shoes",
    "slug": "oxford-shoes",
    "description": "",
    "count": 0,
    "_links": {
      "self": [
        {
          "href": "https://example.com/wp-json/wc/v1/products/tags/35"
        }
      ],
      "collection": [
        {
          "href": "https://example.com/wp-json/wc/v1/products/tags"
        }
      ]
    }
  }
]

Available parameters

Parameter	Type	Description
context	string	Scope under which the request is made; determines fields present in response. Options: view and edit.
page	integer	Current page of the collection.
per_page	integer	Maximum number of items to be returned in result set.
search	string	Limit results to those matching a string.
exclude	string	Ensure result set excludes specific ids.
include	string	Limit result set to specific ids.
order	string	Order sort attribute ascending or descending. Default is asc. Options: asc and desc.
orderby	string	Sort collection by object attribute. Default is name. Options: id, include, name, slug, term_group, description and count.
hide_empty	bool	Whether to hide resources not assigned to any products. Default is false.
product	integer	Limit result set to resources assigned to a specific product.
slug	string	Limit result set to resources with a specific slug.

Update a product tag

This API lets you make changes to a product tag.

PUT /wp-json/wc/v1/products/tags/<id>

cURL

curl -X PUT https://example.com/wp-json/wc/v1/products/tags/34 \
	-u consumer_key:consumer_secret \
	-H "Content-Type: application/json" \
	-d '{
  "description": "Genuine leather."
}'

JavaScript

const data = {
  description: "Genuine leather."
};

WooCommerce.put("products/tags/34", data)
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

PHP

<?php
$data = [
    'description' => 'Genuine leather.'
];

print_r($woocommerce->put('products/tags/34', $data));
?>

Python

data = {
    "description": "Genuine leather."
}

print(wcapi.put("products/tags/34", data).json())

Ruby

data = {
  description: "Genuine leather."
}

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

JSON Response

{
  "id": 34,
  "name": "Leather Shoes",
  "slug": "leather-shoes",
  "description": "Genuine leather.",
  "count": 0,
  "_links": {
    "self": [
      {
        "href": "https://example.com/wp-json/wc/v1/products/tags/34"
      }
    ],
    "collection": [
      {
        "href": "https://example.com/wp-json/wc/v1/products/tags"
      }
    ]
  }
}

Delete a product tag

This API helps you delete a product tag.

DELETE /wp-json/wc/v1/products/tags/<id>

cURL

curl -X DELETE https://example.com/wp-json/wc/v1/products/tags/34?force=true \
	-u consumer_key:consumer_secret

JavaScript

WooCommerce.delete("products/tags/34", {
  force: true
})
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

PHP

<?php print_r($woocommerce->delete('products/tags/34', ['force' => true])); ?>

Python

print(wcapi.delete("products/tags/34", params={"force": True}).json())

Ruby

woocommerce.delete("products/tags/34", force: true).parsed_response

JSON Response

{
  "id": 34,
  "name": "Leather Shoes",
  "slug": "leather-shoes",
  "description": "Genuine leather.",
  "count": 0,
  "_links": {
    "self": [
      {
        "href": "https://example.com/wp-json/wc/v1/products/tags/34"
      }
    ],
    "collection": [
      {
        "href": "https://example.com/wp-json/wc/v1/products/tags"
      }
    ]
  }
}

Available parameters

Parameter	Type	Description
force	string	Required to be true, as resource does not support trashing.

Batch update product tags

This API helps you to batch create, update and delete multiple product tags.

note

Note: By default it's limited to up to 100 objects to be created, updated or deleted.

POST /wp-json/wc/v1/products/tags/batch

cURL

curl -X POST https://example.com/wp-json/wc/v1/products/tags/batch \
	-u consumer_key:consumer_secret \
	-H "Content-Type: application/json" \
	-d '{
  "create": [
    {
      "name": "Round toe"
    },
    {
      "name": "Flat"
    }
  ],
  "update": [
    {
      "id": 34,
      "description": "Genuine leather."
    }
  ],
  "delete": [
    35
  ]
}'

JavaScript

const data = {
  create: [
    {
      name: "Round toe"
    },
    {
      name: "Flat"
    }
  ],
  update: [
    {
      id: 34,
      description: "Genuine leather."
    }
  ],
  delete: [
    35
  ]
};

WooCommerce.post("products/tags/batch", data)
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

PHP

<?php
$data = [
    'create' => [
        [
            'name' => 'Round toe'
        ],
        [
            'name' => 'Flat'
        ]
    ],
    'update' => [
        [
            'id' => 34,
            'description' => 'Genuine leather.'
        ]
    ],
    'delete' => [
        35
    ]
];

print_r($woocommerce->post('products/tags/batch', $data));
?>

Python

data = {
    "create": [
        {
            "name": "Round toe"
        },
        {
            "name": "Flat"
        }
    ],
    "update": [
        {
            "id": 34,
            "description": "Genuine leather."
        }
    ],
    "delete": [
        35
    ]
}

print(wcapi.post("products/tags/batch", data).json())

Ruby

data = {
  create: [
    {
      name: "Round toe"
    },
    {
      name: "Flat"
    }
  ],
  update: [
    {
      id: 34,
      description: "Genuine leather."
    }
  ],
  delete: [
    35
  ]
}

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

JSON Response

{
  "create": [
    {
      "id": 36,
      "name": "Round toe",
      "slug": "round-toe",
      "description": "",
      "count": 0,
      "_links": {
        "self": [
          {
            "href": "https://example.com/wp-json/wc/v1/products/tags/36"
          }
        ],
        "collection": [
          {
            "href": "https://example.com/wp-json/wc/v1/products/tags"
          }
        ]
      }
    },
    {
      "id": 37,
      "name": "Flat",
      "slug": "flat",
      "description": "",
      "count": 0,
      "_links": {
        "self": [
          {
            "href": "https://example.com/wp-json/wc/v1/products/tags/37"
          }
        ],
        "collection": [
          {
            "href": "https://example.com/wp-json/wc/v1/products/tags"
          }
        ]
      }
    }
  ],
  "update": [
    {
      "id": 34,
      "name": "Leather Shoes",
      "slug": "leather-shoes",
      "description": "Genuine leather.",
      "count": 0,
      "_links": {
        "self": [
          {
            "href": "https://example.com/wp-json/wc/v1/products/tags/34"
          }
        ],
        "collection": [
          {
            "href": "https://example.com/wp-json/wc/v1/products/tags"
          }
        ]
      }
    }
  ],
  "delete": [
    {
      "id": 35,
      "name": "Oxford Shoes",
      "slug": "oxford-shoes",
      "description": "",
      "count": 0,
      "_links": {
        "self": [
          {
            "href": "https://example.com/wp-json/wc/v1/products/tags/35"
          }
        ],
        "collection": [
          {
            "href": "https://example.com/wp-json/wc/v1/products/tags"
          }
        ]
      }
    }
  ]
}