List Product Tags

Retrieve a list of product tags. The product tags can be filtered by fields such as id or q. The product tags can also be sorted or paginated.

{ "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" } } ] }

Request

Query Params

limit

integer

optional

Limit the number of product tags returned.

offset

integer

optional

The number of product tags to skip when retrieving the product tags.

order

string

optional

A product-tag field to sort-order the retrieved product tags by.

discount_condition_id

string

optional

Filter by the ID of a discount condition. When provided, only tags that the discount condition applies for will be retrieved.

value

array[string]

optional

Filter by tag values.

array[string]

optional

Filter by IDs.

string

optional

term to search product tag's value.

array[string]

optional

filter by dates less than this date

Example:

["",""]

array[string]

optional

filter by dates greater than this date

Example:

["",""]

lte

array[string]

optional

filter by dates less than or equal to this date

Example:

["",""]

gte

array[string]

optional

filter by dates greater than or equal to this date

Example:

["",""]

Responses

🟢200OK

application/json

Body

The list of product tags with pagination fields.

count

integer

required

The total number of items available

offset

integer

required

The number of product tags skipped when retrieving the product tags.

limit

integer

required

The number of items per page

product_tags

array[object (Product Tag) {6}]

required

An array of product tags details.

string

required

The product tag's ID

Example:

ptag_01G8K2MTMG9168F2B70S1TAVK3

value

string

required

The value that the Product Tag represents

Example:

Pants

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error