v1
latestOpenAPI 3.0.32026-07-173196215.4 KBGet a wishlist
This endpoint allows you to retrieve items previously placed in a customer's wishlist. An example would be: /v1/wishlists/<wishlist-key>.
- The wishlist key is created on demand when an item is added to the wishlist.
- Using the with= parameter, it is possible to retrieve extra information in the response. Please check the next section for all options.
Path parameters
Wishlist ID
Query parameters
Adjust prices based on the specified campaignKey. If results are not having a matching campaign, the default price is returned.
Please note, that campaign prices are stored in advance and available earlier than the campaign starts.
Adjust variant price based on the specified pricePromotionKey. If the variant does not have a matching price promotion, the default price is returned.
Include Display highest PPK Price
Include PPK sale categories
The with parameter can be applied to include only product related resources, for example, the attributes of a product can be attached using with=items.product.attributes. It is also possible to filter attributes by key with=items.product.attributes:key(plusSize) or by type with=items.product.attributes:type(material_care). In the following table, there is more information about possible includes.
| Include | Nested includes and Available Filters for products |
|---|---|
| items.variant.attributes | Include item variant attributes. |
| items.variant.attributes:key(ean) | Include all item variant attributes filtered by key |
| items.variant.attributes:type(fit_size) | Include all item variant attributes filtered by type |
| items.variant.advancedAttributes:key(productName) | Include all item variant advancedAttributes filtered by key |
| items.variant.advancedAttributes:type() | Include all item variant advancedAttributes filtered by type |
| items.variant.lowestPriorPrice | Include all item variant lowestPriorPrice |
| items.product.variants | Include item product variants. |
| items.product.variants.attributes | Include item product variants attributes. |
| items.product.variants.attributes:key(ean) | Include all item product variants attributes filtered by key |
| items.product.variants.attributes:type(fit_size) | Include all item product variants attributes filtered by type |
| items.product.variants.advancedAttributes:key(productName) | Include all item product variants advancedAttributes filtered by key |
| items.product.variants.advancedAttributes:type() | Include all item product variants advancedAttributes filtered by type |
| items.product.variants.lowestPriorPrice | Include item product variants lowestPriorPrice |
| items.product.priceRange | Include item product priceRange |
| items.product.reductionRange | Include item product reductionRange |
| items.product.lowestPriorPrice | Include item product lowestPriorPrice |
| items.product.searchCategoryIds | Include item product filtered by searchCategoryIds |
| items.product.baseCategories | Include item product baseCategories |
| items.product.pricePromotionInfo | Include item product pricePromotionInfo |
| items.product.definingAttributes | Include item product definingAttributes |
| items.product.attributes | Include item product attributes |
| items.product.attributes:key(new) | Include all item product attributes filtered by key |
| items.product.attributes:type(localizedString) | Include all item product attributes filtered by type |
| items.product.advancedAttributes:key(productName) | Include all item product advancedAttributes filtered by key |
| items.product.advancedAttributes:type() | Include all item product advancedAttributes filtered by type |
| items.product.images.attributes | Include item product image attributes |
| items.product.images.attributes:key() | Include all item product image attributes filtered by key |
| items.product.images.attributes:type() | Include all item product image attributes filtered by type |
| items.product.categories | Include item product categories |
| items.product.categories:hidden(true) | Include item product with hidden categories |
| items.product.categories.categoryProperties:name | Include item product categories only with name property |
| items.product.categories.countryLevelCustomData | Include item product categories country level custom data |
| items.product.categories.shopLevelCustomData | Include item product categories shop level custom data |
| items.product.siblings.* | Include item product available siblings products and apply the same filters, and other properties such as items.product.siblings.variants, ..., items.product.siblings.categories.shopLevelCustomData. |
Response
request successful