Optimizely Wish Lists API

The Wish Lists API from Optimizely — 18 operation(s) for wish lists.

Operations 22

GET /api/v1/admin/WishLists Returns the EntitySet WishLists #
POST /api/v1/admin/WishLists Post a new entity to EntitySet WishLists #
GET /api/v1/admin/WishLists({id}) Returns the entity with the key from WishLists #
PUT /api/v1/admin/WishLists({id}) Replace entity in EntitySet WishLists #
DELETE /api/v1/admin/WishLists({id}) Delete entity in EntitySet WishLists #
PATCH /api/v1/admin/WishLists({id}) Update entity in EntitySet WishLists #
GET /api/v1/admin/WishLists/Default.Default() Call operation Default #
POST /api/v1/admin/WishLists/Default.archive Call operation archive #
GET /api/v1/admin/WishLists({id})/Default.DynamicProducts() Call operation DynamicProducts #
GET /api/v1/admin/wishlists({key})/dynamicproducts #
DELETE /api/v1/admin/wishlists/archive #
DELETE /api/v1/admin/wishlists/delete #
GET /api/v1/admin/wishlists({key})/customeradditions({customerKey}) #
GET /api/v1/admin/wishlists({key})/customerexceptions({customerKey}) #
GET /api/v1/admin/wishlists({key})/customproperties({custompropertyKey}) #
GET /api/v1/admin/wishlists({key})/globalcustomers({customerKey}) #
GET /api/v1/admin/wishlists({key})/userprofilewishlistfavorites({userprofilewishlistfavoriteKey}) #
GET /api/v1/admin/wishlists({key})/userprofilewishlisthides({userprofilewishlisthideKey}) #
GET /api/v1/admin/wishlists({key})/userprofilewishlisttags({userprofilewishlisttagKey}) #
GET /api/v1/admin/wishlists({key})/wishlistemailschedules({wishlistemailscheduleKey}) #
GET /api/v1/admin/wishlists({key})/wishlistproducts({wishlistproductKey}) #
GET /api/v1/admin/wishlists({key})/wishlistshares({wishlistshareKey}) #

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-wish-lists-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 email required.

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

OpenAPI Specification

optimizely-wish-lists-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Wish Lists API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Wish Lists
paths:
  /api/v1/admin/WishLists:
    get:
      tags:
      - Wish Lists
      summary: Returns the EntitySet WishLists
      operationId: WishLists_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:
      - Wish Lists
      summary: Post a new entity to EntitySet WishLists
      operationId: WishLists_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.WishList'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/WishLists({id}):
    get:
      tags:
      - Wish Lists
      summary: Returns the entity with the key from WishLists
      operationId: WishLists_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:
      - Wish Lists
      summary: Replace entity in EntitySet WishLists
      operationId: WishLists_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.WishList'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Wish Lists
      summary: Delete entity in EntitySet WishLists
      operationId: WishLists_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:
      - Wish Lists
      summary: Update entity in EntitySet WishLists
      operationId: WishLists_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.WishList'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/WishLists/Default.Default():
    get:
      tags:
      - Wish Lists
      summary: Call operation  Default
      operationId: WishLists_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/WishLists/Default.archive:
    post:
      tags:
      - Wish Lists
      summary: Call operation  archive
      operationId: WishLists_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/WishLists({id})/Default.DynamicProducts():
    get:
      tags:
      - Wish Lists
      summary: Call operation  DynamicProducts
      operationId: WishLists_GetDynamicProductsById
      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: []
  /api/v1/admin/wishlists({key})/dynamicproducts:
    get:
      tags:
      - Wish Lists
      operationId: WishLists_GetDynamicProductsByKey
      parameters:
      - name: key
        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: []
  /api/v1/admin/wishlists/archive:
    delete:
      tags:
      - Wish Lists
      operationId: WishLists_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: []
  /api/v1/admin/wishlists/delete:
    delete:
      tags:
      - Wish Lists
      operationId: WishLists_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: []
  /api/v1/admin/wishlists({key})/customeradditions({customerKey}):
    get:
      tags:
      - Wish Lists
      operationId: WishLists_GetCustomerAdditionByKeyAndCustomerkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: customerKey
        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: []
  /api/v1/admin/wishlists({key})/customerexceptions({customerKey}):
    get:
      tags:
      - Wish Lists
      operationId: WishLists_GetCustomerExceptionByKeyAndCustomerkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: customerKey
        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: []
  /api/v1/admin/wishlists({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Wish Lists
      operationId: WishLists_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: []
  /api/v1/admin/wishlists({key})/globalcustomers({customerKey}):
    get:
      tags:
      - Wish Lists
      operationId: WishLists_GetGlobalCustomerByKeyAndCustomerkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: customerKey
        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: []
  /api/v1/admin/wishlists({key})/userprofilewishlistfavorites({userprofilewishlistfavoriteKey}):
    get:
      tags:
      - Wish Lists
      operationId: WishLists_GetUserProfileWishListFavoriteByKeyAndUserprofilewishlistfavoritekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: userprofilewishlistfavoriteKey
        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: []
  /api/v1/admin/wishlists({key})/userprofilewishlisthides({userprofilewishlisthideKey}):
    get:
      tags:
      - Wish Lists
      operationId: WishLists_GetUserProfileWishListHideByKeyAndUserprofilewishlisthidekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: userprofilewishlisthideKey
        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: []
  /api/v1/admin/wishlists({key})/userprofilewishlisttags({userprofilewishlisttagKey}):
    get:
      tags:
      - Wish Lists
      operationId: WishLists_GetUserProfileWishListTagByKeyAndUserprofilewishlisttagkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: userprofilewishlisttagKey
        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: []
  /api/v1/admin/wishlists({key})/wishlistemailschedules({wishlistemailscheduleKey}):
    get:
      tags:
      - Wish Lists
      operationId: WishLists_GetWishListEmailScheduleByKeyAndWishlistemailschedulekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: wishlistemailscheduleKey
        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: []
  /api/v1/admin/wishlists({key})/wishlistproducts({wishlistproductKey}):
    get:
      tags:
      - Wish Lists
      operationId: WishLists_GetWishListProductByKeyAndWishlistproductkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: wishlistproductKey
        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: []
  /api/v1/admin/wishlists({key})/wishlistshares({wishlistshareKey}):
    get:
      tags:
      - Wish Lists
      operationId: WishLists_GetWishListShareByKeyAndWishlistsharekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: wishlistshareKey
        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: []
components:
  requestBodies:
    Affiliates_ArchiveParameters:
      content:
        application/json:
          schema:
            type: object
            properties: {}
      description: archive action parameters
  schemas:
    Insite.Data.Entities.WishList:
      required:
      - name
      - shareOption
      - description
      - sharedBy
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        userProfileId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        customerId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        name:
          maxLength: 255
          minLength: 0
          type: string
        modifiedByUserProfileId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        allowEdit:
          type: boolean
        shareOption:
          maxLength: 50
          minLength: 0
          type: string
        description:
          maxLength: 300
          minLength: 0
          type: string
        sharedBy:
          maxLength: 100
          minLength: 0
          type: string
        isGlobal:
          type: boolean
        isDynamic:
          type: boolean
        isDynamicCustomers:
          type: boolean
        ruleManagerId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        ruleManagerCustomersId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        activateOn:
          format: date-time
          type: string
        deactivateOn:
          format: date-time
          type: string
        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