Optimizely

Optimizely Wishlists API

The Wishlists API from Optimizely — 12 operation(s) for wishlists.

GitHub OpenAPI

Operations 42

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/WishLists List and filter wish lists · Returns the EntitySet WishLists #
Ask an LLM
“How can I see every wish list in my commerce admin?”
“Can I filter wish lists by name or sort them by creation date?”
Tell an agent
List all wish lists.
List wish lists matching the filter {filter}, top {top} results.
POST /api/v1/admin/WishLists Create a wish list · Post a new entity to EntitySet WishLists #
Ask an LLM
“How do I create a new wish list for a customer through the admin API?”
“What fields are required when I add a wish list, like name and share option?”
Tell an agent
Create a wish list named {name} described as {description}, shared by {sharedBy} with share option {shareOption}.
Add a new wish list called {name} for customer {customerId}.
GET /api/v1/admin/WishLists({id}) Get one wish list by id · Returns the entity with the key from WishLists #
Ask an LLM
“How can I look up a single wish list when I know its id?”
“Can I expand related products when fetching one wish list?”
Tell an agent
Show me wish list {id}.
Fetch wish list {id} with {expand} expanded.
PUT /api/v1/admin/WishLists({id}) Replace a wish list entirely · Replace entity in EntitySet WishLists #
Ask an LLM
“How do I overwrite every field of an existing wish list in one request?”
“Will a full replace of a wish list reset fields I leave out?”
Tell an agent
Replace wish list {id} with name {name}, description {description}, share option {shareOption} and sharer {sharedBy}.
Overwrite the whole record of wish list {id}.
DELETE /api/v1/admin/WishLists({id}) Delete one wish list · Delete entity in EntitySet WishLists #
Ask an LLM
“How do I permanently remove one specific wish list?”
“Can I guard a wish list delete with an ETag so I don't remove a changed record?”
Tell an agent destructive · confirm first
Delete wish list {id}.
Remove wish list {id} only if its ETag still matches {etag}.
PATCH /api/v1/admin/WishLists({id}) Update some fields of a wish list · Update entity in EntitySet WishLists #
Ask an LLM
“How can I just rename a wish list without resending the whole thing?”
“Can I change only the activation dates on an existing wish list?”
Tell an agent
Rename wish list {id} to {name}.
Set wish list {id} to deactivate on {deactivateOn}.
GET /api/v1/admin/WishLists/Default.Default() Get default values for a new wish list · Call operation Default #
Ask an LLM
“What default values does a brand-new wish list start with?”
“Where can I get a blank wish list template before creating one?”
Tell an agent
Fetch the default wish list template.
Show the starting defaults the admin API uses for new wish lists.
POST /api/v1/admin/WishLists/Default.archive Archive wish lists with the archive action · Call operation archive #
Ask an LLM
“How do I archive several wish lists at once using the archive action?”
“Can I archive old wish lists instead of deleting them outright?”
Tell an agent destructive · confirm first
Archive the wish lists {ids} via the archive action.
Call the wish list archive operation for ids {ids}.
GET /api/v1/admin/WishLists({id})/Default.DynamicProducts() Get a dynamic wish list's products by id · Call operation DynamicProducts #
Ask an LLM
“Which products does a rule-driven dynamic wish list currently resolve to?”
“How do I call the DynamicProducts function on a wish list id?”
Tell an agent
Run the DynamicProducts function for wish list {id}.
Show the rule-generated products of dynamic wish list {id}.
GET /api/v1/admin/wishlists({key})/dynamicproducts Get dynamic products via the key route · Wish lists get dynamic products by key #
Ask an LLM
“Is there a lowercase dynamicproducts route that takes a wish list key?”
“Can I fetch a dynamic wish list's products by its key instead of the function call?”
Tell an agent
Get dynamic products for wish list key {key} using the dynamicproducts route.
Use the key-based route to list products generated for wish list {key}.
DELETE /api/v1/admin/wishlists/archive Archive wish lists via the DELETE route · Wish lists archive route #
Ask an LLM
“Is there a DELETE endpoint that archives wish lists by id list?”
“Can I archive wish lists with the /wishlists/archive route?”
Tell an agent destructive · confirm first
Send the archive DELETE for wish lists {ids}.
Archive wish lists {ids} through the wishlists/archive route.
DELETE /api/v1/admin/wishlists/delete Bulk delete wish lists by ids · Wish lists delete route #
Ask an LLM
“How do I delete many wish lists in a single call?”
“Can I pass a list of ids to wipe multiple wish lists?”
Tell an agent destructive · confirm first
Bulk delete wish lists {ids}.
Permanently delete every wish list in {ids}.
GET /api/v1/admin/wishlists({key})/customeradditions({customerKey}) Get a customer addition on a wish list · Wish lists get customer addition by key and customerkey #
Ask an LLM
“How can I check whether a customer was explicitly added to a wish list?”
“Where do I look up a wish list's customer addition record?”
Tell an agent
Get customer addition {customerKey} on wish list {key}.
Show whether customer {customerKey} is an added customer of wish list {key}.
GET /api/v1/admin/wishlists({key})/customerexceptions({customerKey}) Get a customer exception on a wish list · Wish lists get customer exception by key and customerkey #
Ask an LLM
“How do I see if a customer is excluded from a wish list?”
“Can I read one customer exception attached to a specific wish list?”
Tell an agent
Get customer exception {customerKey} on wish list {key}.
Check if customer {customerKey} is excepted from wish list {key}.
GET /api/v1/admin/wishlists({key})/customproperties({custompropertyKey}) Get a custom property of a wish list · Wish lists get custom property by key and custompropertykey #
Ask an LLM
“Where can I read a custom property stored on a wish list?”
“How do I fetch one custom attribute value from a wish list?”
Tell an agent
Get custom property {custompropertyKey} of wish list {key}.
Read the custom field {custompropertyKey} on wish list {key}.
GET /api/v1/admin/wishlists({key})/globalcustomers({customerKey}) Get a global customer of a wish list · Wish lists get global customer by key and customerkey #
Ask an LLM
“How do I look up a customer a global wish list is published to?”
“Can I verify one global customer assignment on a wish list?”
Tell an agent
Get global customer {customerKey} for wish list {key}.
Confirm global wish list {key} is assigned to customer {customerKey}.
GET /api/v1/admin/wishlists({key})/userprofilewishlistfavorites({userprofilewishlistfavoriteKey}) Get a user's favorite mark on a wish list · Wish lists get user profile wish list favorite by key and… #
Ask an LLM
“How can I see whether a user favorited a particular wish list?”
“Where is a user profile's wish list favorite record stored?”
Tell an agent
Get favorite record {userprofilewishlistfavoriteKey} on wish list {key}.
Show the user favorite {userprofilewishlistfavoriteKey} for wish list {key}.
GET /api/v1/admin/wishlists({key})/userprofilewishlisthides({userprofilewishlisthideKey}) Get a user's hide record on a wish list · Wish lists get user profile wish list hide by key and userprofilewishlisthidekey #
Ask an LLM
“How do I find out if a user has hidden a shared wish list?”
“Can I read a single wish list hide entry for a user profile?”
Tell an agent
Get hide record {userprofilewishlisthideKey} on wish list {key}.
Show whether wish list {key} is hidden by entry {userprofilewishlisthideKey}.
GET /api/v1/admin/wishlists({key})/userprofilewishlisttags({userprofilewishlisttagKey}) Get a user's tag on a wish list · Wish lists get user profile wish list tag by key and userprofilewishlisttagkey #
Ask an LLM
“Which tag did a user put on a wish list?”
“How do I read one user profile tag attached to a wish list?”
Tell an agent
Get tag {userprofilewishlisttagKey} on wish list {key}.
Show the user tag entry {userprofilewishlisttagKey} for wish list {key}.
GET /api/v1/admin/wishlists({key})/wishlistemailschedules({wishlistemailscheduleKey}) Get a wish list's email schedule · Wish lists get wish list email schedule by key and wishlistemailschedulekey #
Ask an LLM
“When is a wish list scheduled to be emailed out?”
“How do I read one email schedule configured on a wish list?”
Tell an agent
Get email schedule {wishlistemailscheduleKey} of wish list {key}.
Show the send schedule {wishlistemailscheduleKey} for wish list {key}.
GET /api/v1/admin/wishlists({key})/wishlistproducts({wishlistproductKey}) Get one product line on a wish list · Wish lists get wish list product by key and wishlistproductkey #
Ask an LLM
“How can I inspect a single product saved on a wish list?”
“Where do I read the quantity and details of one wish list product line?”
Tell an agent
Get product line {wishlistproductKey} on wish list {key}.
Show the saved product {wishlistproductKey} in wish list {key}.
GET /api/v1/admin/wishlists({key})/wishlistshares({wishlistshareKey}) Get a share record of a wish list · Wish lists get wish list share by key and wishlistsharekey #
Ask an LLM
“Who has a wish list been shared with?”
“How do I read one sharing entry on a wish list?”
Tell an agent
Get share {wishlistshareKey} of wish list {key}.
Show the sharing record {wishlistshareKey} for wish list {key}.
GET /api/v1/wishlists/{wishListId}/wishlistlines/{wishListLineId} Get one line from a wish list · Wish list lines V1 get async #
Ask an LLM
“Can I look up a single product line saved on a buyer's wish list?”
“What pricing and availability does one wish list line show?”
Tell an agent
Show line {wishListLineId} on wish list {wishListId}.
Get the quantity and price for wish list line {wishListLineId} in list {wishListId}.
DELETE /api/v1/wishlists/{wishListId}/wishlistlines/{wishListLineId} Remove one product from a wish list · Wish list lines V1 delete async #
Ask an LLM
“How do I take a single product off a saved wish list?”
“Can I delete just one line from a shared list without touching the rest?”
Tell an agent destructive · confirm first
Remove line {wishListLineId} from wish list {wishListId}.
Delete the single wish list line {wishListLineId} in list {wishListId}.
PATCH /api/v1/wishlists/{wishListId}/wishlistlines/{wishListLineId} Update one wish list line · Wish list lines V1 patch by id async #
Ask an LLM
“Can I change the quantity or unit of measure on one saved wish list item?”
“Is it possible to add a note to a single product line on my wish list?”
Tell an agent
Set the quantity on wish list line {wishListLineId} in list {wishListId} to {qtyOrdered}.
Add note {notes} to line {wishListLineId} of wish list {wishListId}.
POST /api/v1/wishlists/{wishListId}/wishlistlines/batch/{copyFromWishListId} Copy lines from another wish list · Wish list lines V1 post collection async #
Ask an LLM
“Can I copy all the products from one wish list into another?”
“Is there a batch way to add many lines to a wish list from an existing list?”
Tell an agent
Copy the lines from wish list {copyFromWishListId} into wish list {wishListId}.
Batch add lines {wishListLines} to wish list {wishListId}, copying from list {copyFromWishListId}.
DELETE /api/v1/wishlists/{wishListId}/wishlistlines/batch Remove several lines from a wish list · Wish list lines V1 delete collection async #
Ask an LLM
“Can I clear several products from a wish list in one request?”
“What IDs do I need to bulk remove wish list lines?”
Tell an agent destructive · confirm first
Remove lines {wishListLineIds} from wish list {wishListId}.
Bulk delete the wish list lines {wishListLineIds} in list {wishListId}.
PATCH /api/v1/wishlists/{wishListId}/wishlistlines/batch Update quantities on many wish list lines · Wish list lines V1 patch async #
Ask an LLM
“Can I change quantities on several lines of a shared wish list at once?”
“Is there a batch update for all the lines on a wish list?”
Tell an agent
Apply the quantity changes {changedSharedListLinesQuantities} to wish list {wishListId}.
Batch update every line quantity on wish list {wishListId}.
GET /api/v1/wishlists/{wishListId}/wishlistlines List the products on a wish list · Wish list lines V1 get collection async #
Ask an LLM
“How do I see every product saved on a particular wish list?”
“Can I search and sort the lines inside one wish list?”
Tell an agent
List the lines on wish list {wishListId}.
Search wish list {wishListId} for items matching {query}, sorted by {sort}.
POST /api/v1/wishlists/{wishListId}/wishlistlines Add a product to a wish list · Wish list lines V1 post async #
Ask an LLM
“How do I save a product to a customer's wish list?”
“Can I pick a unit of measure when adding an item to a list?”
Tell an agent
Add product {productId} to wish list {wishListId}.
Add {qtyOrdered} of product {productId} to wish list {wishListId} in unit {selectedUnitOfMeasure}.
GET /api/v1/wishlists List my wish lists · Wish lists V1 get collection async #
Ask an LLM
“Which wish lists does the signed-in buyer have?”
“Where can I see all saved lists for the current storefront user?”
Tell an agent
List all of my wish lists.
Show every saved list for the current shopper.
POST /api/v1/wishlists Create a wish list · Wish lists V1 post async #
Ask an LLM
“How do I create a new named wish list on the storefront?”
“Can I give a new wish list a description when I create it?”
Tell an agent
Create a wish list called {name}.
Start a new wish list named {name} described as {description}.
GET /api/v1/wishlists/{wishListId} Get a wish list's details · Wish lists V1 get async #
Ask an LLM
“Can I open a single wish list and see who it's shared with?”
“What can I expand or exclude when fetching one wish list?”
Tell an agent
Show wish list {wishListId}.
Get wish list {wishListId} expanding {expand}.
DELETE /api/v1/wishlists/{wishListId} Delete a shopper's wish list from the storefront · Wish lists V1 delete async #
Ask an LLM
“How does a shopper delete one of their own wish lists on the storefront?”
“Does removing a list through the website API also drop its saved lines?”
Tell an agent destructive · confirm first
Delete the shopper's storefront wish list {wishListId}.
Remove my list {wishListId} and everything saved on it.
PATCH /api/v1/wishlists/{wishListId} Rename or edit a shopper's storefront wish list · Wish lists V1 patch async #
Ask an LLM
“Can a shopper rename their wish list or change its description on the storefront?”
“Is it possible to change how a storefront list is shared by editing it?”
Tell an agent
Give my storefront list {wishListId} the new name {name}.
Change the share option on wish list {wishListId} to {shareOption}.
DELETE /api/v1/wishlists/{wishListId}/share/{wishListShareId} Stop sharing a wish list with someone · Wish lists V1 delete share async #
Ask an LLM
“Can I revoke one person's access to a wish list I shared?”
“What removes a single share from a shared list?”
Tell an agent destructive · confirm first
Remove share {wishListShareId} from wish list {wishListId}.
Revoke access share {wishListShareId} on list {wishListId}.
PATCH /api/v1/wishlists/activateinvite Accept a wish list share invite · Wish lists V1 patch invite async #
Ask an LLM
“How does a user accept an invitation to a shared wish list?”
“What do I send to activate a wish list invite code?”
Tell an agent
Activate wish list invite {invite}.
Accept the shared list invitation {invite}.
PATCH /api/v1/wishlists/{wishListId}/sendacopy Email a copy of a wish list · Wish lists V1 patch send ACopy async #
Ask an LLM
“Can I send someone a copy of my wish list by email?”
“Is there a way to include a personal message when I send a list copy?”
Tell an agent
Send a copy of wish list {wishListId} to {recipientEmailAddress}.
Email wish list {wishListId} to {recipientEmailAddress} with message {message} from {senderName}.
PATCH /api/v1/wishlists/{wishListId}/schedule Schedule recurring wish list emails · Wish lists V1 patch schedule async #
Ask an LLM
“Can a wish list be emailed automatically on a weekly or monthly schedule?”
“Which days of the week or month can a list reminder be sent?”
Tell an agent
Set the send schedule for wish list {wishListId} to {schedule}.
Schedule wish list {wishListId} to be emailed to {recipientEmailAddress} on {schedule}.
POST /api/v1/wishlists/{wishListId}/tags/batch Tag a wish list · Wish lists V1 post tags collection async #
Ask an LLM
“Can I attach tags to a wish list to organize it?”
“Is there a batch call to add several tags to one list?”
Tell an agent
Add tags {wishListTags} to wish list {wishListId}.
Label wish list {wishListId} with the tags {wishListTags}.
DELETE /api/v1/wishlists/{wishListId}/tags/batch Remove tags from a wish list · Wish lists V1 delete tags collection async #
Ask an LLM
“Can I strip several tags off a wish list at once?”
“What do I pass to untag a saved list?”
Tell an agent destructive · confirm first
Remove tags {wishListTagIds} from wish list {wishListId}.
Untag wish list {wishListId}, deleting tag IDs {wishListTagIds}.
POST /api/v1/wishlists/{wishListId}/send-pdf Send a wish list as a PDF · Wish lists V1 send wish list pdf async #
Ask an LLM
“Can I produce a PDF of a wish list with barcodes on it?”
“Which layout and display fields can I choose for a wish list PDF?”
Tell an agent
Send wish list {wishListId} as a PDF.
Send a PDF of wish list {wishListId} in layout {layout} with {barcodeFormat} barcodes.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-wishlists-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-wishlists-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-wishlists-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:


# --- truncated at 32 KB (92 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-wishlists-api-openapi.yml