GET /wishlist
Get the authenticated customer’s wishlist.Authentication
Requires Bearer token (auth:customer_api).
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer | Yes |
Example Request
Response
Success (200)
Each item in theitems array uses the full ProductResource format (see List Products for the complete schema). Abbreviated example:
POST /wishlist
Add a product to the wishlist.Authentication
Requires Bearer token (auth:customer_api).
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer | Yes |
| Content-Type | application/json | Yes |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| product_id | integer | Yes | Product ID (must belong to the current store) |
Example Request
Response
Success (200)
Error Responses
| Status | Description |
|---|---|
| 400 | Product already in wishlist |
| 401 | Not authenticated |
| 422 | Validation error (invalid product_id) |
DELETE /wishlist/
Remove a product from the wishlist.Authentication
Requires Bearer token (auth:customer_api).
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| productId | integer | Product ID to remove |
Example Request
Response
Success (200)
Error Responses
| Status | Description |
|---|---|
| 401 | Not authenticated |
| 404 | Product not found in wishlist |
GET /wishlist/check/
Check if a specific product is in the customer’s wishlist.Authentication
Requires Bearer token (auth:customer_api).
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| productId | integer | Product ID to check |
Example Request
Response
Success (200)
GET /wishlist/count
Get the total number of items in the customer’s wishlist.Authentication
Requires Bearer token (auth:customer_api).
Example Request
Response
Success (200)
DELETE /wishlist/clear
Remove all items from the wishlist.Authentication
Requires Bearer token (auth:customer_api).

