> For the complete documentation index, see [llms.txt](https://docs.spurtcommerce.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.spurtcommerce.com/api-reference/store/wishlist.md).

# Wishlist

Add products to the customer wishlist, list saved items, and remove wishlist entries.

## Add a product (and optional selected option value) to wishlist.

> Add a product (and optional selected option value) to wishlist.\
> \
> \*\*Authentication:\*\* Customer bearer token required.\
> \
> \*\*Feature area:\*\* Wishlist\
> \
> \*\*Implementation source:\*\* \`src/api/store/controllers/CustomerWishListController.ts\`\
> \
> \*\*Request example provenance:\*\* Request and top-level response fields from source @api example; nested product object abbreviated.\
> \
> \*\*Response example provenance:\*\* Request and top-level response fields from source @api example; nested product object abbreviated.\
> \
> \> Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.

```json
{"openapi":"3.0.3","info":{"title":"SpurtCommerce Store API","version":"6.0.0"},"tags":[{"name":"Wishlist","description":"Add products to the customer wishlist, list saved items, and remove wishlist entries."}],"servers":[{"url":"https://api.example.com","description":"Replace with your SpurtCommerce API host. Paths include the /api prefix."}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Paste the JWT access token returned by the corresponding login endpoint."}}},"paths":{"/api/customer/add-product-to-wishlist":{"post":{"operationId":"postApiCustomerAddProductToWishlist","summary":"Add a product (and optional selected option value) to wishlist.","description":"Add a product (and optional selected option value) to wishlist.\n\n**Authentication:** Customer bearer token required.\n\n**Feature area:** Wishlist\n\n**Implementation source:** `src/api/store/controllers/CustomerWishListController.ts`\n\n**Request example provenance:** Request and top-level response fields from source @api example; nested product object abbreviated.\n\n**Response example provenance:** Request and top-level response fields from source @api example; nested product object abbreviated.\n\n> Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.","tags":["Wishlist"],"responses":{"200":{"description":"Successful response. Request and top-level response fields from source @api example; nested product object abbreviated.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"status":{"type":"string"},"data":{"type":"object","properties":{"wishlistProductId":{"type":"integer"},"product":{"type":"object","properties":{"productId":{"type":"integer"},"sku":{"type":"string"},"name":{"type":"string"},"productSlug":{"type":"string"},"isActive":{"type":"integer"}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true}}}}},"requestBody":{"required":false,"description":"Sample request body. Request and top-level response fields from source @api example; nested product object abbreviated.","content":{"application/json":{"schema":{"type":"object","properties":{"productId":{"type":"integer"},"productOptionValueId":{"type":"string"}},"additionalProperties":true}}}}}}}}
```

## Delete a wishlist item by its route ID.

> Delete a wishlist item by its route ID.\
> \
> \*\*Authentication:\*\* Customer bearer token required.\
> \
> \*\*Feature area:\*\* Wishlist\
> \
> \*\*Implementation source:\*\* \`src/api/store/controllers/CustomerWishListController.ts\`\
> \
> \*\*Request example provenance:\*\* Exact source success message.\
> \
> \*\*Response example provenance:\*\* Exact source success message.\
> \
> \> Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.

```json
{"openapi":"3.0.3","info":{"title":"SpurtCommerce Store API","version":"6.0.0"},"tags":[{"name":"Wishlist","description":"Add products to the customer wishlist, list saved items, and remove wishlist entries."}],"servers":[{"url":"https://api.example.com","description":"Replace with your SpurtCommerce API host. Paths include the /api prefix."}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Paste the JWT access token returned by the corresponding login endpoint."}}},"paths":{"/api/customer/wishlist-product-delete/{id}":{"delete":{"operationId":"deleteApiCustomerWishlistProductDeleteId","summary":"Delete a wishlist item by its route ID.","description":"Delete a wishlist item by its route ID.\n\n**Authentication:** Customer bearer token required.\n\n**Feature area:** Wishlist\n\n**Implementation source:** `src/api/store/controllers/CustomerWishListController.ts`\n\n**Request example provenance:** Exact source success message.\n\n**Response example provenance:** Exact source success message.\n\n> Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.","tags":["Wishlist"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Value for id."}],"responses":{"200":{"description":"Successful response. Exact source success message.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"status":{"type":"string"}},"additionalProperties":true}}}}}}}}}
```

## List the current customer wishlist.

> List the current customer wishlist.\
> \
> \*\*Authentication:\*\* Customer bearer token required.\
> \
> \*\*Feature area:\*\* Wishlist\
> \
> \*\*Implementation source:\*\* \`src/api/store/controllers/CustomerWishListController.ts\`\
> \
> \*\*Request example provenance:\*\* Data list is variable; response structure follows current source handler.\
> \
> \*\*Response example provenance:\*\* Data list is variable; response structure follows current source handler.\
> \
> \> Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.

```json
{"openapi":"3.0.3","info":{"title":"SpurtCommerce Store API","version":"6.0.0"},"tags":[{"name":"Wishlist","description":"Add products to the customer wishlist, list saved items, and remove wishlist entries."}],"servers":[{"url":"https://api.example.com","description":"Replace with your SpurtCommerce API host. Paths include the /api prefix."}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Paste the JWT access token returned by the corresponding login endpoint."}}},"paths":{"/api/customer/wishlist-product-list":{"get":{"operationId":"getApiCustomerWishlistProductList","summary":"List the current customer wishlist.","description":"List the current customer wishlist.\n\n**Authentication:** Customer bearer token required.\n\n**Feature area:** Wishlist\n\n**Implementation source:** `src/api/store/controllers/CustomerWishListController.ts`\n\n**Request example provenance:** Data list is variable; response structure follows current source handler.\n\n**Response example provenance:** Data list is variable; response structure follows current source handler.\n\n> Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.","tags":["Wishlist"],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer"},"description":"Query parameter limit."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer"},"description":"Query parameter offset."},{"name":"count","in":"query","required":false,"schema":{"type":"boolean"},"description":"Query parameter count."}],"responses":{"200":{"description":"Successful response. Data list is variable; response structure follows current source handler.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"status":{"type":"string"},"data":{"type":"array","items":{}}},"additionalProperties":true}}}}}}}}}
```