Optimizely Attribute Types API
The Attribute Types API from Optimizely — 9 operation(s) for attribute types.
Operations 13
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/api/v1/admin/AttributeTypes
List product attribute types · Returns the EntitySet AttributeTypes
#
Ask an LLM
“What product attribute types are defined in the catalog, like color or size?”
“Can I list only the attribute types that are used as search filters?”
Tell an agent
List all attribute types.
List attribute types where {filter}, ordered by {orderby}.
POST
/api/v1/admin/AttributeTypes
Create an attribute type · Post a new entity to EntitySet AttributeTypes
#
Ask an LLM
“How do I add a new product attribute such as material to the catalog?”
“Can a new attribute type be made filterable and comparable when I create it?”
Tell an agent
Create attribute type {name} labeled {label}.
Add a new attribute type {name} with filter enabled set to {isFilter}.
GET
/api/v1/admin/AttributeTypes({id})
Get an attribute type by id · Returns the entity with the key from AttributeTypes
#
Ask an LLM
“Can I look up one attribute type's settings by its id?”
“Is a particular attribute type searchable and shown on the product page?”
Tell an agent
Get attribute type {id}.
Fetch attribute type {id} with {expand} expanded.
PUT
/api/v1/admin/AttributeTypes({id})
Replace an attribute type · Replace entity in EntitySet AttributeTypes
#
Ask an LLM
“Is there a way to overwrite every field of an attribute type at once?”
“What does a full replacement of an attribute type require?”
Tell an agent
Replace attribute type {id} with name {name} and label {label}.
Overwrite the full attribute type record {id}.
DELETE
/api/v1/admin/AttributeTypes({id})
Delete an attribute type · Delete entity in EntitySet AttributeTypes
#
Ask an LLM
“Can I permanently delete one attribute type by id?”
“Does removing a single attribute type accept an If-Match ETag?”
Tell an agent destructive · confirm first
Delete attribute type {id}.
Delete attribute type {id} if its ETag is still {etag}.
PATCH
/api/v1/admin/AttributeTypes({id})
Update fields on an attribute type · Update entity in EntitySet AttributeTypes
#
Ask an LLM
“How do I turn off an attribute type without resending all its fields?”
“Can I just rename the label of an existing attribute type?”
Tell an agent
Set attribute type {id} active flag to {isActive}.
Change the label on attribute type {id} to {label}.
GET
/api/v1/admin/AttributeTypes/Default.Default()
Get a blank attribute type template · Call operation Default
#
Ask an LLM
“What default settings does a new attribute type start with?”
“Is there an empty attribute type template to fill in?”
Tell an agent
Get the default attribute type template.
Show the default values for a new attribute type.
POST
/api/v1/admin/AttributeTypes/Default.archive
Archive attribute types via the archive action · Call operation archive
#
Ask an LLM
“Can I archive attribute types by posting to the archive action instead of deleting them?”
“Which POST action retires several attribute types while keeping their history?”
Tell an agent
Archive attribute types {ids} using the POST archive action.
Call the archive action on attribute types {ids}.
DELETE
/api/v1/admin/attributetypes/archive
Archive attribute types via the DELETE route · Attribute types archive route
#
Ask an LLM
“Is there a DELETE archive route for attribute types?”
“Can I archive attribute types with an HTTP DELETE on the archive path?”
Tell an agent destructive · confirm first
Archive attribute types {ids} through the DELETE archive route.
Send a DELETE to the attribute type archive path for {ids}.
DELETE
/api/v1/admin/attributetypes/delete
Bulk delete attribute types · Attribute types delete route
#
Ask an LLM
“Can I permanently delete many attribute types in a single request?”
“Is there a bulk delete route that takes a list of attribute type ids?”
Tell an agent destructive · confirm first
Bulk delete attribute types {ids}.
Permanently remove these attribute types: {ids}.
GET
/api/v1/admin/attributetypes({key})/attributevalues({attributevalueKey})
Get a value of an attribute type · Attribute types get attribute value by key and attributevaluekey
#
Ask an LLM
“Can I read one allowed value, like Red, under an attribute type?”
“What does a single attribute value record for an attribute type contain?”
Tell an agent
Get attribute value {attributevalueKey} of attribute type {key}.
Show value {attributevalueKey} defined under attribute type {key}.
GET
/api/v1/admin/attributetypes({key})/categoryattributetypes({categoryattributetypeKey})
Get a category link for an attribute type · Attribute types get category attribute type by key and categoryattributetypekey
#
Ask an LLM
“Which categories use a given attribute type?”
“Can I read one category assignment of an attribute type?”
Tell an agent
Get category attribute type {categoryattributetypeKey} for attribute type {key}.
Show the category link {categoryattributetypeKey} on attribute type {key}.
GET
/api/v1/admin/attributetypes({key})/customproperties({custompropertyKey})
Get a custom property on an attribute type · Attribute types get custom property by key and custompropertykey
#
Ask an LLM
“How can I read a custom property stored on an attribute type?”
“Can extra metadata on an attribute type be fetched by property id?”
Tell an agent
Get custom property {custompropertyKey} on attribute type {key}.
Read attribute type {key}'s custom field {custompropertyKey}.