Skip to main content
All wishlist endpoints require customer authentication.

GET /wishlist

Get the authenticated customer’s wishlist.

Authentication

Requires Bearer token (auth:customer_api).

Headers

Example Request

Response

Success (200)

Each item in the items 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

Body Parameters

Example Request

Response

Success (200)

Error Responses


DELETE /wishlist/

Remove a product from the wishlist.

Authentication

Requires Bearer token (auth:customer_api).

Path Parameters

Example Request

Response

Success (200)

Error Responses


GET /wishlist/check/

Check if a specific product is in the customer’s wishlist.

Authentication

Requires Bearer token (auth:customer_api).

Path Parameters

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).

Example Request

Response

Success (200)