Optimizely Price Matrices API

The Price Matrices API from Optimizely — 7 operation(s) for price matrices.

Business capability
Price List Management BC-440.20

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/PriceMatrices List price matrices · Returns the EntitySet PriceMatrices #
Ask an LLM
“Which price matrix records are set up for customer and product pricing?”
“Can I filter price matrices by currency or warehouse?”
Tell an agent
List all price matrix records.
Find price matrices matching {filter}.
POST /api/v1/admin/PriceMatrices Create a price matrix · Post a new entity to EntitySet PriceMatrices #
Ask an LLM
“How do I set up quantity break pricing for a product in a price matrix?”
“Can a new price matrix be scheduled to activate on a future date?”
Tell an agent
Create a price matrix for product {productId} and customer {customerId} in currency {currencyCode}.
Add a price matrix with first break at quantity {breakQty01} priced {amount01}, active from {activateOn}.
GET /api/v1/admin/PriceMatrices({id}) Get a price matrix · Returns the entity with the key from PriceMatrices #
Ask an LLM
“What quantity breaks and amounts does a particular price matrix define?”
“When does a specific price matrix activate and expire?”
Tell an agent
Get price matrix {id}.
Show the break quantities and amounts of price matrix {id}.
PUT /api/v1/admin/PriceMatrices({id}) Replace a price matrix · Replace entity in EntitySet PriceMatrices #
Ask an LLM
“How do I overwrite an entire price matrix record at once?”
“Does replacing a price matrix reset break levels I do not send?”
Tell an agent
Replace price matrix {id} with a full record in currency {currencyCode}.
Overwrite price matrix {id} with record type {recordType} for product {productId}.
DELETE /api/v1/admin/PriceMatrices({id}) Delete a price matrix · Delete entity in EntitySet PriceMatrices #
Ask an LLM
“How do I permanently delete one price matrix?”
“Can I require an ETag match before a price matrix is deleted?”
Tell an agent destructive · confirm first
Delete price matrix {id}.
Delete price matrix {id} only if its ETag is {etag}.
PATCH /api/v1/admin/PriceMatrices({id}) Update a price matrix · Update entity in EntitySet PriceMatrices #
Ask an LLM
“Can I change the expiry date of a price matrix without resending it all?”
“How do I adjust just the first break amount on an existing price matrix?”
Tell an agent
Set price matrix {id} to deactivate on {deactivateOn}.
Change the first break amount on price matrix {id} to {amount01}.
GET /api/v1/admin/PriceMatrices/Default.Default() Get a blank price matrix template · Call operation Default #
Ask an LLM
“What default values does a new price matrix start with?”
“Is there an empty price matrix template I can fetch first?”
Tell an agent
Fetch the default price matrix template.
Show default field values for a new price matrix.
POST /api/v1/admin/PriceMatrices/Default.archive Archive price matrices via the archive action · Call operation archive #
Ask an LLM
“How do I archive old price matrices using the OData archive action?”
“Can I archive price matrices with a POST instead of deleting them?”
Tell an agent
Run the archive action on price matrices {ids}.
Archive price matrices {ids} through the Default.archive action.
DELETE /api/v1/admin/pricematrices/archive Archive price matrices via the DELETE route · Price matrices archive route #
Ask an LLM
“Is there a DELETE archive route that takes price matrices out of use?”
“What happens when I call the price matrix archive route with a list of IDs?”
Tell an agent destructive · confirm first
Archive price matrices {ids} using the DELETE archive route.
Send price matrices {ids} to the archive route to retire them.
DELETE /api/v1/admin/pricematrices/delete Bulk delete price matrices · Price matrices delete route #
Ask an LLM
“How do I permanently delete several price matrices at once?”
“Can I purge a batch of price matrices by ID rather than archive them?”
Tell an agent destructive · confirm first
Bulk delete price matrices {ids}.
Permanently remove these price matrices in one call: {ids}.
GET /api/v1/admin/pricematrices({key})/customproperties({custompropertyKey}) Get a custom property on a price matrix · Price matrices get custom property by key and custompropertykey #
Ask an LLM
“What value does a custom property hold on a specific price matrix?”
“Can I read one custom property from a price matrix record?”
Tell an agent
Get custom property {custompropertyKey} on price matrix {key}.
Show price matrix {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-price-matrices-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-price-matrices-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Price Matrices API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Price Matrices
paths:
  /api/v1/admin/PriceMatrices:
    get:
      tags:
      - Price Matrices
      summary: Returns the EntitySet PriceMatrices
      operationId: PriceMatrices_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:
      - Price Matrices
      summary: Post a new entity to EntitySet PriceMatrices
      operationId: PriceMatrices_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.PriceMatrix'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PriceMatrices({id}):
    get:
      tags:
      - Price Matrices
      summary: Returns the entity with the key from PriceMatrices
      operationId: PriceMatrices_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:
      - Price Matrices
      summary: Replace entity in EntitySet PriceMatrices
      operationId: PriceMatrices_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.PriceMatrix'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Price Matrices
      summary: Delete entity in EntitySet PriceMatrices
      operationId: PriceMatrices_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:
      - Price Matrices
      summary: Update entity in EntitySet PriceMatrices
      operationId: PriceMatrices_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.PriceMatrix'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PriceMatrices/Default.Default():
    get:
      tags:
      - Price Matrices
      summary: Call operation Default
      operationId: PriceMatrices_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PriceMatrices/Default.archive:
    post:
      tags:
      - Price Matrices
      summary: Call operation archive
      operationId: PriceMatrices_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/pricematrices/archive:
    delete:
      tags:
      - Price Matrices
      operationId: PriceMatrices_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: Price matrices archive route
      x-summary-source: derived
  /api/v1/admin/pricematrices/delete:
    delete:
      tags:
      - Price Matrices
      operationId: PriceMatrices_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: Price matrices delete route
      x-summary-source: derived
  /api/v1/admin/pricematrices({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Price Matrices
      operationId: PriceMatrices_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: Price matrices get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.PriceMatrix:
      required:
      - adjustmentType01
      - adjustmentType02
      - adjustmentType03
      - adjustmentType04
      - adjustmentType05
      - adjustmentType06
      - adjustmentType07
      - adjustmentType08
      - adjustmentType09
      - adjustmentType10
      - adjustmentType11
      - calculationFlags
      - currencyCode
      - customerKeyPart
      - priceBasis01
      - priceBasis02
      - priceBasis03
      - priceBasis04
      - priceBasis05
      - priceBasis06
      - priceBasis07
      - priceBasis08
      - priceBasis09
      - priceBasis10
      - priceBasis11
      - productKeyPart
      - recordType
      - unitOfMeasure
      - warehouse
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        activateOn:
          format: date-time
          type: string
        adjustmentType01:
          maxLength: 50
          minLength: 0
          type: string
        adjustmentType02:
          maxLength: 50
          minLength: 0
          type: string
        adjustmentType03:
          maxLength: 50
          minLength: 0
          type: string
        adjustmentType04:
          maxLength: 50
          minLength: 0
          type: string
        adjustmentType05:
          maxLength: 50
          minLength: 0
          type: string
        adjustmentType06:
          maxLength: 50
          minLength: 0
          type: string
        adjustmentType07:
          maxLength: 50
          minLength: 0
          type: string
        adjustmentType08:
          maxLength: 50
          minLength: 0
          type: string
        adjustmentType09:
          maxLength: 50
          minLength: 0
          type: string
        adjustmentType10:
          maxLength: 50
          minLength: 0
          type: string
        adjustmentType11:
          maxLength: 50
          minLength: 0
          type: string
        altAmount01:
          format: decimal
          type: number
        altAmount02:
          format: decimal
          type: number
        altAmount03:
          format: decimal
          type: number
        altAmount04:
          format: decimal
          type: number
        altAmount05:
          format: decimal
          type: number
        altAmount06:
          format: decimal
          type: number
        altAmount07:
          format: decimal
          type: number
        altAmount08:
          format: decimal
          type: number
        altAmount09:
          format: decimal
          type: number
        altAmount10:
          format: decimal
          type: number
        altAmount11:
          format: decimal
          type: number
        amount01:
          format: decimal
          type: number
        amount02:
          format: decimal
          type: number
        amount03:
          format: decimal
          type: number
        amount04:
          format: decimal
          type: number
        amount05:
          format: decimal
          type: number
        amount06:
          format: decimal
          type: number
        amount07:
          format: decimal
          type: number
        amount08:
          format: decimal
          type: number
        amount09:
          format: decimal
          type: number
        amount10:
          format: decimal
          type: number
        amount11:
          format: decimal
          type: number
        breakQty01:
          format: decimal
          type: number
        breakQty02:
          format: decimal
          type: number
        breakQty03:
          format: decimal
          type: number
        breakQty04:
          format: decimal
          type: number
        breakQty05:
          format: decimal
          type: number
        breakQty06:
          format: decimal
          type: number
        breakQty07:
          format: decimal
          type: number
        breakQty08:
          format: decimal
          type: number
        breakQty09:
          format: decimal
          type: number
        breakQty10:
          format: decimal
          type: number
        breakQty11:
          format: decimal
          type: number
        calculationFlags:
          maxLength: 50
          minLength: 0
          type: string
        currencyCode:
          maxLength: 50
          minLength: 0
          type: string
        customerKeyPart:
          maxLength: 50
          minLength: 0
          type: string
        deactivateOn:
          format: date-time
          type: string
        priceBasis01:
          maxLength: 50
          minLength: 0
          type: string
        priceBasis02:
          maxLength: 50
          minLength: 0
          type: string
        priceBasis03:
          maxLength: 50
          minLength: 0
          type: string
        priceBasis04:
          maxLength: 50
          minLength: 0
          type: string
        priceBasis05:
          maxLength: 50
          minLength: 0
          type: string
        priceBasis06:
          maxLength: 50
          minLength: 0
          type: string
        priceBasis07:
          maxLength: 50
          minLength: 0
          type: string
        priceBasis08:
          maxLength: 50
          minLength: 0
          type: string
        priceBasis09:
          maxLength: 50
          minLength: 0
          type: string
        priceBasis10:
          maxLength: 50
          minLength: 0
          type: string
        priceBasis11:
          maxLength: 50
          minLength: 0
          type: string
        productKeyPart:
          maxLength: 50
          minLength: 0
          type: string
        recordType:
          maxLength: 50
          minLength: 0
          type: string
        unitOfMeasure:
          maxLength: 50
          minLength: 0
          type: string
        warehouse:
          maxLength: 50
          minLength: 0
          type: string
        customerId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        productId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        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