WooCommerce Product Tags API

openapi: 3.1.0
info:
  title: WooCommerce REST Cart Product Tags API
  description: The WooCommerce REST API is the primary server-side interface for reading and writing WooCommerce store data programmatically. It follows REST conventions, uses JSON for all requests and responses, and is fully integrated with the WordPress REST API under the /wp-json/wc/v3/ namespace. The API covers products, product variations, product categories, product attributes, orders, order notes, order refunds, customers, coupons, tax rates, shipping zones, payment gateways, settings, webhooks, reports, and system status. Authentication uses Consumer Key and Consumer Secret pairs generated in the WooCommerce admin, transmitted over HTTPS via HTTP Basic Auth or OAuth 1.0a over plain HTTP.
  version: v3
  contact:
    name: WooCommerce Developer Support
    url: https://developer.woocommerce.com/docs/apis/rest-api/
  termsOfService: https://woocommerce.com/terms-conditions/
servers:
- url: https://example.com/wp-json/wc/v3
  description: Production Server (replace example.com with your store domain)
security:
- basicAuth: []
tags:
- name: Product Tags
  description: Retrieve product tags for filtering
paths:
  /products/tags:
    get:
      operationId: listStoreProductTags
      summary: WooCommerce List Product Tags
      description: Returns all product tags used in the store catalog.
      tags:
      - Product Tags
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/per_page'
      responses:
        '200':
          description: List of product tags
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StoreProductTag'
              examples:
                listStoreProductTags200Example:
                  summary: Default listStoreProductTags 200 response
                  x-microcks-default: true
                  value:
                  - id: 1
                    name: Example Name
                    slug: string-value
                    description: A sample description
                    count: 1
                    link: https://example.com/path
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    page:
      name: page
      in: query
      description: Current page of the collection.
      required: false
      schema:
        type: integer
        minimum: 1
        default: 1
    per_page:
      name: per_page
      in: query
      description: Maximum number of items per page (maximum 100).
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 10
  schemas:
    StoreProductTag:
      type: object
      description: A product tag used for labeling and filtering.
      properties:
        id:
          type: integer
          description: Tag unique identifier.
          example: 1
        name:
          type: string
          description: Tag display name.
          example: Example Name
        slug:
          type: string
          description: URL-friendly tag slug.
          example: string-value
        description:
          type: string
          description: Tag description.
          example: A sample description
        count:
          type: integer
          description: Number of products with this tag.
          example: 1
        link:
          type: string
          format: uri
          description: Tag archive URL.
          example: https://example.com/path
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Auth using the WooCommerce Consumer Key as the username and Consumer Secret as the password over HTTPS. Over plain HTTP use OAuth 1.0a one-legged authentication instead.
externalDocs:
  description: WooCommerce REST API Documentation
  url: https://woocommerce.github.io/woocommerce-rest-api-docs/