Glue API: Manage wishlists

Last updated:
Edit on GitHub

The Wishlists API allows creating list and deleting wishlists, as well as managing the items inside them.

Installation

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

Create a wishlist

To create a wishlist, send the request:

POST /wishlists

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: create a wishlist

POST https://glue.mysprykershop.com/wishlists

{
		"data":{
			"type": "wishlists",
			"attributes":{
				"name":"christmas_gifts"
			}
		}
	}
ATTRIBUTE TYPE REQUIRED DESCRIPTION
name string ✓ Name of the wishlist to create.

Response

Response sample: create a wishlist 
{
		"data": {
			"type": "wishlists",
			"id": "09264b7f-1894-58ed-81f4-d52d683e910a",
			"attributes": {
				"name": "Name of the wishlist",
				"numberOfItems": 0,
				"createdAt": "2018-08-17 10:04:35.311557",
				"updatedAt": "2018-08-17 10:04:35.311557"
			},
			"links": {
				"self": "https://glue.mysprykershop.com/wishlists/09264b7f-1894-58ed-81f4-d52d683e910a"
			}
		}
	}
ATTRIBUTE TYPE DESCRIPTION
name String Name of the wishlist.
numberOfItems Integer Number of items in the wishlist.
createdAt String Creation date of the wishlist.
updatedAt String Date of the last update.

Retrieve wishlists

To retrieve all wishlists of a customer, send the request:

GET /wishlists

Request

QUERY PARAMETER DESCRIPTION POSSIBLE VALUES
include Adds resource relationships to the request.
  • wishlist-items
  • concrete-products
  • product-labels
REQUEST SAMPLE USAGE
GET https://glue.mysprykershop.com/wishlists Retrieve all the wishlists of a customer.
GET https://glue.mysprykershop.com/wishlists?include=wishlist-items Retrieve all the wishlists of a customer with wishlist items.
GET https://glue.mysprykershop.com/wishlists?include=wishlist-items,concrete-products Retrieve all the wishlists of a customer with wishlist items and respective concrete products.
GET https://glue.mysprykershop.com/wishlists?include=wishlist-items,concrete-products,product-labels Retrieve all the wishlists of a customer with wishlist items, respective concrete products, and their product labels.
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.

Response

Response sample: no wishlists are retrieved 
{
		"data": [],
		"links": {
			"self": "https://glue.mysprykershop.com/wishlists"
		}
	}
