> For the complete documentation index, see [llms.txt](https://docs.premsoft.de/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.premsoft.de/en/plugins/wishlists-for-shopware-6/api/wishlist.md).

# Wishlist

## GET /api/prems-wishlist

> Get all wishlists

```json
{"openapi":"3.0.0","info":{"title":"PremsWishlist","version":"1.0.0"},"servers":[{"url":"{{BASE_URL}}"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/prems-wishlist":{"get":{"summary":"Get all wishlists","responses":{"200":{"description":"Successful","headers":{"Access-Control-Allow-Headers":{"deprecated":false,"schema":{}},"Access-Control-Allow-Methods":{"deprecated":false,"schema":{}},"Access-Control-Allow-Origin":{"deprecated":false,"schema":{}},"Access-Control-Expose-Headers":{"deprecated":false,"schema":{}},"Cache-Control":{"deprecated":false,"schema":{}},"Content-Security-Policy":{"deprecated":false,"schema":{}},"Date":{"deprecated":false,"schema":{}},"Referrer-Policy":{"deprecated":false,"schema":{}},"Server":{"deprecated":false,"schema":{}},"Server-Timing":{"deprecated":false,"schema":{}},"Strict-Transport-Security":{"deprecated":false,"schema":{}},"Vary":{"deprecated":false,"schema":{}},"X-Content-Type-Options":{"deprecated":false,"schema":{}},"X-Debug-Token":{"deprecated":false,"schema":{}},"X-Debug-Token-Link":{"deprecated":false,"schema":{}},"X-Frame-Options":{"deprecated":false,"schema":{}},"X-Robots-Tag":{"deprecated":false,"schema":{}},"X-Symfony-Cache":{"deprecated":false,"schema":{}},"Transfer-Encoding":{"deprecated":false,"schema":{}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"salesChannelId":{"type":"string"},"customerId":{"type":"string"},"name":{"type":"string"},"private":{"type":"boolean"},"token":{"nullable":true},"priority":{"type":"integer"},"itemsCount":{"type":"integer"},"updatedAt":{"nullable":true},"createdAt":{"type":"string","format":"date-time"},"apiAlias":{"type":"string"}}},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri"}}},"relationships":{"type":"object","properties":{"salesChannel":{"type":"object","properties":{"data":{"nullable":true},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}},"customer":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"}}},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}},"products":{"type":"object","properties":{"data":{"type":"array","items":{}},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}}}},"meta":{"nullable":true}}}},"included":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object"},"links":{"type":"object"},"relationships":{"type":"object","properties":{"paypalVaultTokens":{"type":"object","properties":{"data":{"type":"array","items":{}},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}},"paypalVaultTokenMappings":{"type":"object","properties":{"data":{"type":"array","items":{}},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}},"customerWishlist":{"type":"object","properties":{"data":{"type":"array","items":{}},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}}}},"meta":{"nullable":true}}}},"links":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"self":{"type":"string","format":"uri"}}},"meta":{"type":"object","properties":{"totalCountMode":{"type":"integer"},"total":{"type":"integer"}}},"aggregations":{"type":"array","items":{}}}}}}},"401":{"description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"deprecated":false,"schema":{}},"Access-Control-Allow-Methods":{"deprecated":false,"schema":{}},"Access-Control-Allow-Origin":{"deprecated":false,"schema":{}},"Access-Control-Expose-Headers":{"deprecated":false,"schema":{}},"Cache-Control":{"deprecated":false,"schema":{}},"Date":{"deprecated":false,"schema":{}},"Server":{"deprecated":false,"schema":{}},"Server-Timing":{"deprecated":false,"schema":{}},"Vary":{"deprecated":false,"schema":{}},"X-Debug-Token":{"deprecated":false,"schema":{}},"X-Debug-Token-Link":{"deprecated":false,"schema":{}},"X-Robots-Tag":{"deprecated":false,"schema":{}},"X-Symfony-Cache":{"deprecated":false,"schema":{}},"Transfer-Encoding":{"deprecated":false,"schema":{}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","format":"utc-millisec"},"status":{"type":"string","format":"color"},"title":{"type":"string"},"detail":{"type":"string"},"meta":{"type":"object","properties":{"trace":{"type":"array","items":{"type":"object","properties":{"file":{"type":"string"},"line":{"type":"integer"},"function":{"type":"string"},"class":{"type":"string"},"type":{"type":"string","format":"ipv6"},"args":{"type":"array","items":{"type":"string"}}}}},"file":{"type":"string"},"line":{"type":"integer"},"previous":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","format":"utc-millisec"},"status":{"type":"string","format":"color"},"title":{"type":"string"},"detail":{"type":"string"},"meta":{"type":"object","properties":{"trace":{"type":"array","items":{"type":"object","properties":{"file":{"type":"string"},"line":{"type":"integer"},"function":{"type":"string"},"class":{"type":"string"},"type":{"type":"string","format":"ipv6"},"args":{"type":"array","items":{}}}}},"file":{"type":"string"},"line":{"type":"integer"}}}}}}}}}}}}}}}}},"tags":["Wishlist"]}}}}
```

## POST /api/prems-wishlist

> Create a wishlist

```json
{"openapi":"3.0.0","info":{"title":"PremsWishlist","version":"1.0.0"},"servers":[{"url":"{{BASE_URL}}"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/prems-wishlist":{"post":{"summary":"Create a wishlist","responses":{"204":{"description":"Successful","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Access-Control-Expose-Headers":{"schema":{"type":"string"}},"Cache-Control":{"schema":{"type":"string"}},"Content-Security-Policy":{"schema":{"type":"string"}},"Date":{"schema":{"type":"string"}},"Location":{"schema":{"type":"string"}},"Referrer-Policy":{"schema":{"type":"string"}},"Server":{"schema":{"type":"string"}},"Server-Timing":{"schema":{"type":"string"}},"Strict-Transport-Security":{"schema":{"type":"string"}},"Vary":{"schema":{"type":"string"}},"X-Content-Type-Options":{"schema":{"type":"string"}},"X-Debug-Token":{"schema":{"type":"string"}},"X-Debug-Token-Link":{"schema":{"type":"string"}},"X-Frame-Options":{"schema":{"type":"string"}},"X-Robots-Tag":{"schema":{"type":"string"}},"X-Symfony-Cache":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"deprecated":false,"schema":{}},"Access-Control-Allow-Methods":{"deprecated":false,"schema":{}},"Access-Control-Allow-Origin":{"deprecated":false,"schema":{}},"Access-Control-Expose-Headers":{"deprecated":false,"schema":{}},"Cache-Control":{"deprecated":false,"schema":{}},"Date":{"deprecated":false,"schema":{}},"Server":{"deprecated":false,"schema":{}},"Server-Timing":{"deprecated":false,"schema":{}},"Vary":{"deprecated":false,"schema":{}},"X-Debug-Token":{"deprecated":false,"schema":{}},"X-Debug-Token-Link":{"deprecated":false,"schema":{}},"X-Robots-Tag":{"deprecated":false,"schema":{}},"X-Symfony-Cache":{"deprecated":false,"schema":{}},"Transfer-Encoding":{"deprecated":false,"schema":{}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","format":"utc-millisec"},"status":{"type":"string","format":"color"},"title":{"type":"string"},"detail":{"type":"string"},"meta":{"type":"object","properties":{"trace":{"type":"array","items":{"type":"object","properties":{"file":{"type":"string"},"line":{"type":"integer"},"function":{"type":"string"},"class":{"type":"string"},"type":{"type":"string","format":"ipv6"},"args":{"type":"array","items":{"type":"string"}}}}},"file":{"type":"string"},"line":{"type":"integer"},"previous":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","format":"utc-millisec"},"status":{"type":"string","format":"color"},"title":{"type":"string"},"detail":{"type":"string","format":"style"},"meta":{"type":"object","properties":{"trace":{"type":"array","items":{"type":"object","properties":{"file":{"type":"string"},"line":{"type":"integer"},"function":{"type":"string"},"class":{"type":"string"},"type":{"type":"string","format":"ipv6"},"args":{"type":"array","items":{"type":"object","properties":{"constraint":{"type":"string"}}}}}}},"file":{"type":"string"},"line":{"type":"integer"}}}}}}}}}}}}}}}}},"tags":["Wishlist"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"salesChannelId":{"type":"string"},"customerId":{"type":"string"},"name":{"type":"string"},"products":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string"}}}}}}}}}}}}}
```

## GET /api/prems-wishlist/{ENTITY\_ID}

> Get a wishlist

```json
{"openapi":"3.0.0","info":{"title":"PremsWishlist","version":"1.0.0"},"servers":[{"url":"{{BASE_URL}}"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/prems-wishlist/{ENTITY_ID}":{"get":{"summary":"Get a wishlist","responses":{"200":{"description":"Successful","headers":{"Access-Control-Allow-Headers":{"deprecated":false,"schema":{}},"Access-Control-Allow-Methods":{"deprecated":false,"schema":{}},"Access-Control-Allow-Origin":{"deprecated":false,"schema":{}},"Access-Control-Expose-Headers":{"deprecated":false,"schema":{}},"Cache-Control":{"deprecated":false,"schema":{}},"Content-Security-Policy":{"deprecated":false,"schema":{}},"Date":{"deprecated":false,"schema":{}},"Referrer-Policy":{"deprecated":false,"schema":{}},"Server":{"deprecated":false,"schema":{}},"Server-Timing":{"deprecated":false,"schema":{}},"Strict-Transport-Security":{"deprecated":false,"schema":{}},"Vary":{"deprecated":false,"schema":{}},"X-Content-Type-Options":{"deprecated":false,"schema":{}},"X-Debug-Token":{"deprecated":false,"schema":{}},"X-Debug-Token-Link":{"deprecated":false,"schema":{}},"X-Frame-Options":{"deprecated":false,"schema":{}},"X-Robots-Tag":{"deprecated":false,"schema":{}},"X-Symfony-Cache":{"deprecated":false,"schema":{}},"Transfer-Encoding":{"deprecated":false,"schema":{}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"salesChannelId":{"type":"string"},"customerId":{"type":"string"},"name":{"type":"string"},"private":{"type":"boolean"},"token":{"nullable":true},"priority":{"type":"integer"},"itemsCount":{"type":"integer"},"updatedAt":{"nullable":true},"createdAt":{"type":"string","format":"date-time"},"apiAlias":{"type":"string"}}},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri"}}},"relationships":{"type":"object","properties":{"salesChannel":{"type":"object","properties":{"data":{"nullable":true},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}},"customer":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"}}},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}},"products":{"type":"object","properties":{"data":{"type":"array","items":{}},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}}}},"meta":{"nullable":true}}},"included":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object"},"links":{"type":"object"},"relationships":{"type":"object","properties":{"paypalVaultTokens":{"type":"object","properties":{"data":{"type":"array","items":{}},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}},"paypalVaultTokenMappings":{"type":"object","properties":{"data":{"type":"array","items":{}},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}},"customerWishlist":{"type":"object","properties":{"data":{"type":"array","items":{}},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}}}},"meta":{"nullable":true}}}},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri"}}}}}}}},"401":{"description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"deprecated":false,"schema":{}},"Access-Control-Allow-Methods":{"deprecated":false,"schema":{}},"Access-Control-Allow-Origin":{"deprecated":false,"schema":{}},"Access-Control-Expose-Headers":{"deprecated":false,"schema":{}},"Cache-Control":{"deprecated":false,"schema":{}},"Date":{"deprecated":false,"schema":{}},"Server":{"deprecated":false,"schema":{}},"Server-Timing":{"deprecated":false,"schema":{}},"Vary":{"deprecated":false,"schema":{}},"X-Debug-Token":{"deprecated":false,"schema":{}},"X-Debug-Token-Link":{"deprecated":false,"schema":{}},"X-Robots-Tag":{"deprecated":false,"schema":{}},"X-Symfony-Cache":{"deprecated":false,"schema":{}},"Transfer-Encoding":{"deprecated":false,"schema":{}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","format":"utc-millisec"},"status":{"type":"string","format":"color"},"title":{"type":"string"},"detail":{"type":"string"},"meta":{"type":"object","properties":{"trace":{"type":"array","items":{"type":"object","properties":{"file":{"type":"string"},"line":{"type":"integer"},"function":{"type":"string"},"class":{"type":"string"},"type":{"type":"string","format":"ipv6"},"args":{"type":"array","items":{"type":"string"}}}}},"file":{"type":"string"},"line":{"type":"integer"},"previous":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","format":"utc-millisec"},"status":{"type":"string","format":"color"},"title":{"type":"string"},"detail":{"type":"string","format":"style"},"meta":{"type":"object","properties":{"trace":{"type":"array","items":{"type":"object","properties":{"file":{"type":"string"},"line":{"type":"integer"},"function":{"type":"string"},"class":{"type":"string"},"type":{"type":"string","format":"ipv6"},"args":{"type":"array","items":{"type":"object","properties":{"constraint":{"type":"string"}}}}}}},"file":{"type":"string"},"line":{"type":"integer"}}}}}}}}}}}}}}}}},"tags":["Wishlist"]}}}}
```

## DELETE /api/prems-wishlist/{ENTITY\_ID}

> Delete a wishlist

```json
{"openapi":"3.0.0","info":{"title":"PremsWishlist","version":"1.0.0"},"servers":[{"url":"{{BASE_URL}}"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/prems-wishlist/{ENTITY_ID}":{"delete":{"summary":"Delete a wishlist","responses":{"204":{"description":"Successful","headers":{"Access-Control-Allow-Headers":{"deprecated":false,"schema":{}},"Access-Control-Allow-Methods":{"deprecated":false,"schema":{}},"Access-Control-Allow-Origin":{"deprecated":false,"schema":{}},"Access-Control-Expose-Headers":{"deprecated":false,"schema":{}},"Cache-Control":{"deprecated":false,"schema":{}},"Content-Security-Policy":{"deprecated":false,"schema":{}},"Date":{"deprecated":false,"schema":{}},"Location":{"deprecated":false,"schema":{}},"Referrer-Policy":{"deprecated":false,"schema":{}},"Server":{"deprecated":false,"schema":{}},"Server-Timing":{"deprecated":false,"schema":{}},"Strict-Transport-Security":{"deprecated":false,"schema":{}},"Vary":{"deprecated":false,"schema":{}},"X-Content-Type-Options":{"deprecated":false,"schema":{}},"X-Debug-Token":{"deprecated":false,"schema":{}},"X-Debug-Token-Link":{"deprecated":false,"schema":{}},"X-Frame-Options":{"deprecated":false,"schema":{}},"X-Robots-Tag":{"deprecated":false,"schema":{}},"X-Symfony-Cache":{"deprecated":false,"schema":{}}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"deprecated":false,"schema":{}},"Access-Control-Allow-Methods":{"deprecated":false,"schema":{}},"Access-Control-Allow-Origin":{"deprecated":false,"schema":{}},"Access-Control-Expose-Headers":{"deprecated":false,"schema":{}},"Cache-Control":{"deprecated":false,"schema":{}},"Date":{"deprecated":false,"schema":{}},"Server":{"deprecated":false,"schema":{}},"Server-Timing":{"deprecated":false,"schema":{}},"Vary":{"deprecated":false,"schema":{}},"X-Debug-Token":{"deprecated":false,"schema":{}},"X-Debug-Token-Link":{"deprecated":false,"schema":{}},"X-Robots-Tag":{"deprecated":false,"schema":{}},"X-Symfony-Cache":{"deprecated":false,"schema":{}},"Transfer-Encoding":{"deprecated":false,"schema":{}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","format":"utc-millisec"},"status":{"type":"string","format":"color"},"title":{"type":"string"},"detail":{"type":"string"},"meta":{"type":"object","properties":{"trace":{"type":"array","items":{"type":"object","properties":{"file":{"type":"string"},"line":{"type":"integer"},"function":{"type":"string"},"class":{"type":"string"},"type":{"type":"string","format":"ipv6"},"args":{"type":"array","items":{"type":"string"}}}}},"file":{"type":"string"},"line":{"type":"integer"},"previous":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","format":"utc-millisec"},"status":{"type":"string","format":"color"},"title":{"type":"string"},"detail":{"type":"string","format":"style"},"meta":{"type":"object","properties":{"trace":{"type":"array","items":{"type":"object","properties":{"file":{"type":"string"},"line":{"type":"integer"},"function":{"type":"string"},"class":{"type":"string"},"type":{"type":"string","format":"ipv6"},"args":{"type":"array","items":{"type":"object","properties":{"constraint":{"type":"string"}}}}}}},"file":{"type":"string"},"line":{"type":"integer"}}}}}}}}}}}}}}}}},"tags":["Wishlist"]}}}}
```

## PATCH /api/prems-wishlist/{ENTITY\_ID}

> Add a product to a wishlist

```json
{"openapi":"3.0.0","info":{"title":"PremsWishlist","version":"1.0.0"},"servers":[{"url":"{{BASE_URL}}"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/prems-wishlist/{ENTITY_ID}":{"patch":{"summary":"Add a product to a wishlist","responses":{"204":{"description":"Successful","headers":{"Access-Control-Allow-Headers":{"deprecated":false,"schema":{}},"Access-Control-Allow-Methods":{"deprecated":false,"schema":{}},"Access-Control-Allow-Origin":{"deprecated":false,"schema":{}},"Access-Control-Expose-Headers":{"deprecated":false,"schema":{}},"Cache-Control":{"deprecated":false,"schema":{}},"Content-Security-Policy":{"deprecated":false,"schema":{}},"Date":{"deprecated":false,"schema":{}},"Location":{"deprecated":false,"schema":{}},"Referrer-Policy":{"deprecated":false,"schema":{}},"Server":{"deprecated":false,"schema":{}},"Server-Timing":{"deprecated":false,"schema":{}},"Strict-Transport-Security":{"deprecated":false,"schema":{}},"Vary":{"deprecated":false,"schema":{}},"X-Content-Type-Options":{"deprecated":false,"schema":{}},"X-Debug-Token":{"deprecated":false,"schema":{}},"X-Debug-Token-Link":{"deprecated":false,"schema":{}},"X-Frame-Options":{"deprecated":false,"schema":{}},"X-Robots-Tag":{"deprecated":false,"schema":{}},"X-Symfony-Cache":{"deprecated":false,"schema":{}}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"deprecated":false,"schema":{}},"Access-Control-Allow-Methods":{"deprecated":false,"schema":{}},"Access-Control-Allow-Origin":{"deprecated":false,"schema":{}},"Access-Control-Expose-Headers":{"deprecated":false,"schema":{}},"Cache-Control":{"deprecated":false,"schema":{}},"Date":{"deprecated":false,"schema":{}},"Server":{"deprecated":false,"schema":{}},"Server-Timing":{"deprecated":false,"schema":{}},"Vary":{"deprecated":false,"schema":{}},"X-Debug-Token":{"deprecated":false,"schema":{}},"X-Debug-Token-Link":{"deprecated":false,"schema":{}},"X-Robots-Tag":{"deprecated":false,"schema":{}},"X-Symfony-Cache":{"deprecated":false,"schema":{}},"Transfer-Encoding":{"deprecated":false,"schema":{}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","format":"utc-millisec"},"status":{"type":"string","format":"color"},"title":{"type":"string"},"detail":{"type":"string"},"meta":{"type":"object","properties":{"trace":{"type":"array","items":{"type":"object","properties":{"file":{"type":"string"},"line":{"type":"integer"},"function":{"type":"string"},"class":{"type":"string"},"type":{"type":"string","format":"ipv6"},"args":{"type":"array","items":{"type":"string"}}}}},"file":{"type":"string"},"line":{"type":"integer"},"previous":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","format":"utc-millisec"},"status":{"type":"string","format":"color"},"title":{"type":"string"},"detail":{"type":"string","format":"style"},"meta":{"type":"object","properties":{"trace":{"type":"array","items":{"type":"object","properties":{"file":{"type":"string"},"line":{"type":"integer"},"function":{"type":"string"},"class":{"type":"string"},"type":{"type":"string","format":"ipv6"},"args":{"type":"array","items":{"type":"object","properties":{"constraint":{"type":"string"}}}}}}},"file":{"type":"string"},"line":{"type":"integer"}}}}}}}}}}}}}}}}},"tags":["Wishlist"]}}}}
```

## POST /api/search/prems-wishlist

> Get wishlists by a customer

```json
{"openapi":"3.0.0","info":{"title":"PremsWishlist","version":"1.0.0"},"servers":[{"url":"{{BASE_URL}}"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/search/prems-wishlist":{"post":{"summary":"Get wishlists by a customer","responses":{"200":{"description":"Successful","headers":{"Access-Control-Allow-Headers":{"deprecated":false,"schema":{}},"Access-Control-Allow-Methods":{"deprecated":false,"schema":{}},"Access-Control-Allow-Origin":{"deprecated":false,"schema":{}},"Access-Control-Expose-Headers":{"deprecated":false,"schema":{}},"Cache-Control":{"deprecated":false,"schema":{}},"Content-Security-Policy":{"deprecated":false,"schema":{}},"Date":{"deprecated":false,"schema":{}},"Referrer-Policy":{"deprecated":false,"schema":{}},"Server":{"deprecated":false,"schema":{}},"Server-Timing":{"deprecated":false,"schema":{}},"Strict-Transport-Security":{"deprecated":false,"schema":{}},"Vary":{"deprecated":false,"schema":{}},"X-Content-Type-Options":{"deprecated":false,"schema":{}},"X-Debug-Token":{"deprecated":false,"schema":{}},"X-Debug-Token-Link":{"deprecated":false,"schema":{}},"X-Frame-Options":{"deprecated":false,"schema":{}},"X-Robots-Tag":{"deprecated":false,"schema":{}},"X-Symfony-Cache":{"deprecated":false,"schema":{}},"Transfer-Encoding":{"deprecated":false,"schema":{}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"salesChannelId":{"type":"string"},"customerId":{"type":"string"},"name":{"type":"string"},"private":{"type":"boolean"},"token":{"nullable":true},"priority":{"type":"integer"},"itemsCount":{"type":"integer"},"updatedAt":{"nullable":true},"createdAt":{"type":"string","format":"date-time"},"apiAlias":{"type":"string"}}},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri"}}},"relationships":{"type":"object","properties":{"salesChannel":{"type":"object","properties":{"data":{"nullable":true},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}},"customer":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"}}},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}},"products":{"type":"object","properties":{"data":{"type":"array","items":{}},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}}}},"meta":{"nullable":true}}}},"included":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object"},"links":{"type":"object"},"relationships":{"type":"object","properties":{"paypalVaultTokens":{"type":"object","properties":{"data":{"type":"array","items":{}},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}},"paypalVaultTokenMappings":{"type":"object","properties":{"data":{"type":"array","items":{}},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}},"customerWishlist":{"type":"object","properties":{"data":{"type":"array","items":{}},"links":{"type":"object","properties":{"related":{"type":"string","format":"uri"}}}}}}},"meta":{"nullable":true}}}},"links":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"self":{"type":"string","format":"uri"}}},"meta":{"type":"object","properties":{"totalCountMode":{"type":"integer"},"total":{"type":"integer"}}},"aggregations":{"type":"array","items":{}}}}}}},"401":{"description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"deprecated":false,"schema":{}},"Access-Control-Allow-Methods":{"deprecated":false,"schema":{}},"Access-Control-Allow-Origin":{"deprecated":false,"schema":{}},"Access-Control-Expose-Headers":{"deprecated":false,"schema":{}},"Cache-Control":{"deprecated":false,"schema":{}},"Date":{"deprecated":false,"schema":{}},"Server":{"deprecated":false,"schema":{}},"Server-Timing":{"deprecated":false,"schema":{}},"Vary":{"deprecated":false,"schema":{}},"X-Debug-Token":{"deprecated":false,"schema":{}},"X-Debug-Token-Link":{"deprecated":false,"schema":{}},"X-Robots-Tag":{"deprecated":false,"schema":{}},"X-Symfony-Cache":{"deprecated":false,"schema":{}},"Transfer-Encoding":{"deprecated":false,"schema":{}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","format":"utc-millisec"},"status":{"type":"string","format":"color"},"title":{"type":"string"},"detail":{"type":"string"},"meta":{"type":"object","properties":{"trace":{"type":"array","items":{"type":"object","properties":{"file":{"type":"string"},"line":{"type":"integer"},"function":{"type":"string"},"class":{"type":"string"},"type":{"type":"string","format":"ipv6"},"args":{"type":"array","items":{"type":"string"}}}}},"file":{"type":"string"},"line":{"type":"integer"},"previous":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","format":"utc-millisec"},"status":{"type":"string","format":"color"},"title":{"type":"string"},"detail":{"type":"string","format":"style"},"meta":{"type":"object","properties":{"trace":{"type":"array","items":{"type":"object","properties":{"file":{"type":"string"},"line":{"type":"integer"},"function":{"type":"string"},"class":{"type":"string"},"type":{"type":"string","format":"ipv6"},"args":{"type":"array","items":{"type":"object","properties":{"constraint":{"type":"string"}}}}}}},"file":{"type":"string"},"line":{"type":"integer"}}}}}}}}}}}}}}}}},"tags":["Wishlist"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.premsoft.de/en/plugins/wishlists-for-shopware-6/api/wishlist.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.