Create an attribute
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/attributes';const options = { method: 'POST', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"name":"Color","slug":"color","type":"select","order_by":"manual","sort_order":1,"taxonomy_attribute_code":"color","is_local":false}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://apibase.ecomweb.app/api/v1/stores/example/attributes \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "name": "Color", "slug": "color", "type": "select", "order_by": "manual", "sort_order": 1, "taxonomy_attribute_code": "color", "is_local": false }'Creates an attribute such as Color or Size. The slug is derived from the name unless you send one. A name or slug that is already used in the store is rejected with a 400 error and the code ATTRIBUTE_SLUG_TAKEN. Add values afterwards with the attribute’s values routes.
Required scopes: write:products
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Attribute name
Example
ColorURL-safe slug; derived from name when omitted
Example
colorAttribute type
Example
selectHow values are ordered by default
Example
manualSort order among store attributes
Global taxonomy attribute code. Required unless is_local is true.
Example
colorDeliberately create a store-local attribute with no global code. Logged.
Example
falseResponses
Section titled “Responses”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.
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.
Example generated
{ "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" } ], "id": 1, "name": "example", "slug": "example", "type": "example", "order_by": "example", "sort_order": 1, "created_at": "example", "updated_at": "example", "taxonomy_attribute_code": "example"}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"}