Skip to content

`Runtime_WishList_Insert`#

This is a runtime function intended to be called client side to create a new wishlist for a customer that has a session. Because this is a runtime (public) function no API key is required.

Request Parameters#

Parameter	Type	Description
`session_type`	String	This will always have a hard-coded value of “runtime.” This tells Miva, no authentication is needed for the API call.
`Session_ID`	String	Passing the `Session_ID` in the request will allow any customer-specific discounts get applied.
`WishList_Title`	String	This will be the WishList Title
`WishList_Notes`	String	This will be the WishList Notes
`WishList_Shared`	Boolean	True/False for a private wishlist

Response Parameters#

Parameter	Type	Description
`id`	Number	ID of the newly created wishlist
`cust_id`	Number	ID of the customer who owns the wishlist
`title`	String	Title of the newly created wishlist
`notes`	String	Notes attached to the wishlist
`shared`	Boolean	Whether the wishlist is shared or not

Example Request#

{
    "Store_Code": "{{Store_Code}}",
    "Function": "Runtime_WishList_Insert",
    "Session_Type": "runtime",
    "Session_ID": "{{Session_ID}}",
    "WishList_Title": "{{WishList_Title}}",
    "WishList_Notes": "{{WishList_Notes}}",
    "WishList_Shared": false
}

Example Response#

{
    "success": 1,
    "data": {
        "id": 4,
        "cust_id": 12,
        "title": "New Wishlist",
        "notes": "Wishlist Notes",
        "shared": false
    }
}