Optimizely Attribute Values API

The Attribute Values API from Optimizely — 11 operation(s) for attribute values.

Operations 15

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/AttributeValues List product attribute values · Returns the EntitySet AttributeValues #
Ask an LLM
“What attribute values, like Red or Large, exist in my commerce catalog?”
“Can I filter attribute values to only active ones for a given attribute type?”
Tell an agent
List all attribute values.
List attribute values where {filter}, sorted by {orderby}.
POST /api/v1/admin/AttributeValues Create an attribute value · Post a new entity to EntitySet AttributeValues #
Ask an LLM
“How do I add a new option such as Navy to an existing product attribute?”
“Can I set the display sort order when creating an attribute value?”
Tell an agent
Create attribute value {value} under attribute type {attributeTypeId}.
Add attribute value {value} with sort order {sortOrder}.
GET /api/v1/admin/AttributeValues({id}) Get an attribute value by id · Returns the entity with the key from AttributeValues #
Ask an LLM
“Can I look up a single attribute value record by its id?”
“Which attribute type does a particular attribute value belong to?”
Tell an agent
Get attribute value {id}.
Fetch attribute value {id} with {expand} expanded.
PUT /api/v1/admin/AttributeValues({id}) Replace an attribute value · Replace entity in EntitySet AttributeValues #
Ask an LLM
“Is there a way to overwrite every field of an attribute value in one call?”
“What must I send to fully replace an existing attribute value record?”
Tell an agent
Replace attribute value {id} with value {value}.
Overwrite the whole attribute value record {id} with value {value} and active flag {isActive}.
DELETE /api/v1/admin/AttributeValues({id}) Delete an attribute value · Delete entity in EntitySet AttributeValues #
Ask an LLM
“Can I permanently delete one attribute value by its id?”
“Does deleting a single attribute value support an If-Match ETag check?”
Tell an agent destructive · confirm first
Delete attribute value {id}.
Delete attribute value {id} only if its ETag is {etag}.
PATCH /api/v1/admin/AttributeValues({id}) Update fields on an attribute value · Update entity in EntitySet AttributeValues #
Ask an LLM
“How do I deactivate an attribute value without resending the whole record?”
“Can I just change the sort position of one attribute value?”
Tell an agent
Set attribute value {id} active flag to {isActive}.
Change the sort order of attribute value {id} to {sortOrder}.
GET /api/v1/admin/AttributeValues/Default.Default() Get a blank attribute value template · Call operation Default #
Ask an LLM
“What default fields does a new attribute value start with?”
“Is there an empty attribute value template I can fill in before creating one?”
Tell an agent
Get the default attribute value template.
Show me the default values for a new attribute value.
POST /api/v1/admin/AttributeValues/Default.archive Archive attribute values via the archive action · Call operation archive #
Ask an LLM
“Can I archive attribute values with the POST archive action instead of deleting them?”
“How do I retire several attribute values through the Default.archive operation?”
Tell an agent
Archive attribute values {ids} using the archive action.
Run the POST archive action on attribute values {ids}.
GET /api/v1/admin/attributevalues/forproduct(productId={productId}) List attribute values available for a product · Attribute values get attribute values available by productid #
Ask an LLM
“Which attribute values can be assigned to a specific product?”
“Can I include or exclude archived values when listing a product's available attribute values?”
Tell an agent
List attribute values available for product {productId}.
Show attribute values for product {productId} with archive filter {archiveFilter}.
DELETE /api/v1/admin/attributevalues/archive Archive attribute values via the archive route · Attribute values archive route #
Ask an LLM
“Is there a DELETE route that archives a batch of attribute values by id?”
“Can I send a list of ids to the attribute values archive endpoint?”
Tell an agent destructive · confirm first
Archive attribute values {ids} through the DELETE archive route.
Send ids {ids} to the attribute values archive route.
DELETE /api/v1/admin/attributevalues/delete Bulk delete attribute values · Attribute values delete route #
Ask an LLM
“Can I permanently delete many attribute values in one request?”
“How do I remove a list of attribute values by their ids all at once?”
Tell an agent destructive · confirm first
Bulk delete attribute values {ids}.
Permanently remove the attribute values with ids {ids}.
GET /api/v1/admin/attributevalues({key})/badges({badgeKey}) Get a badge linked to an attribute value · Attribute values get badge by key and badgekey #
Ask an LLM
“Which badge is attached to a particular attribute value?”
“Can I fetch one badge through the attribute value it is linked to?”
Tell an agent
Get badge {badgeKey} on attribute value {key}.
Show the badge {badgeKey} linked to attribute value {key} with only {select}.
GET /api/v1/admin/attributevalues({key})/categories({categoryKey}) Get a category linked to an attribute value · Attribute values get category by key and categorykey #
Ask an LLM
“Which catalog category is associated with a given attribute value?”
“Can I read one category through its attribute value relationship?”
Tell an agent
Get category {categoryKey} for attribute value {key}.
Fetch category {categoryKey} under attribute value {key} expanding {expand}.
GET /api/v1/admin/attributevalues({key})/customproperties({custompropertyKey}) Get a custom property of an attribute value · Attribute values get custom property by key and custompropertykey #
Ask an LLM
“What custom property values are stored on an attribute value?”
“Can I read one extension field from an attribute value?”
Tell an agent
Get custom property {custompropertyKey} of attribute value {key}.
Read the custom field {custompropertyKey} on attribute value {key}.
GET /api/v1/admin/attributevalues({key})/products({productKey}) Get a product tagged with an attribute value · Attribute values get product by key and productkey #
Ask an LLM
“Is a specific product tagged with this attribute value?”
“Can I fetch one product through the attribute value it carries?”
Tell an agent
Get product {productKey} under attribute value {key}.
Show product {productKey} linked to attribute value {key} with {expand} expanded.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/optimizely:optimizely-attribute-values-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optimizely-attribute-values-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Attribute Values API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Attribute Values
paths:
  /api/v1/admin/AttributeValues:
    get:
      tags:
      - Attribute Values
      summary: Returns the EntitySet AttributeValues
      operationId: AttributeValues_Get
      parameters:
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results, based on a Boolean condition.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      - name: $apply
        in: query
        description: Aggregates the results according to one or more transformations.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Returns only the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $skip
        in: query
        description: Skips the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $count
        in: query
        description: Includes a count of the matching results in the response.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    post:
      tags:
      - Attribute Values
      summary: Post a new entity to EntitySet AttributeValues
      operationId: AttributeValues_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.AttributeValue'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/AttributeValues({id}):
    get:
      tags:
      - Attribute Values
      summary: Returns the entity with the key from AttributeValues
      operationId: AttributeValues_GetById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    put:
      tags:
      - Attribute Values
      summary: Replace entity in EntitySet AttributeValues
      operationId: AttributeValues_PutById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.AttributeValue'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Attribute Values
      summary: Delete entity in EntitySet AttributeValues
      operationId: AttributeValues_DeleteById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: If-Match
        in: header
        description: If-Match header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    patch:
      tags:
      - Attribute Values
      summary: Update entity in EntitySet AttributeValues
      operationId: AttributeValues_PatchById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.AttributeValue'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/AttributeValues/Default.Default():
    get:
      tags:
      - Attribute Values
      summary: Call operation Default
      operationId: AttributeValues_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/AttributeValues/Default.archive:
    post:
      tags:
      - Attribute Values
      summary: Call operation archive
      operationId: AttributeValues_Archive
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      requestBody:
        $ref: '#/components/requestBodies/Affiliates_ArchiveParameters'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/attributevalues/forproduct(productId={productId}):
    get:
      tags:
      - Attribute Values
      operationId: AttributeValues_GetAttributeValuesAvailableByProductid
      parameters:
      - name: productId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: archiveFilter
        in: query
        required: false
        schema:
          type: integer
          format: int32
          enum:
          - 0
          - 1
          - 2
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Attribute values get attribute values available by productid
      x-summary-source: derived
  /api/v1/admin/attributevalues/archive:
    delete:
      tags:
      - Attribute Values
      operationId: AttributeValues_ArchiveRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Attribute values archive route
      x-summary-source: derived
  /api/v1/admin/attributevalues/delete:
    delete:
      tags:
      - Attribute Values
      operationId: AttributeValues_DeleteRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Attribute values delete route
      x-summary-source: derived
  /api/v1/admin/attributevalues({key})/badges({badgeKey}):
    get:
      tags:
      - Attribute Values
      operationId: AttributeValues_GetBadgeByKeyAndBadgekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: badgeKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Attribute values get badge by key and badgekey
      x-summary-source: derived
  /api/v1/admin/attributevalues({key})/categories({categoryKey}):
    get:
      tags:
      - Attribute Values
      operationId: AttributeValues_GetCategoryByKeyAndCategorykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: categoryKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Attribute values get category by key and categorykey
      x-summary-source: derived
  /api/v1/admin/attributevalues({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Attribute Values
      operationId: AttributeValues_GetCustomPropertyByKeyAndCustompropertykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: custompropertyKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Attribute values get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/attributevalues({key})/products({productKey}):
    get:
      tags:
      - Attribute Values
      operationId: AttributeValues_GetProductByKeyAndProductkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: productKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Attribute values get product by key and productkey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.AttributeValue:
      required:
      - value
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        attributeTypeId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        isActive:
          type: boolean
        sortOrder:
          format: int32
          type: integer
        value:
          maxLength: 255
          minLength: 0
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  requestBodies:
    Affiliates_ArchiveParameters:
      content:
        application/json:
          schema:
            type: object
            properties: {}
      description: archive action parameters
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query