Glue API: Manage wishlist items

Last updated:
Edit on GitHub

This endpoint allows you to add and remove items from wishlists.

Installation

For detailed information on the modules that provide the API functionality and related installation instructions, see:

Add an item to a wishlist

To add an item to a wishlist, send the request:

POST /wishlists/{{wishlist_id}}/wishlist-items

PATH PARAMETER DESCRIPTION
{{wishlist_id}} Unique identifier of the wishlist to add the items to. Create a wishlist or retrieve all wishlists to get it.

Request

HEADER KEY HEADER VALUE REQUIRED DESCRIPTION
Authorization string ✓ Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by authenticating as a customer.

Request sample: add an item to a wishlist

POST https://glue.mysprykershop.com/wishlists/09264b7f-1894-58ed-81f4-d52d683e910a/wishlist-items

{
		"data": {
			"type": "wishlist-items",
			"attributes": {
				"sku": "064_18404924"
			}
		}
	}
Request sample: add a configurable product to a wishlist

POST https://glue.mysprykershop.com/wishlists/09264b7f-1894-58ed-81f4-d52d683e910a/wishlist-items

{
    "data": {
        "type": "wishlist-items",
        "attributes": {
            "sku": "093_24495843",
            "productConfigurationInstance": {
                "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.12.2021\"}",
                "configuration": "{\"time_of_day\": \"2\"}",
                "configuratorKey": "DATE_TIME_CONFIGURATOR",
                "isComplete": true,
                "quantity": 3,
                "availableQuantity": 4,
                "prices": [
                    {
                        "priceTypeName": "DEFAULT",
                        "netAmount": 23434,
                        "grossAmount": 42502,
                        "currency": {
                            "code": "EUR",
                            "name": "Euro",
                            "symbol": "€"
                        },
                        "volumePrices": [
                            {
                                "netAmount": 150,
                                "grossAmount": 165,
                                "quantity": 5
                            },
                            {
                                "netAmount": 145,
                                "grossAmount": 158,
                                "quantity": 10
                            },
                            {
                                "netAmount": 140,
                                "grossAmount": 152,
                                "quantity": 20
                            }
                        ]
                    }
                ]
            }
        }
    }
}

ATTRIBUTE TYPE DESCRIPTION
sku String Concrete or configurable product SKU to add.
displayData Array Array of variables that are proposed for a Storefront user to set up in the configurator.
configuration Array Default configurable product configuration.
configuratorKey String Configurator type.
isComplete Boolean Shows if the configurable product configuration is complete:
  • true—configuration complete.
  • false—configuration incomplete.
quantity Integer Quantity of the product that is added to the wishlist.
availableQuantity Integer Product quantity available in the store.

For attribute descriptions of product prices, see Retrieving abstract product prices.

Response

Response sample: add an item to a wishlist

{
		"data": {
			"type": "wishlist-items",
			"id": "064_18404924",
			"attributes": {
				"sku": "064_18404924"
			},
			"links": {
				"self": "https://glue.mysprykershop.com/wishlists/c917e65b-e8c3-5c8b-bec6-892529c64b30/wishlist-items/064_18404924"
			}
		}
	}
