Create Attribute
Beta/v1/catalog/properties/{property_id}/attributesIdempotent with Idempotency-Key header. Learn more
Creates an attribute under a property.
property_idstringProperty ID.
valuestringThe selectable value this attribute represents, such as Red.
Must be unique across all attributes in the account, not just within the property. Leading and trailing whitespace is trimmed.
coloroptional stringenumValues:bluebrowndefaultSwatch color used to display this attribute in the UI.
When omitted, one of the nine named colors (everything except default) is assigned at random.
sort_orderoptional integerPosition of the new attribute relative to its siblings within the property, starting at 1.
Must be at most the property's current attribute count plus one; siblings at or after this position are shifted one position later. Defaults to the last position if not provided.
idstringAttribute ID.
objectstringenumValues:attributeResource type identifier.
valuestringThe selectable value this attribute represents, such as Red for a Color property or Large for a Size property.
colorstringenumValues:bluebrowndefaultSwatch color used to display this attribute in the UI.
The named colors are arbitrary display choices; default is a neutral fallback used when no specific swatch applies.
sort_orderintegerPosition of this attribute relative to its siblings within the property, starting at 1.
Positions are kept contiguous: creating, reordering, or deleting an attribute automatically shifts its siblings.
The property this attribute belongs to.
Populated only when the attribute is returned under an item's attributes list.
idstringProperty ID.
objectstringenumValues:propertyResource type identifier.
namestringDisplay name of the property, such as Color or Size.
Attributes belonging to this property.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableRelative URL that fetches the next page of results.
null when the last page has been reached.
previous_page_urlstringnullableRelative URL that fetches the previous page of results.
null while on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of attributeResources in this page.
idstringAttribute ID.
objectstringenumValues:attributeResource type identifier.
valuestringThe selectable value this attribute represents, such as Red for a Color property or Large for a Size property.
colorstringenumValues:bluebrowndefaultSwatch color used to display this attribute in the UI.
The named colors are arbitrary display choices; default is a neutral fallback used when no specific swatch applies.
sort_orderintegerPosition of this attribute relative to its siblings within the property, starting at 1.
Positions are kept contiguous: creating, reordering, or deleting an attribute automatically shifts its siblings.
The property this attribute belongs to.
Populated only when the attribute is returned under an item's attributes list.
idstringProperty ID.
objectstringenumValues:propertyResource type identifier.
namestringDisplay name of the property, such as Color or Size.
Attributes belonging to this property.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
dataarray of attributeResources in this page.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last update timestamp.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last update timestamp.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last update timestamp.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last update timestamp.
Responses
Successful response for Create Attribute