v1

latestOpenAPI 3.0.02026-07-226950132.6 KB
product-attribute-terms

Get product attribute terms

Returns a list of product attribute terms.

get/products/attributes/{attribute_id}/terms

Path parameters

attribute_idinteger required

Unique identifier for the attribute of the terms.

Query parameters

context'view' | 'embed'

Scope under which the request is made; determines fields present in response.

pageinteger

Current page of the collection.

per_pageinteger

Maximum number of items to be returned in result set.

searchstring

Limit results to those matching a string.

excludeinteger[]

Ensure result set excludes specific IDs.

includeinteger[]

Limit result set to specific IDs.

offsetinteger

Offset the result set by a specific number of items.

order'asc' | 'desc'

Order sort attribute ascending or descending.

orderby'id' | 'include' | 'name' | 'slug' | 'term_group' | 'description' | 'count' | 'menu_order'

Sort collection by object attribute.

hide_emptyboolean

Whether to hide resources not assigned to any products.

productinteger

Limit result set to resources assigned to a specific product.

slugstring

Limit result set to resources with a specific slug.

Response

List of product attribute terms.

idinteger

Unique identifier for the resource.

namestring

Term name.

slugstring

An alphanumeric identifier for the resource unique to its type.

descriptionstring

HTML description of the resource.

menu_orderinteger

Menu order, used to custom sort the resource.

countinteger

Number of published products for the resource.