Skip to content

Runtime_WishListItem_Delete#

This function allows a logged-in customer to delete a specific item from one of their wishlists. It does not require an API key since it is a runtime function, but it does require a valid customer session.

Request Parameters#

Parameter Type Description
Session_Type String Always “runtime”. No API key needed.
Session_ID String Required for customer authentication.
Wish_ID Number ID of the wishlist item to be deleted.

Example Request#

{
  "Store_Code": "{{Store_Code}}",
  "Function": "Runtime_WishListItem_Delete",
  "Session_Type": "runtime",
  "Session_ID": "{{Session_ID}}",
  "Wish_ID": 1001
}

Example Response#

{
  "success": 1
}

Error Responses#

Authentication Requirements:

This function requires customer authentication. The following conditions must be met:

  • g.Basket:cust_id must be present.
  • g.Customer_Session_Verified must be true.

If either condition fails, the function returns an error:

{
  "success": 0,
  "error_code": "wishlist_customer_login",
  "error_message": "You must have a customer account to remove items from a wish list."
}

Wishlist item Validation:

{
  "success": 0,
  "error_code": "wishlist_invalid",
  "error_message": "Invalid wish list"
}

Child Item Check: * If the item is a child of another wishlist item (i.e., has a Parent_ID), deletion is not allowed:

{
  "success": 0,
  "error_code": "MER-JSN-RTM-00042",
  "error_message": "Child items cannot be removed directly from a wish list."
}