You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Added a reference for wishlist queries in the examples area in response
to the increased complexity of certain wishlist fields.
<!-- Ticket number or summary of work -->
# [DEVDOCS-6378]
## What changed?
* Wishlist complexity within GraphQL was changed.
* Previously we didn't document wishlists outside of the GQL reference
pages.
## Release notes draft
* We've added examples of wishlist queries to the storefront GraphQL
documentation along with a callout about complexity limits imposed by
certain fields
## Anything else?
ping { @bigcommerce/dev-docs-team }
[DEVDOCS-6378]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-6378?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
Copy file name to clipboardExpand all lines: docs/storefront/graphql/examples/index.mdx
+137Lines changed: 137 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -396,3 +396,140 @@ The `geography` node currently supports two filters, both available on the level
396
396
</Tab>
397
397
</Tabs>
398
398
<ahref="https://developer.bigcommerce.com/graphql-storefront/playground"target="_blank">**Try it in GraphQL Playground**</a>
399
+
400
+
## Get wishlist information
401
+
402
+
Wishlists are accessible through GraphQL and offer access to all standard wishlist management functions. In addition to retrieving information through the queries `customers.wishlists` and `site.publicWishlist` outlined below, the mutations `createWishlist`, `addWishlistItems`, `deleteWishlistItems`, `updateWishlist`, and `deleteWishlists` are provided for managing customer wishlists.
403
+
404
+
Public wishlists are read-only within GraphQL.
405
+
406
+
<Callouttype="warning">
407
+
The `items` field in both customer and public wishlist queries greatly increases query complexity. This means that the cost for deeply nested or large queries involving wishlist items grows rapidly. As a result, complex queries may hit rate or complexity limits sooner than expected. For platform stability, plan queries with this in mind and retrieve only the data you need.
408
+
</Callout>
409
+
410
+
### Customer wishlists
411
+
412
+
Customer wishlists are queried based on the current customer session, using the token generated during the authentication process to identify the customer for the query's response data.
0 commit comments