Response sample: add a configurable product to a wishlist 
{
    "data": {
        "type": "wishlist-items",
        "id": "093_24495843_98bf36f052d23f10a8a081694ad4f45e",
        "attributes": {
            "productOfferReference": null,
            "merchantReference": "MER000001",
            "id": "093_24495843_98bf36f052d23f10a8a081694ad4f45e",
            "sku": "093_24495843",
            "availability": {
                "isNeverOutOfStock": false,
                "availability": false,
                "quantity": "0.0000000000"
            },
            "productConfigurationInstance": {
                "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.12.2021\"}",
                "configuration": "{\"time_of_day\": \"2\"}",
                "configuratorKey": "DATE_TIME_CONFIGURATOR",
                "isComplete": true,
                "quantity": 3,
                "availableQuantity": 4,
                "prices": [
                    {
                        "netAmount": 23434,
                        "grossAmount": 42502,
                        "priceTypeName": "DEFAULT",
                        "volumeQuantity": null,
                        "currency": {
                            "code": "EUR",
                            "name": "Euro",
                            "symbol": "€"
                        },
                        "volumePrices": [
                            {
                                "grossAmount": 165,
                                "netAmount": 150,
                                "quantity": 5
                            },
                            {
                                "grossAmount": 158,
                                "netAmount": 145,
                                "quantity": 10
                            },
                            {
                                "grossAmount": 152,
                                "netAmount": 140,
                                "quantity": 20
                            }
                        ]
                    }
                ]
            },
            "prices": []
        },
        "links": {
            "self": "https://glue.mysprykershop.com/wishlists/b70e1073-a740-5a48-bb5e-0449a9e51d53/wishlist-items/093_24495843_98bf36f052d23f10a8a081694ad4f45e"
        }
    }
}

ATTRIBUTE TYPE DESCRIPTION
sku String Concrete or configurable product SKU added to the wishlist.
displayData Array Array of variables a Storefront user set up in the configurator.
configuration Array Default configurable product configuration.
configuratorKey String Configurator type.
isComplete Boolean Shows if the configurable product configuration is complete:
  • true—configuration complete.
  • false—configuration incomplete.
quantity Integer Quantity of the product added to the wishlist.
availableQuantity Integer Product quantity available in the store.
productOfferReference String
merchantReference String Unique identifier of the merchant.

For attribute descriptions of product prices, see Retrieving abstract product prices.

For attribute descriptions of concrete product availability, see Retrieve concrete product availability.

Update a wishlist item

Warning

Only configurable products can be updated.

To update a wishlist item, send the request:

PATCH /wishlists/{{wishlist_id}}/wishlist-items/{{wishlist_item_id}}

PATH PARAMETER DESCRIPTION
{{wishlist_id}} Unique identifier of the wishlist to delete an item from. Create a wishlist or retrieve all wishlists to get it.
{{wishlist_item_id}} Unique identifier of a configurable product to update. To get this identifier, retrieve a wishlist with items included or add a configurable product to a wishlist.

Request

HEADER KEY HEADER VALUE REQUIRED DESCRIPTION
Authorization string ✓ Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by authenticating as a customer.
Request sample: update a configurable product in a wishlist

PATCH https://glue.mysprykershop.com/wishlists/09264b7f-1894-58ed-81f4-d52d683e910a/wishlist-items/093_24495843_98bf36f052d23f10a8a081694ad4f45e

{
    "data": {
        "type": "wishlist-items",
        "attributes": {
            "sku": "093_24495843",
            "productConfigurationInstance": {
                "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.10.2021\"}",
                "configuration": "{\"time_of_day\": \"2\"}",
                "configuratorKey": "DATE_TIME_CONFIGURATOR",
                "isComplete": false,
                "quantity": 4,
                "availableQuantity": 4,
                "prices": [
                    {
                        "priceTypeName": "DEFAULT",
                        "netAmount": 23434,
                        "grossAmount": 42502,
                        "currency": {
                            "code": "EUR",
                            "name": "Euro",
                            "symbol": "€"
                        },
                        "volumePrices": [
                            {
                                "netAmount": 150,
                                "grossAmount": 165,
                                "quantity": 5
                            },
                            {
                                "netAmount": 145,
                                "grossAmount": 158,
                                "quantity": 10
                            },
                            {
                                "netAmount": 140,
                                "grossAmount": 152,
                                "quantity": 20
                            }
                        ]
                    }
                ]
            }
        }
    }
}
ATTRIBUTE TYPE DESCRIPTION
sku String Configurable product SKU to update.
displayData Array Array of variables that are proposed for a Storefront user to set up in the configurator.
configuration Array Default configurable product configuration.
configuratorKey String Configurator type.
isComplete Boolean Shows if the configurable product configuration is complete:
  • true—configuration complete.
  • false—configuration incomplete.
