Optimizely

Optimizely Customer Order Promotions API

The Customer Order Promotions API from Optimizely — 5 operation(s) for customer order promotions.

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/CustomerOrderPromotions List promotions applied to orders · Returns the EntitySet CustomerOrderPromotions #
Ask an LLM
“Which promotions have been applied to customer orders?”
“Can I filter applied promotions down to one order with OData?”
Tell an agent
List all promotions applied to customer orders.
List order promotions matching {filter}.
POST /api/v1/admin/CustomerOrderPromotions Apply a promotion to an order · Post a new entity to EntitySet CustomerOrderPromotions #
Ask an LLM
“How do I record a promotion against a customer order?”
“Can a promotion be applied to a single order line with a discount amount?”
Tell an agent
Apply promotion {promotionId} to order {customerOrderId}.
Apply promotion {promotionId} worth {amount} to order line {orderLineId}.
GET /api/v1/admin/CustomerOrderPromotions({id}) Get an applied order promotion · Returns the entity with the key from CustomerOrderPromotions #
Ask an LLM
“What discount amount did a particular order promotion record give?”
“Can I look up one applied promotion by its id?”
Tell an agent
Get order promotion {id}.
Fetch applied promotion record {id} expanding {expand}.
PUT /api/v1/admin/CustomerOrderPromotions({id}) Replace an applied order promotion · Replace entity in EntitySet CustomerOrderPromotions #
Ask an LLM
“How do I overwrite an order promotion record in full?”
“Can I resend order, promotion and amount to replace an applied promotion?”
Tell an agent
Replace order promotion {id} with promotion {promotionId} on order {customerOrderId}.
Overwrite the whole applied-promotion record {id} with amount {amount}.
DELETE /api/v1/admin/CustomerOrderPromotions({id}) Remove a promotion from an order · Delete entity in EntitySet CustomerOrderPromotions #
Ask an LLM
“How do I take a promotion off a customer order?”
“Can removing an order promotion be tied to an If-Match ETag?”
Tell an agent destructive · confirm first
Delete order promotion {id}.
Remove applied promotion {id} only if its ETag is {etag}.
PATCH /api/v1/admin/CustomerOrderPromotions({id}) Adjust an applied order promotion · Update entity in EntitySet CustomerOrderPromotions #
Ask an LLM
“Can I change just the discount amount on an applied promotion?”
“How do I move an applied promotion to a different order line?”
Tell an agent
Set the amount of order promotion {id} to {amount}.
Point order promotion {id} at order line {orderLineId}.
GET /api/v1/admin/CustomerOrderPromotions/Default.Default() Get default values for a new order promotion · Call operation Default #
Ask an LLM
“What defaults does a new order promotion record start with?”
“Is there a blank applied-promotion template?”
Tell an agent
Get the default template for an order promotion.
Fetch an empty customer order promotion with default values.
DELETE /api/v1/admin/customerorderpromotions/delete Bulk delete order promotions · Customer order promotions delete route #
Ask an LLM
“Can I remove many applied promotions in one request?”
“How do I bulk-delete order promotion records by id?”
Tell an agent destructive · confirm first
Bulk delete order promotions {ids}.
Permanently remove every applied promotion in {ids}.
GET /api/v1/admin/customerorderpromotions({key})/customproperties({custompropertyKey}) Get a custom property on an order promotion · Customer order promotions get custom property by key and custompropertykey #
Ask an LLM
“What custom property values are stored on an applied order promotion?”
“Can I read one custom attribute of an order promotion?”
Tell an agent
Get custom property {custompropertyKey} on order promotion {key}.
Read extra attribute {custompropertyKey} of applied promotion {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-customer-order-promotions-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-customer-order-promotions-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-customer-order-promotions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Customer Order Promotions API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Customer Order Promotions
paths:
  /api/v1/admin/CustomerOrderPromotions:
    get:
      tags:
      - Customer Order Promotions
      summary: Returns the EntitySet CustomerOrderPromotions
      operationId: CustomerOrderPromotions_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:
      - Customer Order Promotions
      summary: Post a new entity to EntitySet CustomerOrderPromotions
      operationId: CustomerOrderPromotions_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.CustomerOrderPromotion'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CustomerOrderPromotions({id}):
    get:
      tags:
      - Customer Order Promotions
      summary: Returns the entity with the key from CustomerOrderPromotions
      operationId: CustomerOrderPromotions_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:
      - Customer Order Promotions
      summary: Replace entity in EntitySet CustomerOrderPromotions
      operationId: CustomerOrderPromotions_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.CustomerOrderPromotion'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Customer Order Promotions
      summary: Delete entity in EntitySet CustomerOrderPromotions
      operationId: CustomerOrderPromotions_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:
      - Customer Order Promotions
      summary: Update entity in EntitySet CustomerOrderPromotions
      operationId: CustomerOrderPromotions_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.CustomerOrderPromotion'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CustomerOrderPromotions/Default.Default():
    get:
      tags:
      - Customer Order Promotions
      summary: Call operation Default
      operationId: CustomerOrderPromotions_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/customerorderpromotions/delete:
    delete:
      tags:
      - Customer Order Promotions
      operationId: CustomerOrderPromotions_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: Customer order promotions delete route
      x-summary-source: derived
  /api/v1/admin/customerorderpromotions({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Customer Order Promotions
      operationId: CustomerOrderPromotions_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: Customer order promotions get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.CustomerOrderPromotion:
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        customerOrderId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        promotionId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        orderLineId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        amount:
          format: double
          type: number
        promotionResultId:
          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