Endpoints

Don't be that person

Most of our endpoints use "POST" requests to keep transmission of sensitive data secure - but this service is not to be used for storing any personal data - and is up to you the developer to make sure that your experience conforms with this requirement.

Fetch a stores Id {storeId}

Cupid exposes an active store id for a given myShopify domain.

get

/wishlist/storeid/{storeMyshopifyDomain}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://wishlist.plutocracy.io/wishlist/storeid/{storeMyshopifyDomain}'

200

200

{
  "id": "text"
}

An active store Id

Fetch a wishlist by a users Email

Returns a complete wishlist for a provided email.

post

/wishlist/email/{storeId}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://wishlist.plutocracy.io/wishlist/email/{storeId}'

201

201

{
  "wishlistId": "text",
  "name": "text",
  "customerId": "text",
  "number": "text",
  "events": [
    {
      "objectId": "text",
      "metaBody": {
        "variantId": "text",
        "quantity": "text",
        "price": "text"
      },
      "eventBody": {},
      "eventType": "wishlist/add"
    }
  ]
}

An active Wishlist for a given user Email

Fetch a wishlist by a wishlist Id

This is our default experience endpoint for non authenticated users, typically we recommend storing a wishlist Id in localstorage and fetching the wishlist at the beginning of the browsing session for SPA's

post

/wishlist/id/{storeId}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://wishlist.plutocracy.io/wishlist/id/{storeId}'

200

200

{
  "wishlistId": "text",
  "name": "text",
  "customerId": "text",
  "number": "text",
  "events": [
    {
      "objectId": "text",
      "metaBody": {
        "variantId": "text",
        "quantity": "text",
        "price": "text"
      },
      "eventBody": {},
      "eventType": "wishlist/add"
    }
  ]
}

An active Wishlist for a given Wishlist Id

Delete a wishlist by a wishlist Id

Delete a wishlist and all of its events, not to be confused with "tombstone"-ing a wishlist which will clear the public history of a given wishlist, but keep the id.

delete

/wishlist/event/{storeId}//{wishlistId}

Path parameters

storeIdstringrequired

wishlistIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://wishlist.plutocracy.io/wishlist/event/{storeId}/{wishlistId}'

200

200

No body

Delete a Wishlist

Create an event on a wishlist

Submitting an event without providing a wishlist Id will create a wishlist and return the id for you to store client side.

This is the default experience, you can provide any eventType for your own purposes, but we have some protected events that provide certain functionality. Cupid stores wishlists as a timeseries of events, and accepts freeform event bodies, allowing developers to build highly flexible experiences.

Reserved events include:

wishlist/add

Will add a product to a rendered wishlist

wishlist/remove

Will remove a product from a rendered wishlist

Wishlist prefixed events are deduplicated when a wishlist is rendered, returning only the current status of the wishlist, if you send 3 wishlist/add events for a given object Id, you will only receive the latest event. If an object has been removed from a wishlist after it is added, no reference to that will be returned.

email/add

Will add an email to a rendered withlist

tombstone

Will hide all events that took place before the tombstone event, perfect for a "clear wishlist" button.

We strongly recommend you do not send Cupid any sensitive customer information - we do try to take every precaution, but will not be held responsible if you send a wishlist information of a personal nature.

post

/wishlist/event/{storeId}

Body

storeIdstringrequired

eventobjectrequired

wishlistIdstring | nullablerequired

emailstring | nullablerequired

namestring | nullablerequired

eventTypeall ofrequired

metaall of | nullablerequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://wishlist.plutocracy.io/wishlist/event/{storeId}' \
  --header 'Content-Type: application/json' \
  --data '{"storeId":"text","event":{},"wishlistId":"text","email":"text","name":"text","eventType":"wishlist/add","meta":{"variantId":"text","quantity":"text","price":"text"}}'

201

201

No body