quantity Integer Quantity of the configurable product to update in the wishlist.
availableQuantity Integer Product quantity available in the store.

For attribute descriptions of product prices, see Retrieving abstract product prices.

Response

Response sample: update a configurable product in a wishlist 
{
    "data": {
        "type": "wishlist-items",
        "id": "093_24495843_98bf36f052d23f10a8a081694ad4f45e",
        "attributes": {
            "productOfferReference": null,
            "merchantReference": "MER000001",
            "id": "093_24495843_98bf36f052d23f10a8a081694ad4f45e",
            "sku": "093_24495843",
            "availability": {
                "isNeverOutOfStock": false,
                "availability": false,
                "quantity": "0.0000000000"
            },
            "productConfigurationInstance": {
                "displayData": "{\"Preferred time of the day\": \"Afternoon\", \"Date\": \"9.10.2021\"}",
                "configuration": "{\"time_of_day\": \"2\"}",
                "configuratorKey": "DATE_TIME_CONFIGURATOR",
                "isComplete": false,
                "quantity": 4,
                "availableQuantity": 4,
                "prices": [
                    {
                        "netAmount": 23434,
                        "grossAmount": 42502,
                        "priceTypeName": "DEFAULT",
                        "volumeQuantity": null,
                        "currency": {
                            "code": "EUR",
                            "name": "Euro",
                            "symbol": "€"
                        },
                        "volumePrices": [
                            {
                                "grossAmount": 165,
                                "netAmount": 150,
                                "quantity": 5
                            },
                            {
                                "grossAmount": 158,
                                "netAmount": 145,
                                "quantity": 10
                            },
                            {
                                "grossAmount": 152,
                                "netAmount": 140,
                                "quantity": 20
                            }
                        ]
                    }
                ]
            },
            "prices": []
        },
        "links": {
            "self": "https://glue.mysprykershop.com/wishlists/b70e1073-a740-5a48-bb5e-0449a9e51d53/wishlist-items/093_24495843_94a23d655bf161d6ab0088457f4ea2fc"
        }
    }
}
ATTRIBUTE TYPE DESCRIPTION
sku String Updated configurable product SKU.
displayData Array Array of variables a Storefront user set up in the configurator.
configuration Array Updated configurable product configuration.
configuratorKey String Configurator type.
isComplete Boolean Shows if the configurable product configuration is complete:
  • true—configuration complete.
  • false—configuration incomplete.
quantity Integer Updated configurable product quantity in the wishlist.
availableQuantity Integer Configurable product quantity available in the store.

For attribute descriptions of product prices, see Retrieving abstract product prices.

For attribute descriptions of concrete product availability, see Retrieve concrete product availability.

Delete a wishlist item

To delete wishlist item, send the request:

DELETE /wishlists/{{wishlist_id}}/wishlist-items/{{wishlist_item_id}}

PATH PARAMETER DESCRIPTION
{{wishlist_id}} Unique identifier of the wishlist to delete an item from. Create a wishlist or retrieve all wishlists to get it.
{{wishlist_item_id}} Unique identifier of a concrete or configurable product to delete. To get this identifier, retrieve a wishlist with items included or add an item to a wishlist.

Request

HEADER KEY HEADER VALUE REQUIRED DESCRIPTION
Authorization string ✓ Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by authenticating as a customer.

Request sample: delete a wishlist item

DELETE https://glue.mysprykershop.com/wishlists/09264b7f-1894-58ed-81f4-d52d683e910a/wishlist-items/064_18404924

Response

If the item is removed successfully, the endpoint returns the 204 No Content status code.

Possible errors

CODE REASON
201 Cannot find the wishlist.
206 Cannot add an item to the wishlist.
207 Cannot remove the item.
208 An item with the provided SKU does not exist in the wishlist.

To view generic errors that originate from the Glue Application, see Reference information: GlueApplication errors.