# Swish Docs

- [Overview](https://swish.app/docs/guides/get-started/overview.md): Swish is a Shopify app that adds wishlists, saved items, back-in-stock alerts, and more to your store.
- [Quickstart](https://swish.app/docs/guides/get-started/quickstart.md): Install Swish and add your first shopping tools in minutes.
- [Migration guide](https://swish.app/docs/guides/get-started/migration.md): Import saved items from your previous wishlist app into Swish.
- [Moving to the new admin](https://swish.app/docs/guides/get-started/new-admin.md): Move your store from the previous version of the Swish admin to the new one, and switch your theme to the Swish app embed.
- [Wishlist](https://swish.app/docs/guides/features/wishlist.md): Let customers save products and pick up where they left off across devices.
- [Save from cart](https://swish.app/docs/guides/features/save-from-cart.md): Automatically save items for customers when they remove products from the cart.
- [Recently viewed](https://swish.app/docs/guides/features/recently-viewed.md): Automatically track and display products your customers have viewed.
- [Notifications](https://swish.app/docs/guides/features/notifications.md): Alert customers about price drops, back-in-stock, and low-stock changes on their saved products.
- [Orders](https://swish.app/docs/guides/features/orders.md): Let signed-in customers view their order history directly inside the Swish drawer.
- [Account](https://swish.app/docs/guides/features/account.md): Enable customer sign-in and account access within the Swish drawer.
- [Overview](https://swish.app/docs/guides/customize/overview.md): Configure Swish to match your store's look, feel, and functionality.
- [Full defaults](https://swish.app/docs/guides/customize/defaults.md): Copy-paste reference with every option and its default value.
- [Design](https://swish.app/docs/guides/customize/appearance/design.md): Customize colors, fonts, spacing, and other visual properties to match your brand.
- [Icons](https://swish.app/docs/guides/customize/appearance/icons.md): Replace built-in icons with custom SVG strings.
- [Custom CSS](https://swish.app/docs/guides/customize/appearance/css.md): Inject custom stylesheets into the Swish UI shadow DOM.
- [Placements overview](https://swish.app/docs/guides/customize/placements/overview.md): Control where Swish buttons appear on your store.
- [Header](https://swish.app/docs/guides/customize/placements/header.md): Add the Swish button to your store header.
- [Collections](https://swish.app/docs/guides/customize/placements/collections.md): Add save buttons to product cards on collection pages.
- [Product detail](https://swish.app/docs/guides/customize/placements/product-detail.md): Add a save button or a Notify Me button to your product detail page.
- [Views overview](https://swish.app/docs/guides/customize/views/overview.md): How views and sections work in the Swish UI.
- [Drawer](https://swish.app/docs/guides/customize/views/drawer.md): Configure the drawer header, footer, and navigation bar.
- [Home](https://swish.app/docs/guides/customize/views/home.md): Configure the home view, the default landing screen when the drawer opens.
- [Saves](https://swish.app/docs/guides/customize/views/saves.md): Configure the saves view that displays all saved items.
- [Lists](https://swish.app/docs/guides/customize/views/lists.md): Configure the lists view that displays customer lists.
- [List detail](https://swish.app/docs/guides/customize/views/list-detail.md): Configure the in-drawer list detail view that displays a single list's items.
- [Product detail](https://swish.app/docs/guides/customize/views/product-detail.md): Configure the product detail view with images, variants, and buy buttons.
- [Orders](https://swish.app/docs/guides/customize/views/orders.md): Configure the orders view.
- [Order detail](https://swish.app/docs/guides/customize/views/order-detail.md): Configure the order detail view with line items and actions.
- [Profile](https://swish.app/docs/guides/customize/views/profile.md): Configure the profile view.
- [Notifications](https://swish.app/docs/guides/customize/views/notifications.md): Configure the notifications view.
- [List detail page](https://swish.app/docs/guides/customize/views/list-detail-page.md): Set up and configure a dedicated wishlist page that displays list items in a product grid.
- [Intents](https://swish.app/docs/guides/customize/intents.md): Configure save, unsave, and cart behavior.
- [Transforms](https://swish.app/docs/guides/customize/transforms.md): Customize how product, variant, and option data is displayed in the Swish UI.
- [Metafields](https://swish.app/docs/guides/customize/metafields.md): Preload Shopify metafields onto products and variants so you can read them from transforms, intents, and views.
- [Translations](https://swish.app/docs/guides/customize/translations.md): Customize or translate any text in the Swish UI by overriding translation keys.
- [Overview](https://swish.app/docs/guides/headless/overview.md): Use Swish with Hydrogen, Next.js, or any custom React storefront.
- [Auth proxy](https://swish.app/docs/guides/headless/auth-proxy.md): Set up the Swish auth proxy to securely create API tokens from headless storefronts.
- [Hydrogen](https://swish.app/docs/guides/headless/hydrogen.md): Add wishlists and saved items to a Shopify Hydrogen storefront with the Swish React SDK.
- [Next.js](https://swish.app/docs/guides/headless/nextjs.md): Add wishlists and saved items to a Next.js storefront with the Swish React SDK.
- [Cursor](https://swish.app/docs/ai-tools/cursor.md): Set up Cursor to build with Swish using skills and MCP
- [Claude](https://swish.app/docs/ai-tools/claude-code.md): Set up Claude to build with Swish using skills and MCP
- [Overview](https://swish.app/docs/integrations/overview.md): Connect Swish with your marketing and automation platforms.
- [Integration events](https://swish.app/docs/integrations/integration-events.md): Reference for all events emitted by Swish, including payload shapes and metadata.
- [Attentive](https://swish.app/docs/integrations/platforms/attentive.md): Send Swish wishlist events to Attentive for SMS and email marketing.
- [Bloomreach](https://swish.app/docs/integrations/platforms/bloomreach.md): Send Swish wishlist events to Bloomreach for customer data enrichment and marketing automation.
- [Braze](https://swish.app/docs/integrations/platforms/braze.md): Send Swish wishlist events to Braze for cross-channel customer engagement.
- [Brevo](https://swish.app/docs/integrations/platforms/brevo.md): Send Swish wishlist events to Brevo for email and SMS marketing automation.
- [Klaviyo](https://swish.app/docs/integrations/platforms/klaviyo.md): Send Swish wishlist events to Klaviyo for email and SMS automation.
- [Meta Pixel](https://swish.app/docs/integrations/platforms/meta-pixel.md): Send every save to your Meta Pixel as an AddToWishlist event, for audiences and retargeting.
- [Ometria](https://swish.app/docs/integrations/platforms/ometria.md): Send Swish wishlist events to Ometria for customer data and marketing automation.
- [Omnisend](https://swish.app/docs/integrations/platforms/omnisend.md): Send Swish wishlist events to Omnisend for ecommerce email and SMS marketing.
- [Shopify Flow](https://swish.app/docs/integrations/platforms/shopify-flow.md): Trigger Shopify Flow workflows from Swish wishlist events.
- [Overview](https://swish.app/docs/references/sdk/overview.md): Overview of the Swish SDK's public API surface.
- [Configuration](https://swish.app/docs/references/sdk/configuration.md): Reference for all SDK options - storefront credentials, context, metafields, transforms, intents, placements, UI views, and translations.
- [Intents](https://swish.app/docs/references/sdk/intents.md): Reference for all Swish SDK intents, their parameters, and invocation methods.
- [State](https://swish.app/docs/references/sdk/state.md): Reference for the Swish SDK reactive state API - track saved items, lists, product context, and item counts with signals.
- [Elements](https://swish.app/docs/references/sdk/elements.md): Reference for the Swish declarative custom elements - <swish-save> and <swish-drawer>.
- [Placements](https://swish.app/docs/references/sdk/placements.md): Reference for the Swish SDK Placement API - insert Swish buttons into your theme without editing template files.
- [Events](https://swish.app/docs/references/sdk/events.md): Reference for the Swish SDK event bus - subscribe to item, list, cart, and notification events.
- [API client](https://swish.app/docs/references/sdk/api-client.md): Reference for the Swish API client - query and mutate saved items, lists, orders, notifications, and smart lists.
- [Storefront API client](https://swish.app/docs/references/sdk/storefront.md): Reference for the Swish SDK's Shopify Storefront API client - load products, images, recommendations, and run custom queries.
- [Utilities](https://swish.app/docs/references/sdk/utilities.md): Reference for Swish SDK utility functions and UI element creation.
- [Examples](https://swish.app/docs/references/sdk/examples.md): Common storefront use cases built with the Swish SDK - custom elements first, state helpers and React hooks where you need more control.
- [Overview](https://swish.app/docs/references/react/overview.md): React bindings for the Swish SDK - a provider and hooks for integrating Swish into React and Next.js apps.
- [SwishProvider](https://swish.app/docs/references/react/provider.md): Reference for the SwishProvider component - loads the Swish SDK and provides it to hooks via React context.
- [Hooks](https://swish.app/docs/references/react/hooks.md): Reference for all React SDK hooks - query saved items, invoke intents, manage save state, and track item counts.
- [Overview](https://swish.app/docs/references/api/overview.md): Base URL, versioning, response format, and client libraries for the Swish REST API.
- [Authentication](https://swish.app/docs/references/api/authentication.md): Authenticate requests to the Swish API using API keys or client tokens.
- [Rate limits](https://swish.app/docs/references/api/rate-limits.md): Understand Swish API rate limits and how to handle throttled requests.
- [Pagination](https://swish.app/docs/references/api/pagination.md): Iterate through paginated collections using cursor-based pagination.
- [Errors](https://swish.app/docs/references/api/errors.md): Handle Swish API errors using the standard error envelope and HTTP status codes.
- [Get the current profile](https://swish.app/docs/api-reference/profiles/get-the-current-profile.md): Returns the profile for the authenticated user
- [Create a profile token](https://swish.app/docs/api-reference/profiles/create-a-profile-token.md): Creates a JWT token for a customer or session profile
- [Identify a profile](https://swish.app/docs/api-reference/profiles/identify-a-profile.md): Identifies a profile by email or phone number
- [Update the current profile](https://swish.app/docs/api-reference/profiles/update-the-current-profile.md): Updates profile fields such as about text, notification preferences, and marketing consent
- [List all items](https://swish.app/docs/api-reference/items/list-all-items.md): Returns all items as a paginated response with optional filtering and sorting
- [Create an item](https://swish.app/docs/api-reference/items/create-an-item.md): Creates a new item (product save) for the authenticated profile
- [Delete multiple items](https://swish.app/docs/api-reference/items/delete-multiple-items.md): Deletes multiple items by their IDs
- [Get item count](https://swish.app/docs/api-reference/items/get-item-count.md): Returns the total count of items for the authenticated profile
- [Get an item by ID](https://swish.app/docs/api-reference/items/get-an-item-by-id.md): Returns a single item with its list associations
- [Update an item](https://swish.app/docs/api-reference/items/update-an-item.md): Updates an item by its ID
- [Delete an item](https://swish.app/docs/api-reference/items/delete-an-item.md): Deletes a single item by its ID
- [Set item lists](https://swish.app/docs/api-reference/items/set-item-lists.md): Sets which lists an item belongs to, replacing any previous list assignments
- [List all lists](https://swish.app/docs/api-reference/lists/list-all-lists.md): Returns all lists as a paginated response with optional sorting
- [Create a list](https://swish.app/docs/api-reference/lists/create-a-list.md): Creates a new list, optionally with items
- [Get a list by ID](https://swish.app/docs/api-reference/lists/get-a-list-by-id.md): Returns the list with its details
- [Update a list](https://swish.app/docs/api-reference/lists/update-a-list.md): Updates a list's name or access level
- [Delete a list](https://swish.app/docs/api-reference/lists/delete-a-list.md): Deletes a list by its ID
- [Add items to a list](https://swish.app/docs/api-reference/lists/add-items-to-a-list.md): Adds existing items to a list by their IDs
- [Reorder list items](https://swish.app/docs/api-reference/lists/reorder-list-items.md): Sets the order of items within a list
- [Remove an item from a list](https://swish.app/docs/api-reference/lists/remove-an-item-from-a-list.md): Removes a specific item from a list without deleting the item itself
- [List all shared lists](https://swish.app/docs/api-reference/shared-lists/list-all-shared-lists.md): Returns all shared lists as a paginated response
- [Save a shared list](https://swish.app/docs/api-reference/shared-lists/save-a-shared-list.md): Saves a public list as a shared list for the authenticated profile
- [Get a shared list by ID](https://swish.app/docs/api-reference/shared-lists/get-a-shared-list-by-id.md): Returns the shared list with its details
- [Delete a shared list](https://swish.app/docs/api-reference/shared-lists/delete-a-shared-list.md): Removes a shared list entry without affecting the original list
- [Get shared list items](https://swish.app/docs/api-reference/shared-lists/get-shared-list-items.md): Retrieves all items from a shared list as a paginated response.
- [Get all smart lists](https://swish.app/docs/api-reference/smart-lists/get-all-smart-lists.md): Returns all available smart lists with their details.
- [Get smart list by ID](https://swish.app/docs/api-reference/smart-lists/get-smart-list-by-id.md): Returns a specific smart list with its details.
- [Get smart list items](https://swish.app/docs/api-reference/smart-lists/get-smart-list-items.md): Returns items for a specific smart list as a paginated response.
- [Remove an item from a smart list](https://swish.app/docs/api-reference/smart-lists/remove-an-item-from-a-smart-list.md): Removes a single item from a smart list by permanently deleting its backing record.
- [List notifications](https://swish.app/docs/api-reference/notifications/list-notifications.md): Returns notifications as a paginated response with optional filtering
- [Mark notifications as read](https://swish.app/docs/api-reference/notifications/mark-notifications-as-read.md): Marks specified notifications as read by their IDs
- [Mark all notifications as read](https://swish.app/docs/api-reference/notifications/mark-all-notifications-as-read.md): Marks all notifications as read for the authenticated profile
- [Get unread notification count](https://swish.app/docs/api-reference/notifications/get-unread-notification-count.md): Returns the total count of unread notifications for the authenticated profile
- [Delete a notification](https://swish.app/docs/api-reference/notifications/delete-a-notification.md): Deletes a notification by its ID
- [List all orders](https://swish.app/docs/api-reference/orders/list-all-orders.md): Returns all orders as a paginated response
- [Get an order by ID](https://swish.app/docs/api-reference/orders/get-an-order-by-id.md): Returns order detail with line items and tracking information
- [List all subscriptions](https://swish.app/docs/api-reference/subscriptions/list-all-subscriptions.md): Returns all subscriptions as a paginated response with optional filtering
- [Create a subscription](https://swish.app/docs/api-reference/subscriptions/create-a-subscription.md): Creates a new product subscription
- [Get a subscription by ID](https://swish.app/docs/api-reference/subscriptions/get-a-subscription-by-id.md): Returns a single subscription by its ID
- [Update a subscription](https://swish.app/docs/api-reference/subscriptions/update-a-subscription.md): Updates a subscription's status or variant
- [Delete a subscription](https://swish.app/docs/api-reference/subscriptions/delete-a-subscription.md): Deletes a subscription by its ID
- [Collect user behavior events](https://swish.app/docs/api-reference/tracking/collect-user-behavior-events.md): Endpoint for collecting user behavior events.
- [Product updates](https://swish.app/docs/changelog.md): New releases and improvements to Swish

## OpenAPI Specs

- [openapi](https://swish.app/api/2026-07/.well-known/openapi)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.