Optimizely System List Values API

The System List Values API from Optimizely — 7 operation(s) for system list values.

Operations 11

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/SystemListValues List system list values · Returns the EntitySet SystemListValues #
Ask an LLM
“How do I see all the dropdown values stored in system lists in Optimizely Configured Commerce?”
“Can I filter system list values to one list and count them?”
Tell an agent
List all system list values.
List system list values matching {filter} with a total count.
POST /api/v1/admin/SystemListValues Add a value to a system list · Post a new entity to EntitySet SystemListValues #
Ask an LLM
“What's needed to add a new option to a system list?”
“Can I set a deactivation date on a system list value when I create it?”
Tell an agent
Add value {name} to system list {systemListId} with description {description}.
Create system list value {name} with additional info {additionalInfo}.
GET /api/v1/admin/SystemListValues({id}) Get one system list value · Returns the entity with the key from SystemListValues #
Ask an LLM
“How can I look up a single system list value by its ID?”
“Which fields can I select when reading one system list value?”
Tell an agent
Show system list value {id}.
Get system list value {id} with {expand} expanded.
PUT /api/v1/admin/SystemListValues({id}) Replace a system list value · Replace entity in EntitySet SystemListValues #
Ask an LLM
“Can I overwrite a system list value with a whole new record?”
“Do I need to resend the name and description when replacing a list value?”
Tell an agent
Replace system list value {id} with name {name} and description {description}.
Overwrite all fields of system list value {id}, moving it to list {systemListId}.
DELETE /api/v1/admin/SystemListValues({id}) Delete a system list value · Delete entity in EntitySet SystemListValues #
Ask an LLM
“How do I delete one value from a system list?”
“Can I delete a list value conditionally using an ETag?”
Tell an agent destructive · confirm first
Delete system list value {id}.
Delete system list value {id} only if its ETag is {etag}.
PATCH /api/v1/admin/SystemListValues({id}) Update part of a system list value · Update entity in EntitySet SystemListValues #
Ask an LLM
“Can I set just the deactivation date on an existing system list value?”
“How do I edit only the description of a list value?”
Tell an agent
Patch system list value {id} to deactivate on {deactivateOn}.
Update system list value {id} description to {description}.
GET /api/v1/admin/SystemListValues/Default.Default() Get default values for a system list value · Call operation Default #
Ask an LLM
“What defaults are pre-filled for a new system list value?”
“Is there a blank system list value template?”
Tell an agent
Get the default system list value template.
Show pre-filled values for a new system list value.
POST /api/v1/admin/SystemListValues/Default.archive Archive system list values (OData action) · Call operation archive #
Ask an LLM
“Can I archive list values with the Default.archive POST action?”
“How do I archive system list values using a POST call?”
Tell an agent
Archive system list values {ids} with the Default.archive action.
POST to the system list value archive action for {ids}.
DELETE /api/v1/admin/systemlistvalues/archive Archive system list values (DELETE route) · System list values archive route #
Ask an LLM
“Is there a DELETE systemlistvalues/archive route?”
“Which endpoint archives list values using the DELETE verb?”
Tell an agent destructive · confirm first
Archive system list values {ids} through the DELETE archive route.
Send a DELETE to systemlistvalues/archive for {ids}.
DELETE /api/v1/admin/systemlistvalues/delete Delete several system list values · System list values delete route #
Ask an LLM
“Can I bulk delete a set of system list values?”
“How do I permanently remove many list values at once?”
Tell an agent destructive · confirm first
Bulk delete system list values {ids}.
Permanently remove the system list values in {ids}.
GET /api/v1/admin/systemlistvalues({key})/customproperties({custompropertyKey}) Get a custom property on a system list value · System list values get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom property attached to a system list value?”
“Where are extra attributes on a list value stored?”
Tell an agent
Get custom property {custompropertyKey} on system list value {key}.
Show system list value {key}'s custom property {custompropertyKey}.

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-system-list-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-system-list-values-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 System List Values API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: System List Values
paths:
  /api/v1/admin/SystemListValues:
    get:
      tags:
      - System List Values
      summary: Returns the EntitySet SystemListValues
      operationId: SystemListValues_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:
      - System List Values
      summary: Post a new entity to EntitySet SystemListValues
      operationId: SystemListValues_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.SystemListValue'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SystemListValues({id}):
    get:
      tags:
      - System List Values
      summary: Returns the entity with the key from SystemListValues
      operationId: SystemListValues_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:
      - System List Values
      summary: Replace entity in EntitySet SystemListValues
      operationId: SystemListValues_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.SystemListValue'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - System List Values
      summary: Delete entity in EntitySet SystemListValues
      operationId: SystemListValues_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:
      - System List Values
      summary: Update entity in EntitySet SystemListValues
      operationId: SystemListValues_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.SystemListValue'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SystemListValues/Default.Default():
    get:
      tags:
      - System List Values
      summary: Call operation Default
      operationId: SystemListValues_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SystemListValues/Default.archive:
    post:
      tags:
      - System List Values
      summary: Call operation archive
      operationId: SystemListValues_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/systemlistvalues/archive:
    delete:
      tags:
      - System List Values
      operationId: SystemListValues_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: System list values archive route
      x-summary-source: derived
  /api/v1/admin/systemlistvalues/delete:
    delete:
      tags:
      - System List Values
      operationId: SystemListValues_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: System list values delete route
      x-summary-source: derived
  /api/v1/admin/systemlistvalues({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - System List Values
      operationId: SystemListValues_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: System list values get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.SystemListValue:
      required:
      - name
      - description
      - additionalInfo
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        name:
          maxLength: 256
          minLength: 0
          type: string
        description:
          maxLength: 1024
          minLength: 0
          type: string
        additionalInfo:
          maxLength: 1024
          minLength: 0
          type: string
        systemListId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        deactivateOn:
          format: date-time
          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