Check whether an item is in the wishlist

GET

/wishlists/{item_id}/check

const url = 'https://acme.mykreezalid.com/front_api/v1/wishlists/4242/check?type=listing';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://acme.mykreezalid.com/front_api/v1/wishlists/4242/check?type=listing' \
  --header 'Authorization: Bearer <token>'

Tells whether a listing (by default) or a vendor (type=vendor) is in the signed-in member’s wishlist. The response echoes the identifier under listing_id or vendor_id, following type.

Authorizations

bearerAuth

Parameters

Path Parameters

item_id

required

integer

Example

Identifier of the listing, or of the vendor with type=vendor.

Query Parameters

type

string

default: listing

Allowed values: listing vendor

Kind of item to look for.

Responses

200

Whether the item is in the wishlist.

application/json

object

success

boolean

listing_id

The identifier you sent (vendor_id with type=vendor).

integer

exists

boolean

Example

{
  "success": true,
  "listing_id": 4242,
  "exists": true
}

403

No valid access token was sent.

application/json

Error body returned by the Front API when it refuses a request.

object

code

HTTP status code, repeated in the body.

integer

status

string

message

Human-readable reason.

string

Example

{
  "code": 403,
  "status": "error",
  "message": "Token not found in request"
}