Optimizely

Optimizely Gift Cards API

The Gift Cards API from Optimizely — 9 operation(s) for gift cards.

GitHub OpenAPI

Operations 13

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/GiftCards List gift cards · Returns the EntitySet GiftCards #
Ask an LLM
“Which gift cards have been issued in Optimizely Commerce?”
“Can I filter gift cards to only active ones that haven't expired?”
Tell an agent
List all gift cards.
Show gift cards matching {filter}.
POST /api/v1/admin/GiftCards Issue a new gift card · Post a new entity to EntitySet GiftCards #
Ask an LLM
“What details are required to issue a gift card to someone?”
“Can I set an amount and expiry date when creating a gift card?”
Tell an agent
Issue gift card {giftCardNumber} with PIN {pin} to {firstName} {lastName} at {email}.
Create a {giftCardType} gift card worth {amount} expiring {expiresOn}.
GET /api/v1/admin/GiftCards({id}) Get one gift card · Returns the entity with the key from GiftCards #
Ask an LLM
“What is the balance and expiry of a specific gift card?”
“Can I pull up one gift card record by its id?”
Tell an agent
Fetch gift card {id}.
Show the amount and recipient of gift card {id}.
PUT /api/v1/admin/GiftCards({id}) Replace a gift card record · Replace entity in EntitySet GiftCards #
Ask an LLM
“Can I overwrite a whole gift card record at once?”
“Does replacing a gift card require resending its number, PIN and recipient?”
Tell an agent
Replace gift card {id} with number {giftCardNumber} and PIN {pin}.
Overwrite the full record of gift card {id}.
DELETE /api/v1/admin/GiftCards({id}) Delete one gift card · Delete entity in EntitySet GiftCards #
Ask an LLM
“How do I remove a single gift card record?”
“Can deleting a gift card be conditional on its ETag?”
Tell an agent destructive · confirm first
Delete gift card {id}.
Delete gift card {id} only if its ETag is {etag}.
PATCH /api/v1/admin/GiftCards({id}) Update part of a gift card · Update entity in EntitySet GiftCards #
Ask an LLM
“Can I deactivate a gift card without deleting it?”
“Is it possible to extend just the expiry date of a gift card?”
Tell an agent
Set gift card {id} active flag to {isActive}.
Extend gift card {id} to expire on {expiresOn}.
GET /api/v1/admin/GiftCards/Default.Default() Get default values for a new gift card · Call operation Default #
Ask an LLM
“What defaults does a new gift card record start with?”
“Is there a blank gift card template to fill in?”
Tell an agent
Get the default field values for a new gift card.
Show the empty gift card template.
POST /api/v1/admin/GiftCards/Default.archive Archive gift cards via the OData archive action · Call operation archive #
Ask an LLM
“Can I retire gift cards with the OData Default.archive action?”
“What does calling the gift card archive action do to the cards I pass?”
Tell an agent destructive · confirm first
Run the OData archive action on gift cards {ids}.
Archive gift cards {ids} with Default.archive.
DELETE /api/v1/admin/giftcards/archive Archive gift cards through the archive route · Gift cards archive route #
Ask an LLM
“Is there a REST route for archiving a batch of gift cards?”
“What does a DELETE on giftcards/archive do?”
Tell an agent destructive · confirm first
Archive gift cards {ids} using the giftcards/archive route.
Send the batch archive request for gift cards {ids}.
DELETE /api/v1/admin/giftcards/delete Permanently delete several gift cards · Gift cards delete route #
Ask an LLM
“Can I bulk delete a list of gift cards?”
“Is there a way to permanently remove many gift cards in one request?”
Tell an agent destructive · confirm first
Bulk delete gift cards {ids}.
Permanently delete every gift card in {ids}.
GET /api/v1/admin/giftcards({key})/customerorders({customerorderKey}) Get an order a gift card was used on · Gift cards get customer order by key and customerorderkey #
Ask an LLM
“Which customer orders has a gift card been applied to?”
“Can I read one order linked to a gift card?”
Tell an agent
Get order {customerorderKey} linked to gift card {key}.
Show customer order {customerorderKey} that used gift card {key}.
GET /api/v1/admin/giftcards({key})/customproperties({custompropertyKey}) Get a custom property on a gift card · Gift cards get custom property by key and custompropertykey #
Ask an LLM
“How can I read a custom property stored on a gift card?”
“Can I fetch one custom field value from a gift card record?”
Tell an agent
Get custom property {custompropertyKey} of gift card {key}.
Show the {custompropertyKey} custom property on gift card {key}.
GET /api/v1/admin/giftcards({key})/giftcardtransactions({giftcardtransactionKey}) Get a transaction on a gift card · Gift cards get gift card transaction by key and giftcardtransactionkey #
Ask an LLM
“Where can I see a redemption or top-up transaction on a gift card?”
“Can I look up one gift card transaction by key?”
Tell an agent
Get transaction {giftcardtransactionKey} of gift card {key}.
Show gift card transaction {giftcardtransactionKey} for card {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-gift-cards-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-cards-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-cards-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Gift Cards API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Gift Cards
paths:
  /api/v1/admin/GiftCards:
    get:
      tags:
      - Gift Cards
      summary: Returns the EntitySet GiftCards
      operationId: GiftCards_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 Cards
      summary: Post a new entity to EntitySet GiftCards
      operationId: GiftCards_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.GiftCard'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/GiftCards({id}):
    get:
      tags:
      - Gift Cards
      summary: Returns the entity with the key from GiftCards
      operationId: GiftCards_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 Cards
      summary: Replace entity in EntitySet GiftCards
      operationId: GiftCards_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.GiftCard'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Gift Cards
      summary: Delete entity in EntitySet GiftCards
      operationId: GiftCards_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 Cards
      summary: Update entity in EntitySet GiftCards
      operationId: GiftCards_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.GiftCard'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/GiftCards/Default.Default():
    get:
      tags:
      - Gift Cards
      summary: Call operation Default
      operationId: GiftCards_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/GiftCards/Default.archive:
    post:
      tags:
      - Gift Cards
      summary: Call operation archive
      operationId: GiftCards_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/giftcards/archive:
    delete:
      tags:
      - Gift Cards
      operationId: GiftCards_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: Gift cards archive route
      x-summary-source: derived
  /api/v1/admin/giftcards/delete:
    delete:
      tags:
      - Gift Cards
      operationId: GiftCards_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 cards delete route
      x-summary-source: derived
  /api/v1/admin/giftcards({key})/customerorders({customerorderKey}):
    get:
      tags:
      - Gift Cards
      operationId: GiftCards_GetCustomerOrderByKeyAndCustomerorderkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: customerorderKey
        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 cards get customer order by key and customerorderkey
      x-summary-source: derived
  /api/v1/admin/giftcards({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Gift Cards
      operationId: GiftCards_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 cards get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/giftcards({key})/giftcardtransactions({giftcardtransactionKey}):
    get:
      tags:
      - Gift Cards
      operationId: GiftCards_GetGiftCardTransactionByKeyAndGiftcardtransactionkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: giftcardtransactionKey
        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 cards get gift card transaction by key and giftcardtransactionkey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.GiftCard:
      required:
      - email
      - firstName
      - giftCardNumber
      - giftCardType
      - lastName
      - pin
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        amount:
          format: decimal
          type: number
        conversionRate:
          format: double
          type: number
        currencyAmount:
          format: double
          type: number
        currencyId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        email:
          maxLength: 255
          minLength: 0
          type: string
        expiresOn:
          format: date-time
          type: string
        firstName:
          maxLength: 100
          minLength: 0
          type: string
        giftCardNumber:
          maxLength: 50
          minLength: 0
          type: string
        giftCardType:
          maxLength: 50
          minLength: 0
          type: string
        isActive:
          type: boolean
        lastName:
          maxLength: 100
          minLength: 0
          type: string
        orderLineId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        pin:
          maxLength: 50
          minLength: 0
          type: string
        purchasedOn:
          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