List attributes
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/attributes?type=select&filters=%5B%7B%22field%22%3A%22value_count%22%2C%22operator%22%3A%22lte%22%2C%22values%22%3A%5B%220%22%5D%7D%5D&sort_order=asc&limit=20&offset=0';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://apibase.ecomweb.app/api/v1/stores/example/attributes?type=select&filters=%5B%7B%22field%22%3A%22value_count%22%2C%22operator%22%3A%22lte%22%2C%22values%22%3A%5B%220%22%5D%7D%5D&sort_order=asc&limit=20&offset=0' \ --header 'x-api-key: <x-api-key>'Returns a page of the store’s attributes in their saved order, each with its number of values. Use limit and offset to page, search to match names, type to filter by type and include_values to add each attribute’s values. The filters parameter is a JSON array of clauses, each {"field", "operator", "values"}, with at most 10 clauses and 50 values per clause. Fields: type (is, is_not; select, text or visual) and value_count (gte, lte; a number). sort_by accepts name, type, created_at, updated_at and value_count.
Required scopes: read:products
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Query Parameters
Section titled “Query Parameters”Include each attribute’s values
Case-insensitive search on name
Filter by attribute type
Example
[{"field":"value_count","operator":"lte","values":["0"]}]A JSON array of {field, operator, values} clauses, with at most 10 clauses and 50 values each. Fields: type (is, is_not) and value_count (gte, lte).
Sort field
Responses
Section titled “Responses”object
object
The attribute’s values, in display order. Present when fetching one attribute or when include_values is true.
object
Attribute value ID.
ID of the attribute this value belongs to.
Stored value, such as “red”.
Value as shown to shoppers, such as “Red”.
Swatch kind: none, color or image.
Swatch content: a color code or an image URL. Empty when there is no swatch.
Position of the value within its attribute.
When the value was created, as an ISO 8601 timestamp.
When the value was last updated, as an ISO 8601 timestamp.
Code of the global taxonomy value this one maps to, or null.
Number of values the attribute has.
Attribute ID.
Attribute name, such as “Color”.
URL-safe identifier of the attribute, unique within the store.
How values are chosen, such as select.
How the values are ordered, such as manual.
Position of the attribute among the store’s attributes.
When the attribute was created, as an ISO 8601 timestamp.
When the attribute was last updated, as an ISO 8601 timestamp.
Code of the global taxonomy attribute this one maps to, or null for a local attribute.
object
Total number of items matching the request.
Maximum number of items in this page.
Number of items skipped before this page.
Current page number, starting at 1.
Total number of pages.
Whether a next page exists.
Whether a previous page exists.
Example generated
{ "data": [ { "attribute_values": [ { "id": 1, "attribute_id": 1, "value": "example", "display_value": "example", "swatch_type": "example", "swatch_value": "example", "sort_order": 1, "created_at": "example", "updated_at": "example", "taxonomy_value_code": "example" } ], "value_count": 1, "id": 1, "name": "example", "slug": "example", "type": "example", "order_by": "example", "sort_order": 1, "created_at": "example", "updated_at": "example", "taxonomy_attribute_code": "example" } ], "meta": { "total": 1, "limit": 1, "offset": 1, "page": 1, "totalPages": 1, "hasNext": true, "hasPrev": true }}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}