Response sample: retrieve wishlists 
{
	"data": [
		{
			"type": "wishlists",
			"id": "1623f465-e4f6-5e45-8dc5-987b923f8af4",
			"attributes": {
				"name": "My Wishlist Name",
				"numberOfItems": 0,
				"createdAt": "2018-12-16 17:24:12.601033",
				"updatedAt": "2018-12-16 17:24:12.601033"
			},
			"links": {
				"self": "https://glue.mysprykershop.com/wishlists/1623f465-e4f6-5e45-8dc5-987b923f8af4"
			}
		}
	],
	"links": {
		"self": "https://glue.mysprykershop.com/wishlists"
	}
}
Response sample: retrieve wishlists with the details on the wishlist items 
{
    "data": [
        {
            "type": "wishlists",
            "id": "246591f8-4f30-55ce-8b17-8482859b4ac1",
            "attributes": {
                "name": "My wishlist",
                "numberOfItems": 1,
                "createdAt": "2021-02-16 15:02:21.121613",
                "updatedAt": "2021-02-16 15:02:21.121613"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items"
            },
            "relationships": {
                "wishlist-items": {
                    "data": [
                        {
                            "type": "wishlist-items",
                            "id": "149_28346778"
                        }
                    ]
                }
            }
        }
    ],
    "links": {
        "self": "https://glue.mysprykershop.com/wishlists?include=wishlist-items"
    },
    "included": [
        {
            "type": "wishlist-items",
            "id": "149_28346778",
            "attributes": {
                "sku": "149_28346778"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/149_28346778"
            }
        }
    ]
}
Response sample: retrieve wishlists with the details on the wishlist items and respective concrete products 
{
    "data": [
        {
            "type": "wishlists",
            "id": "246591f8-4f30-55ce-8b17-8482859b4ac1",
            "attributes": {
                "name": "My wishlist",
                "numberOfItems": 1,
                "createdAt": "2021-02-16 15:02:21.121613",
                "updatedAt": "2021-02-16 15:02:21.121613"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products"
            },
            "relationships": {
                "wishlist-items": {
                    "data": [
                        {
                            "type": "wishlist-items",
                            "id": "149_28346778"
                        }
                    ]
                }
            }
        }
    ],
    "links": {
        "self": "https://glue.mysprykershop.com/wishlists?include=wishlist-items,concrete-products"
    },
    "included": [
        {
            "type": "concrete-products",
            "id": "149_28346778",
            "attributes": {
                "sku": "149_28346778",
                "isDiscontinued": false,
                "discontinuedNote": null,
                "averageRating": null,
                "reviewCount": 0,
                "name": "HP 200 250 G4",
                "description": "Durable mobile design Rest assured that the HP 250 can keep up with assignments on the run. The durable chassis protects the notebook so it looks as professional as you do. Get connected with the value-priced HP 250 Notebook PC. Complete business tasks with Intel technology, essential multimedia tools and Windows 8.1 loaded on the HP 250. The durable chassis helps protect the notebook from the rigors of the day. HP, a world leader in PCs and touch technology helps equip you with a fully functional notebook ready to connect to all your peripherals and designed to fit the needs of business. HP, a world leader in PCs and touch technology helps equip you with a fully functional notebook ready to connect to all your peripherals and designed to fit the needs of business.",
                "attributes": {
                    "form_factor": "clamshell",
                    "processor_cores": "2",
                    "thermal_design_power": "15 W",
                    "brand": "HP",
                    "color": "Black",
                    "processor_frequency": "1.6 GHz"
                },
                "superAttributesDefinition": [
                    "form_factor",
                    "color",
                    "processor_frequency"
                ],
                "metaTitle": "HP 200 250 G4",
                "metaKeywords": "HP,Entertainment Electronics",
                "metaDescription": "Durable mobile design Rest assured that the HP 250 can keep up with assignments on the run. The durable chassis protects the notebook so it looks as profes",
                "attributeNames": {
                    "form_factor": "Form factor",
                    "processor_cores": "Processor cores",
                    "thermal_design_power": "Thermal Design Power (TDP)",
                    "brand": "Brand",
                    "color": "Color",
                    "processor_frequency": "Processor frequency"
                }
            },
            "links": {
                "self": "https://glue.mysprykershop.com/concrete-products/149_28346778"
            }
        },
        {
            "type": "wishlist-items",
            "id": "149_28346778",
            "attributes": {
                "sku": "149_28346778"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/149_28346778"
            },
            "relationships": {
                "concrete-products": {
                    "data": [
                        {
                            "type": "concrete-products",
                            "id": "149_28346778"
                        }
                    ]
                }
            }
        }
    ]
}
Response sample: retrieve wishlists with the details on the wishlist items, respective concrete products, and their product labels 
{
    "data": [
        {
            "type": "wishlists",
            "id": "246591f8-4f30-55ce-8b17-8482859b4ac1",
            "attributes": {
                "name": "My wishlist",
                "numberOfItems": 1,
                "createdAt": "2021-02-16 15:02:21.121613",
                "updatedAt": "2021-02-16 15:02:21.121613"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products,product-labels"
            },
            "relationships": {
                "wishlist-items": {
                    "data": [
                        {
                            "type": "wishlist-items",
                            "id": "020_21081478"
                        }
                    ]
                }
            }
        }
    ],
    "links": {
        "self": "https://glue.mysprykershop.com/wishlists?include=wishlist-items,concrete-products,product-labels"
    },
    "included": [
        {
            "type": "product-labels",
            "id": "5",
            "attributes": {
                "name": "SALE %",
                "isExclusive": false,
                "position": 3,
                "frontEndReference": "highlight"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/product-labels/5"
            }
        },
        {
            "type": "concrete-products",
            "id": "020_21081478",
            "attributes": {
                "sku": "020_21081478",
                "isDiscontinued": false,
                "discontinuedNote": null,
                "averageRating": null,
                "reviewCount": 0,
                "name": "Sony Cyber-shot DSC-W830",
                "description": "Styled for your pocket  Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing it, and slip in your pocket. Shooting great photos and videos is easy with the W800. Buttons are positioned for ease of use, while a dedicated movie button makes shooting movies simple. The vivid 2.7-type Clear Photo LCD display screen lets you view your stills and play back movies with minimal effort. Whip out the W800 to capture crisp, smooth footage in an instant. At the press of a button, you can record blur-free 720 HD images with digital sound. Breathe new life into a picture by using built-in Picture Effect technology. There’s a range of modes to choose from – you don’t even have to download image-editing software.",
                "attributes": {
                    "hdmi": "no",
                    "sensor_type": "CCD",
                    "display": "TFT",
                    "usb_version": "2",
                    "brand": "Sony",
                    "color": "Black"
                },
                "superAttributesDefinition": [
                    "color"
                ],
                "metaTitle": "Sony Cyber-shot DSC-W830",
                "metaKeywords": "Sony,Entertainment Electronics",
                "metaDescription": "Styled for your pocket  Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing i",
                "attributeNames": {
                    "hdmi": "HDMI",
                    "sensor_type": "Sensor type",
                    "display": "Display",
                    "usb_version": "USB version",
                    "brand": "Brand",
                    "color": "Color"
                }
            },
            "links": {
                "self": "https://glue.mysprykershop.com/concrete-products/020_21081478"
            },
            "relationships": {
                "product-labels": {
                    "data": [
                        {
                            "type": "product-labels",
                            "id": "5"
                        }
                    ]
                }
            }
        },
        {
            "type": "wishlist-items",
            "id": "020_21081478",
            "attributes": {
                "sku": "020_21081478"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/020_21081478"
            },
            "relationships": {
                "concrete-products": {
                    "data": [
                        {
                            "type": "concrete-products",
                            "id": "020_21081478"
                        }
                    ]
                }
            }
        }
    ]
}
ATTRIBUTE TYPE DESCRIPTION
name String Name of the wishlist.
numberOfItems Integer Number of items in the wishlist.
createdAt String Creation date of the wishlist.
updatedAt String Date of the last update.
RESOURCE ATTRIBUTE TYPE DESCRIPTION
concrete-products sku String SKU of the concrete product.
concrete-products isDiscontinued Boolean Specifies whether a product is discontinued:
true - the product is discontinued and requires a replacement item;
false—the product is not discontinued.
concrete-products discontinuedNote String Optional note that was specified when marking a product as discontinued.
concrete-products averageRating String Average rating of the product based on customer rating.
concrete-products reviewCount Integer Number of reviews left by customer for this product.
concrete-products name String Name of the concrete product.
concrete-products description String Description of the concrete product.
concrete-products attributes Object List of attribute keys and their values for the product.
concrete-products superAttributeDefinition String List of attributes that are flagged as super attributes.
concrete-products metaTitle String Meta title of the product.
concrete-products metaKeywords String Meta keywords of the product.
concrete-products metaDescription String Meta description of the product.
concrete-products attributeNames String List of attribute keys and their translations.
concrete-products productAbstractSku String Unique identifier of the abstract product owning this concrete product.
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.
RESOURCE ATTRIBUTE TYPE DESCRIPTION
product-labels name String Specifies the label name.
product-labels isExclusive Boolean Indicates whether the label is exclusive.
If the attribute is set to true, the current label takes precedence over other labels the product might have. This means that only the current label should be displayed for the product, and all other possible labels should be hidden.
product-labels position Integer Indicates the label priority.
Labels should be indicated on the frontend according to their priority, from the highest (1) to the lowest, unless a product has a label with the isExclusive attribute set.
product-labels frontEndReference String Specifies the label custom label type (CSS class).
If the attribute is an empty string, the label should be displayed using the default CSS style.

