Optimizely

Optimizely Promotion Result Products API

The Promotion Result Products API from Optimizely — 5 operation(s) for promotion result products.

GitHub OpenAPI

Operations 9

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/PromotionResultProducts List promotion result products · Returns the EntitySet PromotionResultProducts #
Ask an LLM
“Which products are tied to my promotion results, like free-gift items?”
“Can I filter promotion result products to a single promotion result?”
Tell an agent
List all promotion result products.
List promotion result products where {filter}.
POST /api/v1/admin/PromotionResultProducts Attach a product to a promotion result · Post a new entity to EntitySet PromotionResultProducts #
Ask an LLM
“How do I link a product to a promotion's outcome?”
“Can I add a product to an existing promotion result?”
Tell an agent
Attach product {productId} to promotion result {promotionResultId}.
Create a promotion result product for result {promotionResultId}.
GET /api/v1/admin/PromotionResultProducts({id}) Get a promotion result product by id · Returns the entity with the key from PromotionResultProducts #
Ask an LLM
“Which product and promotion result does one link record connect?”
“Can I look up a single promotion result product by id?”
Tell an agent
Get promotion result product {id}.
Fetch promotion result product {id} with {expand} expanded.
PUT /api/v1/admin/PromotionResultProducts({id}) Replace a promotion result product · Replace entity in EntitySet PromotionResultProducts #
Ask an LLM
“How do I overwrite a promotion result product record entirely?”
“What does a full replace of a promotion result product need?”
Tell an agent
Replace promotion result product {id} with product {productId} and result {promotionResultId}.
Overwrite the full promotion result product record {id}.
DELETE /api/v1/admin/PromotionResultProducts({id}) Remove a product from a promotion result · Delete entity in EntitySet PromotionResultProducts #
Ask an LLM
“Can I unlink one product from a promotion result by id?”
“Does deleting a promotion result product accept an If-Match ETag?”
Tell an agent destructive · confirm first
Delete promotion result product {id}.
Delete promotion result product {id} if its ETag is {etag}.
PATCH /api/v1/admin/PromotionResultProducts({id}) Swap the product on a promotion result link · Update entity in EntitySet PromotionResultProducts #
Ask an LLM
“How do I change which product a promotion result points to?”
“Can I move a promotion result product to a different result without a full replace?”
Tell an agent
Change promotion result product {id} to product {productId}.
Move promotion result product {id} to result {promotionResultId}.
GET /api/v1/admin/PromotionResultProducts/Default.Default() Get a blank promotion result product template · Call operation Default #
Ask an LLM
“What default values does a new promotion result product have?”
“Is there an empty promotion result product template?”
Tell an agent
Get the default promotion result product template.
Show the defaults for a new promotion result product.
DELETE /api/v1/admin/promotionresultproducts/delete Bulk delete promotion result products · Promotion result products delete route #
Ask an LLM
“Can I remove many promotion result products in one call?”
“How do I delete a list of promotion result products by id?”
Tell an agent destructive · confirm first
Bulk delete promotion result products {ids}.
Remove the promotion result products with ids {ids}.
GET /api/v1/admin/promotionresultproducts({key})/customproperties({custompropertyKey}) Get a custom property of a promotion result product · Promotion result products get custom property by key and custompropertykey #
Ask an LLM
“What custom property values are stored on a promotion result product?”
“Can I read one extension field from a promotion result product?”
Tell an agent
Get custom property {custompropertyKey} of promotion result product {key}.
Read custom field {custompropertyKey} on promotion result product {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-promotion-result-products-api-openapi.yml

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-promotion-result-products-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.

GitHub Google LinkedIn

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

OpenAPI Specification

optimizely-promotion-result-products-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Promotion Result Products API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Promotion Result Products
paths:
  /api/v1/admin/PromotionResultProducts:
    get:
      tags:
      - Promotion Result Products
      summary: Returns the EntitySet PromotionResultProducts
      operationId: PromotionResultProducts_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:
      - Promotion Result Products
      summary: Post a new entity to EntitySet PromotionResultProducts
      operationId: PromotionResultProducts_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.PromotionResultProduct'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PromotionResultProducts({id}):
    get:
      tags:
      - Promotion Result Products
      summary: Returns the entity with the key from PromotionResultProducts
      operationId: PromotionResultProducts_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:
      - Promotion Result Products
      summary: Replace entity in EntitySet PromotionResultProducts
      operationId: PromotionResultProducts_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.PromotionResultProduct'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Promotion Result Products
      summary: Delete entity in EntitySet PromotionResultProducts
      operationId: PromotionResultProducts_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:
      - Promotion Result Products
      summary: Update entity in EntitySet PromotionResultProducts
      operationId: PromotionResultProducts_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.PromotionResultProduct'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PromotionResultProducts/Default.Default():
    get:
      tags:
      - Promotion Result Products
      summary: Call operation Default
      operationId: PromotionResultProducts_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/promotionresultproducts/delete:
    delete:
      tags:
      - Promotion Result Products
      operationId: PromotionResultProducts_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: Promotion result products delete route
      x-summary-source: derived
  /api/v1/admin/promotionresultproducts({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Promotion Result Products
      operationId: PromotionResultProducts_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: Promotion result products get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.PromotionResultProduct:
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        promotionResultId:
          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
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query