Admin API/Product TagsProduct Tags
Retrieve a list of product tags. The product tags can be filtered by fields such as q
or value
. The product tags can also be sorted or paginated.
Request
Limit the number of product tags returned.
The number of product tags to skip when retrieving the product tags.
A product tag field to sort-order the retrieved product tags by.
discount_condition_id
string
optionalFilter by the ID of a discount condition. Only product tags that this discount condition is applied to will be retrieved.
term to search product tags' values.
filter by dates less than this date
filter by dates greater than this date
filter by dates less than or equal to this date
filter by dates greater than or equal to this date
Request samples
curl --location --request GET '/admin/product-tags'
Responses
application/json The total number of items available
The number of product tags skipped when retrieving the product tags.
The number of items per page
product_tags
array[object (Product Tag) {6}]
requiredAn array of product tag details.
Example:ptag_01G8K2MTMG9168F2B70S1TAVK3
The value that the Product Tag represents
created_at
string <date-time>
requiredThe date with timezone at which the resource was created.
updated_at
string <date-time>
requiredThe date with timezone at which the resource was updated.
deleted_at
string <date-time> | null
requiredThe date with timezone at which the resource was deleted.
An optional key-value map with additional details
{
"count": 0,
"offset": 0,
"limit": 0,
"product_tags": [
{
"id": "ptag_01G8K2MTMG9168F2B70S1TAVK3",
"value": "Pants",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"metadata": {
"car": "white"
}
}
]
}
Modified at 2024-05-23 07:10:14