Skip to main content
POST
/
wishlist
Add item to wishlist
curl --request POST \
  --url https://store.salesive.com/api/v1/wishlist \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-shop-id: <api-key>' \
  --data '
{
  "productId": "<string>",
  "foodId": "<string>",
  "serviceId": "<string>",
  "variantId": "<string>"
}
'
{
  "status": 123,
  "success": true,
  "message": "<string>",
  "data": {
    "_id": "<string>",
    "user": "<string>",
    "shop": "<string>",
    "items": [
      {
        "product": {
          "_id": "<string>",
          "name": "<string>",
          "price": 123,
          "images": [
            "<string>"
          ],
          "formattedPrice": "<string>",
          "sku": "<string>"
        },
        "addedAt": "2023-11-07T05:31:56Z",
        "variant": "<string>",
        "variantAttributes": {}
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

​
Request

POST /wishlist
Authorization: Bearer {{token}}
x-shop-id: {{shopId}}
Content-Type: application/json

{
  "productId": "69fb494e51280f9f65d059ae"
}

​
Headers

HeaderTypeDescription
AuthorizationstringProvide the customer token as Bearer <jwt>.
x-shop-idstringIdentify the shop that owns the wishlist.
Content-TypestringAlways set to application/json.

​
Body parameters

FieldTypeRequiredDescription
productIdstringNoProduct identifier (ecommerce). Provide exactly one of productId, foodId, or serviceId.
foodIdstringNoFood item identifier (restaurant stores).
serviceIdstringNoService identifier (business stores).
variantIdstringNoVariant identifier. Only valid for product wishlist items.
Wishlist items are typed: a product item returns a populated product, a food item returns food (with a foodId field), and a service item returns service (with a serviceId field).

​
Successful response

{
    "status": 200,
    "success": true,
    "message": "Item added to wishlist",
    "data": {
        "_id": "693c048b5b24f53cda947ddb",
        "user": "69360693a7a8f7dc8ae32d6d",
        "shop": "68b8f52575da81b332af29f1",
        "items": [
            {
                "product": {
                    "_id": "69fb494e51280f9f65d059ae",
                    "images": [
                        "https://cdn.salesive.com/products/wristwatch.webp"
                    ],
                    "name": "Wristwatch",
                    "price": 45000,
                    "promoPrice": null,
                    "formattedPrice": "45000.00",
                    "promoActive": false,
                    "formattedPromoPrice": null,
                    "isAvailable": true,
                    "lowestPrice": 45000,
                    "highestPrice": 45000,
                    "image": "https://cdn.salesive.com/products/wristwatch.webp",
                    "plainDescription": "High quality and affordable wristwatch",
                    "id": "69fb494e51280f9f65d059ae"
                },
                "addedAt": "2026-06-09T09:10:33.816Z"
            }
        ],
        "createdAt": "2025-12-12T12:03:23.104Z",
        "updatedAt": "2026-06-09T09:10:33.818Z",
        "__v": 3,
        "id": "693c048b5b24f53cda947ddb"
    }
}

​
Error response

{
    "status": 404,
    "success": false,
    "message": "Product not found",
    "data": {}
}

Authorizations

​
Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

​
x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

​
x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Body

application/json

Add a product, food, or service item to the wishlist. Provide exactly one of productId, foodId, or serviceId.

​
productId
string
required

Product identifier to add to wishlist (ecommerce stores).

​
foodId
string

Food item identifier to add to wishlist (restaurant stores).

​
serviceId
string

Service identifier to add to wishlist (business stores).

​
variantId
string

Optional variant identifier (product wishlist items only).

Response

Item added to wishlist.

​
status
integer
required
​
success
boolean
required
​
message
string
required
​
data
object
required