Retrieve a wishlist

To retrieve wishlist items, send the request:

GET /wishlists/{{wishlist_id}}

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

Request

QUERY PARAMETER DESCRIPTION POSSIBLE VALUES
include Adds resource relationships to the request.
  • wishlist-items
  • concrete-products
  • product-labels
REQUEST SAMPLE USAGE
GET https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1 Retrieve the wishlist with the 246591f8-4f30-55ce-8b17-8482859b4ac1 identifier.
GET https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items Retrieve the wishlist with the 246591f8-4f30-55ce-8b17-8482859b4ac1 identifier. Include wishlist items into the response.
GET https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products Retrieve the wishlist with the 246591f8-4f30-55ce-8b17-8482859b4ac1 identifier. Include wishlist items and respective concrete products into the response.
GET https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products,product-labels Retrieve the wishlist with the 246591f8-4f30-55ce-8b17-8482859b4ac1 identifier. Include wishlist items, respective concrete products and their product labels into the response.
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.

Response

Response sample: retrieve a wishlist 
{
    "data": {
        "type": "wishlists",
        "id": "246591f8-4f30-55ce-8b17-8482859b4ac1",
        "attributes": {
            "name": "My wishlist",
            "numberOfItems": 1,
            "createdAt": "2021-02-24 13:52:34.582421",
            "updatedAt": "2021-02-24 13:52:34.582421"
        },
        "links": {
            "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1"
        }
    }
}
Response sample: retrieve a wishlist with the details on the wishlist items 
{
    "data": {
        "type": "wishlists",
        "id": "246591f8-4f30-55ce-8b17-8482859b4ac1",
        "attributes": {
            "name": "My wishlist",
            "numberOfItems": 1,
            "createdAt": "2021-02-24 13:52:34.582421",
            "updatedAt": "2021-02-24 13:52:34.582421"
        },
        "links": {
            "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items"
        },
        "relationships": {
            "wishlist-items": {
                "data": [
                    {
                        "type": "wishlist-items",
                        "id": "020_21081478"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "wishlist-items",
            "id": "020_21081478",
            "attributes": {
                "sku": "020_21081478"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/020_21081478"
            }
        }
    ]
}
Response sample: retrieve a wishlist with the details on the wishlist items and respective concrete products 
{
    "data": {
        "type": "wishlists",
        "id": "246591f8-4f30-55ce-8b17-8482859b4ac1",
        "attributes": {
            "name": "My wishlist",
            "numberOfItems": 1,
            "createdAt": "2021-02-24 13:52:34.582421",
            "updatedAt": "2021-02-24 13:52:34.582421"
        },
        "links": {
            "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products"
        },
        "relationships": {
            "wishlist-items": {
                "data": [
                    {
                        "type": "wishlist-items",
                        "id": "020_21081478"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "concrete-products",
            "id": "020_21081478",
            "attributes": {
                "sku": "020_21081478",
                "isDiscontinued": false,
                "discontinuedNote": null,
                "averageRating": null,
                "reviewCount": 0,
                "name": "Sony Cyber-shot DSC-W830",
                "description": "Styled for your pocket  Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing it, and slip in your pocket. Shooting great photos and videos is easy with the W800. Buttons are positioned for ease of use, while a dedicated movie button makes shooting movies simple. The vivid 2.7-type Clear Photo LCD display screen lets you view your stills and play back movies with minimal effort. Whip out the W800 to capture crisp, smooth footage in an instant. At the press of a button, you can record blur-free 720 HD images with digital sound. Breathe new life into a picture by using built-in Picture Effect technology. There’s a range of modes to choose from – you don’t even have to download image-editing software.",
                "attributes": {
                    "hdmi": "no",
                    "sensor_type": "CCD",
                    "display": "TFT",
                    "usb_version": "2",
                    "brand": "Sony",
                    "color": "Black"
                },
                "superAttributesDefinition": [
                    "color"
                ],
                "metaTitle": "Sony Cyber-shot DSC-W830",
                "metaKeywords": "Sony,Entertainment Electronics",
                "metaDescription": "Styled for your pocket  Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing i",
                "attributeNames": {
                    "hdmi": "HDMI",
                    "sensor_type": "Sensor type",
                    "display": "Display",
                    "usb_version": "USB version",
                    "brand": "Brand",
                    "color": "Color"
                }
            },
            "links": {
                "self": "https://glue.mysprykershop.com/concrete-products/020_21081478"
            }
        },
        {
            "type": "wishlist-items",
            "id": "020_21081478",
            "attributes": {
                "sku": "020_21081478"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/020_21081478"
            },
            "relationships": {
                "concrete-products": {
                    "data": [
                        {
                            "type": "concrete-products",
                            "id": "020_21081478"
                        }
                    ]
                }
            }
        }
    ]
}
Response sample: retrieve a wishlist with the details on the wishlist items, respective concrete products, and their product labels 
{
    "data": {
        "type": "wishlists",
        "id": "246591f8-4f30-55ce-8b17-8482859b4ac1",
        "attributes": {
            "name": "My wishlist",
            "numberOfItems": 1,
            "createdAt": "2021-02-24 13:52:34.582421",
            "updatedAt": "2021-02-24 13:52:34.582421"
        },
        "links": {
            "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1?include=wishlist-items,concrete-products,product-labels"
        },
        "relationships": {
            "wishlist-items": {
                "data": [
                    {
                        "type": "wishlist-items",
                        "id": "020_21081478"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "product-labels",
            "id": "5",
            "attributes": {
                "name": "SALE %",
                "isExclusive": false,
                "position": 3,
                "frontEndReference": "highlight"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/product-labels/5"
            }
        },
        {
            "type": "concrete-products",
            "id": "020_21081478",
            "attributes": {
                "sku": "020_21081478",
                "isDiscontinued": false,
                "discontinuedNote": null,
                "averageRating": null,
                "reviewCount": 0,
                "name": "Sony Cyber-shot DSC-W830",
                "description": "Styled for your pocket  Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing it, and slip in your pocket. Shooting great photos and videos is easy with the W800. Buttons are positioned for ease of use, while a dedicated movie button makes shooting movies simple. The vivid 2.7-type Clear Photo LCD display screen lets you view your stills and play back movies with minimal effort. Whip out the W800 to capture crisp, smooth footage in an instant. At the press of a button, you can record blur-free 720 HD images with digital sound. Breathe new life into a picture by using built-in Picture Effect technology. There’s a range of modes to choose from – you don’t even have to download image-editing software.",
                "attributes": {
                    "hdmi": "no",
                    "sensor_type": "CCD",
                    "display": "TFT",
                    "usb_version": "2",
                    "brand": "Sony",
                    "color": "Black"
                },
                "superAttributesDefinition": [
                    "color"
                ],
                "metaTitle": "Sony Cyber-shot DSC-W830",
                "metaKeywords": "Sony,Entertainment Electronics",
                "metaDescription": "Styled for your pocket  Precision photography meets the portability of a smartphone. The W800 is small enough to take great photos, look good while doing i",
                "attributeNames": {
                    "hdmi": "HDMI",
                    "sensor_type": "Sensor type",
                    "display": "Display",
                    "usb_version": "USB version",
                    "brand": "Brand",
                    "color": "Color"
                }
            },
            "links": {
                "self": "https://glue.mysprykershop.com/concrete-products/020_21081478"
            },
            "relationships": {
                "product-labels": {
                    "data": [
                        {
                            "type": "product-labels",
                            "id": "5"
                        }
                    ]
                }
            }
        },
        {
            "type": "wishlist-items",
            "id": "020_21081478",
            "attributes": {
                "sku": "020_21081478"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/wishlists/246591f8-4f30-55ce-8b17-8482859b4ac1/wishlist-items/020_21081478"
            },
            "relationships": {
                "concrete-products": {
                    "data": [
                        {
                            "type": "concrete-products",
                            "id": "020_21081478"
                        }
                    ]
                }
            }
        }
    ]
}
ATTRIBUTE TYPE DESCRIPTION
name String Name of the wishlist.
numberOfItems Integer Number of items in the wishlist.
createdAt String Creation date of the wishlist.
updatedAt String Date of the last update.
RESOURCE ATTRIBUTE TYPE DESCRIPTION
concrete-products sku String SKU of the concrete product.
concrete-products isDiscontinued Boolean Specifies whether a product is discontinued:
true - the product is discontinued and requires a replacement item;
false—the product is not discontinued.
concrete-products discontinuedNote String Optional note that was specified when marking a product as discontinued.
concrete-products averageRating String Average rating of the product based on customer rating.
concrete-products reviewCount Integer Number of reviews left by customer for this product.
concrete-products name String Name of the concrete product.
concrete-products description String Description of the concrete product.
concrete-products attributes Object List of attribute keys and their values for the product.
concrete-products superAttributeDefinition String List of attributes that are flagged as super attributes.
concrete-products metaTitle String Meta title of the product.
concrete-products metaKeywords String Meta keywords of the product.
concrete-products metaDescription String Meta description of the product.
concrete-products attributeNames String List of attribute keys and their translations.
concrete-products productAbstractSku String Unique identifier of the abstract product owning this concrete product.
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.
RESOURCE ATTRIBUTE TYPE DESCRIPTION
product-labels name String Specifies the label name.
product-labels isExclusive Boolean Indicates whether the label is exclusive.
If the attribute is set to true, the current label takes precedence over other labels the product might have. This means that only the current label should be displayed for the product, and all other possible labels should be hidden.
product-labels position Integer Indicates the label priority.
Labels should be indicated on the frontend according to their priority, from the highest (1) to the lowest, unless a product has a label with the isExclusive attribute set.
product-labels frontEndReference String Specifies the label custom label type (CSS class).
If the attribute is an empty string, the label should be displayed using the default CSS style.

Edit a wishlist

To edit a wishlist, send the request:

PATCH /wishlists

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: edit a wishlist. The following sample changes the name of a wishlist.

PATCH https://glue.mysprykershop.com/wishlists

{
		"data": {
			"type": "wishlists",
			"id": "09264b7f-1894-58ed-81f4-d52d683e910a",
			"attributes": {
				"name": "birthday party"
			}
		}
	}
ATTRIBUTE TYPE REQUIRED DESCRIPTION
id string ✓ Unique identifier of the wishlist to update the name of. Create a wishlist or retrieve all wishlists to get it.
name string ✓ New name of the wishlist.

Response

ATTRIBUTE TYPE DESCRIPTION
name String Name of the wishlist.
numberOfItems Integer Number of items in the wishlist.
createdAt String Creation date of the wishlist.
updatedAt String Date of the last update.

Delete a wishlist

To delete a wishlist, send the request:

DELETE /wishlists/{{wishlist_id}}

PATH PARAMETER DESCRIPTION
{{wishlist_id}} Unique identifier of the wishlist to delete. 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: delete a wishlist

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

Response

If the wishlist is deleted successfully, the endpoint returns the 204 No Content status code.

Possible errors

CODE REASON
001 Access token is invalid.
002 Access token is missing.
201 Wishlist with the specified ID is not found.
202 Wishlist with the same name already exists.
203 Cannot create a wishlist.
204 Cannot update the wishlist.
205 Cannot remove the wishlist.
209 ID is not specified.
210 Please enter the name using only letters, numbers, underscores, spaces or dashes.
901 name field is empty.

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