Optimizely

Optimizely Gift Card Transactions API

The Gift Card Transactions API from Optimizely — 5 operation(s) for gift card transactions.

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/GiftCardTransactions List gift card transactions · Returns the EntitySet GiftCardTransactions #
Ask an LLM
“How do I see all gift card transactions in the commerce admin?”
“Can I filter gift card transactions by gift card or order?”
Tell an agent
List all gift card transactions.
Find gift card transactions matching {filter}.
POST /api/v1/admin/GiftCardTransactions Record a gift card transaction · Post a new entity to EntitySet GiftCardTransactions #
Ask an LLM
“How do I log a gift card being used on an order?”
“Can I record the currency amount as well as the base amount?”
Tell an agent
Record a {amount} transaction on gift card {giftCardId} for order {customerOrderId}.
Log gift card {giftCardId} usage of {amount} on {transactionDate}.
GET /api/v1/admin/GiftCardTransactions({id}) Get a gift card transaction · Returns the entity with the key from GiftCardTransactions #
Ask an LLM
“How do I look up a single gift card transaction?”
“Which order and amount does a given gift card transaction cover?”
Tell an agent
Get gift card transaction {id}.
Show the amount and order for gift card transaction {id}.
PUT /api/v1/admin/GiftCardTransactions({id}) Replace a gift card transaction · Replace entity in EntitySet GiftCardTransactions #
Ask an LLM
“How do I overwrite a gift card transaction record in full?”
“Does a full replace reset transaction fields I leave out?”
Tell an agent
Replace gift card transaction {id} with amount {amount} on gift card {giftCardId}.
Overwrite all fields of gift card transaction {id}.
DELETE /api/v1/admin/GiftCardTransactions({id}) Delete a gift card transaction · Delete entity in EntitySet GiftCardTransactions #
Ask an LLM
“How do I delete a single gift card transaction?”
“Can I delete a transaction only if its ETag matches?”
Tell an agent destructive · confirm first
Delete gift card transaction {id}.
Delete gift card transaction {id} if its ETag is {etag}.
PATCH /api/v1/admin/GiftCardTransactions({id}) Update a gift card transaction · Update entity in EntitySet GiftCardTransactions #
Ask an LLM
“How do I correct the amount on a gift card transaction?”
“Can I change which order a gift card transaction belongs to?”
Tell an agent
Change the amount of gift card transaction {id} to {amount}.
Link gift card transaction {id} to order {customerOrderId}.
GET /api/v1/admin/GiftCardTransactions/Default.Default() Get a default gift card transaction template · Call operation Default #
Ask an LLM
“What default values does a new gift card transaction start with?”
“Can I fetch a blank gift card transaction template?”
Tell an agent
Fetch the default gift card transaction template.
Show me the defaults for a new gift card transaction.
DELETE /api/v1/admin/giftcardtransactions/delete Bulk delete gift card transactions · Gift card transactions delete route #
Ask an LLM
“How do I delete several gift card transactions at once?”
“Can I remove gift card transactions by a list of IDs?”
Tell an agent destructive · confirm first
Bulk delete gift card transactions {ids}.
Remove these gift card transactions in one call: {ids}.
GET /api/v1/admin/giftcardtransactions({key})/customproperties({custompropertyKey}) Get a custom property on a gift card transaction · Gift card transactions get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property stored on a gift card transaction?”
“Can I fetch one extra property from a gift card transaction?”
Tell an agent
Get custom property {custompropertyKey} on gift card transaction {key}.
Show gift card transaction {key}'s custom property {custompropertyKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-gift-card-transactions-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-gift-card-transactions-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-gift-card-transactions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Gift Card Transactions API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Gift Card Transactions
paths:
  /api/v1/admin/GiftCardTransactions:
    get:
      tags:
      - Gift Card Transactions
      summary: Returns the EntitySet GiftCardTransactions
      operationId: GiftCardTransactions_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:
      - Gift Card Transactions
      summary: Post a new entity to EntitySet GiftCardTransactions
      operationId: GiftCardTransactions_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.GiftCardTransaction'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/GiftCardTransactions({id}):
    get:
      tags:
      - Gift Card Transactions
      summary: Returns the entity with the key from GiftCardTransactions
      operationId: GiftCardTransactions_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:
      - Gift Card Transactions
      summary: Replace entity in EntitySet GiftCardTransactions
      operationId: GiftCardTransactions_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.GiftCardTransaction'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Gift Card Transactions
      summary: Delete entity in EntitySet GiftCardTransactions
      operationId: GiftCardTransactions_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:
      - Gift Card Transactions
      summary: Update entity in EntitySet GiftCardTransactions
      operationId: GiftCardTransactions_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.GiftCardTransaction'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/GiftCardTransactions/Default.Default():
    get:
      tags:
      - Gift Card Transactions
      summary: Call operation Default
      operationId: GiftCardTransactions_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/giftcardtransactions/delete:
    delete:
      tags:
      - Gift Card Transactions
      operationId: GiftCardTransactions_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: Gift card transactions delete route
      x-summary-source: derived
  /api/v1/admin/giftcardtransactions({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Gift Card Transactions
      operationId: GiftCardTransactions_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: Gift card transactions get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.GiftCardTransaction:
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        giftCardId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        customerOrderId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        amount:
          format: decimal
          type: number
        transactionDate:
          format: date-time
          type: string
        currencyAmount:
          format: double
          type: number
        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