# Supercycle

## Docs

- [Our approach to AI](https://docs.supercycle.com/ai/approach.md): How Supercycle thinks about and implements AI across the platform
- [Builders MCP](https://docs.supercycle.com/ai/builders-mcp/overview.md): Give your AI tools direct access to Supercycle's documentation and API reference
- [Setup](https://docs.supercycle.com/ai/builders-mcp/setup.md): Connect the Builders MCP to your preferred AI client
- [Guidance for AI](https://docs.supercycle.com/ai/building/guidance-for-ai.md): Instructions for AI agents working with the Supercycle Builders MCP
- [Overview](https://docs.supercycle.com/ai/building/overview.md): Build custom tools, integrations, and workflows on the Supercycle API with AI assistance
- [AI at Supercycle](https://docs.supercycle.com/ai/index.md): Explore how AI enhances your circular commerce operations
- [Overview](https://docs.supercycle.com/ai/operations/overview.md): Manage your circular operations from your preferred AI chat with the Operators MCP
- [Operators MCP](https://docs.supercycle.com/ai/operators-mcp/overview.md): Use the Operators MCP to manage your circular models from your preferred AI chat
- [Security](https://docs.supercycle.com/ai/operators-mcp/security.md): Security model and best practices for the Operators MCP
- [Setup](https://docs.supercycle.com/ai/operators-mcp/setup.md): Connect the Operators MCP to your preferred AI client
- [Tools](https://docs.supercycle.com/ai/operators-mcp/tools.md): Tools available in the Operators MCP
- [Shopify Sidekick](https://docs.supercycle.com/ai/sidekick/shopify-sidekick.md): Access your Supercycle circular commerce data through Shopify's AI assistant
- [Overview](https://docs.supercycle.com/ai/support/overview.md): Get instant answers about Supercycle setup, features, and troubleshooting
- [Authentication](https://docs.supercycle.com/api-reference/admin/authentication.md): All Supercycle API calls require authentication via an API key, which can be generated from the Supercycle Admin interface.
- [Variant availability timeline](https://docs.supercycle.com/api-reference/admin/availabilitytimelines/variant-availability-timeline.md): Returns per-day available inventory counts for a variant over a forward window.
- [List all conditions](https://docs.supercycle.com/api-reference/admin/conditions/list-all-conditions.md): Returns a list of conditions.
- [List custom field definitions](https://docs.supercycle.com/api-reference/admin/customfielddefinitions/list-custom-field-definitions.md): Returns a list of custom field definitions filtered by owner type.
- [Retrieve a custom field definition](https://docs.supercycle.com/api-reference/admin/customfielddefinitions/retrieve-a-custom-field-definition.md): Returns details of a specific custom field definition.
- [Create a custom field](https://docs.supercycle.com/api-reference/admin/customfields/create-a-custom-field.md): Create a custom field on an item or rental. Specify the definition either by definitionId, or by key and ownerType.
- [Delete a custom field](https://docs.supercycle.com/api-reference/admin/customfields/delete-a-custom-field.md): Delete an existing custom field.
- [Update a custom field](https://docs.supercycle.com/api-reference/admin/customfields/update-a-custom-field.md): Update the value of an existing custom field.
- [Introduction](https://docs.supercycle.com/api-reference/admin/introduction.md): Access and manage your Supercycle data programmatically with the Admin API
- [Create an item](https://docs.supercycle.com/api-reference/admin/items/create-an-item.md): Create a new item against a product that has already been imported into Supercycle.
- [List all items](https://docs.supercycle.com/api-reference/admin/items/list-all-items.md): Returns a list of items and their details given parameters. Used by merchants to view their inventory.
- [Retrieve an item](https://docs.supercycle.com/api-reference/admin/items/retrieve-an-item.md): Returns all fields on an item. Can include timeline events if requested.
- [Update an item](https://docs.supercycle.com/api-reference/admin/items/update-an-item.md): Update an item's serial, condition, processing status, or, in future, its metafields.
- [List all locations](https://docs.supercycle.com/api-reference/admin/locations/list-all-locations.md): Returns a list of locations.
- [Pagination](https://docs.supercycle.com/api-reference/admin/pagination.md): List API methods use keyset pagination to limit the number of results returned per request
- [Create calendar method option](https://docs.supercycle.com/api-reference/admin/products/create-calendar-method-option.md): Creates an option for a product's calendar method. If the method does not exist, it is created first.
- [Create membership method option](https://docs.supercycle.com/api-reference/admin/products/create-membership-method-option.md): Creates an option for a product's membership method. If the method does not exist, it is created first.
- [Create or update calendar method](https://docs.supercycle.com/api-reference/admin/products/create-or-update-calendar-method.md): Creates or updates a calendar method for a product.
- [Create or update membership method](https://docs.supercycle.com/api-reference/admin/products/create-or-update-membership-method.md): Creates or updates a membership method for a product.
- [Create or update resale method](https://docs.supercycle.com/api-reference/admin/products/create-or-update-resale-method.md): Creates or updates a resale method for a product.
- [Create or update subscription method](https://docs.supercycle.com/api-reference/admin/products/create-or-update-subscription-method.md): Creates or updates a subscription method for a product.
- [Create resale method option](https://docs.supercycle.com/api-reference/admin/products/create-resale-method-option.md): Creates an option for a product's resale method. If the method does not exist, it is created first.
- [Create subscription method option](https://docs.supercycle.com/api-reference/admin/products/create-subscription-method-option.md): Creates an option for a product's subscription method. If the method does not exist, it is created first.
- [Import products](https://docs.supercycle.com/api-reference/admin/products/import-products.md): Import Shopify products into Supercycle by list.
- [List all products](https://docs.supercycle.com/api-reference/admin/products/list-all-products.md): Returns a list of all products in Supercycle. Likely to be used in conjunction with Shopify API to display information about the products.
- [List all rentals](https://docs.supercycle.com/api-reference/admin/rentals/list-all-rentals.md): Returns a list of rentals given parameters. Used by merchants to see rentals due for dispatch, return etc.
- [Retrieve a rental](https://docs.supercycle.com/api-reference/admin/rentals/retrieve-a-rental.md): View information about a single rental. Can include timeline events if requested.
- [Update a rental](https://docs.supercycle.com/api-reference/admin/rentals/update-a-rental.md): Update details about a rental - either edits or despatch/return information. Merchants may also update the Shopify order/fulfillment at the same time via the Shopify API.
- [Create a return](https://docs.supercycle.com/api-reference/admin/returnorders/create-a-return.md): Create a return by items. Return line statuses and conditions can be specified. If an item is in an existing return and has not active rentals, the endpoint updates the return line. If the item has multiple active rentals, the rental ID must be specified (return rental IDs with error).
- [List all returns](https://docs.supercycle.com/api-reference/admin/returnorders/list-all-returns.md): Get a list of returns, their details and items, given parameters. Used by merchants to list registered returns to start, or check if an item already exists in a return.
- [Retrieve a return](https://docs.supercycle.com/api-reference/admin/returnorders/retrieve-a-return.md): View information about a return. Can include timeline events if requested.
- [Update a return](https://docs.supercycle.com/api-reference/admin/returnorders/update-a-return.md): Update the status of a return and its return lines. Allows updating the overall return order status and individual return line statuses.
- [Create a timeline comment](https://docs.supercycle.com/api-reference/admin/timelinecomments/create-a-timeline-comment.md): Creates a new comment associated with a timeline event for a specific resource in a shop. The resource must belong to the authenticated shop.
- [Delete a timeline comment](https://docs.supercycle.com/api-reference/admin/timelinecomments/delete-a-timeline-comment.md): Deletes a timeline comment event for a specific shop. Only events with type 'comment' can be deleted.
- [Availability timeline](https://docs.supercycle.com/api-reference/storefront/availability-timelines.md): Fetch the availability of a variant across a date window.
- [Intent](https://docs.supercycle.com/api-reference/storefront/intent.md): Create an intent for a rental option.
- [Introduction](https://docs.supercycle.com/api-reference/storefront/introduction.md): Merchants wishing to create custom frontend experiences and workflows can integrate with our Storefront API.
- [Product availability](https://docs.supercycle.com/api-reference/storefront/product-availability.md): Fetch the availability of variants for a given set of products.
- [Requests](https://docs.supercycle.com/api-reference/storefront/requests.md): Making storefront API requests to Supercycle.
- [Methods filter](https://docs.supercycle.com/developers/app-blocks/availability-search.md): Allows customers to search by availability
- [Membership plans](https://docs.supercycle.com/developers/app-blocks/membership-plans.md): Show available membership plans on any page
- [Methods](https://docs.supercycle.com/developers/app-blocks/methods.md): Add all rental methods to a product page
- [Create rental bundles](https://docs.supercycle.com/developers/bundles.md): Group multiple products into a single rentable bundle and build a custom frontend experience using the Storefront API.
- [Supercycle prices](https://docs.supercycle.com/developers/code-snippets/display-prices.md): Display Supercycle prices on the front end
- [Link new and circular products](https://docs.supercycle.com/developers/code-snippets/link-new-and-circular.md): Link between a new Shopify products and circular products on the same page
- [Shopify notifications](https://docs.supercycle.com/developers/code-snippets/shopify-notifications.md): Display different content depending on what's ordered.
- [Show recurring payments in the cart](https://docs.supercycle.com/developers/code-snippets/show-recurring-payments.md): Add Liquid code to display plan details and total recurring costs for selling plan products.
- [Cycle line item property](https://docs.supercycle.com/developers/line-items/cycle-line-item-properties.md): Schema for the `_cycle` line item property.
- [Legacy rental intent token](https://docs.supercycle.com/developers/line-items/rental-intent-token.md): Documentation for the deprecated `_rental_intent_token` line item property.
- [Validations line item property](https://docs.supercycle.com/developers/line-items/validations-line-item-property.md): Schema for the `_validations` line item property.
- [Metafields](https://docs.supercycle.com/developers/metafields.md): Metafields for Shopify products, variants, and customers.
- [Overview](https://docs.supercycle.com/developers/overview.md): Add configurable app blocks to your Shopify theme.
- [Checkout language](https://docs.supercycle.com/documentation/configuration/checkout/checkout-language.md): Edit or remove default checkout messages that may confuse customers
- [Checkout rules](https://docs.supercycle.com/documentation/configuration/checkout/checkout-rules.md): Prevent checkout errors
- [Payments gateways](https://docs.supercycle.com/documentation/configuration/checkout/payments.md): Enable payments to continue testing your site
- [Custom data](https://docs.supercycle.com/documentation/configuration/custom-data.md): Custom data fields for your items and cycles
- [Patchworks integration](https://docs.supercycle.com/documentation/configuration/integrations/patchworks.md): Connectors for the Patchworks iPaaS platform
- [Logistics buffers](https://docs.supercycle.com/documentation/configuration/logistics/buffers.md): Time between rentals
- [Locations](https://docs.supercycle.com/documentation/configuration/logistics/locations.md): Enable when items are stored at multiple physical locations
- [Order cutoff time](https://docs.supercycle.com/documentation/configuration/logistics/order-cutoff-time.md): Define the latest a customer can rent
- [Pickup in store](https://docs.supercycle.com/documentation/configuration/logistics/pickup-in-store.md): Allow customers to collect rentals from your physical locations
- [Shipping](https://docs.supercycle.com/documentation/configuration/logistics/shipping.md): Shipping for Supercycle on Shopify.
- [Migrations overview](https://docs.supercycle.com/documentation/configuration/migrations/overview.md): Requirements and options for migrating to Supercycle
- [Migrate from Stripe](https://docs.supercycle.com/documentation/configuration/migrations/stripe.md): Import your Stripe customers and payment methods into Supercycle
- [Card vaulting](https://docs.supercycle.com/documentation/configuration/risk/card-vaulting.md): Capture customers' credit card using Shopify's subscription system to reduce risk and fraud by being able to charge the card.
- [Deposits](https://docs.supercycle.com/documentation/configuration/risk/deposits.md): Capture deposits against a rental
- [E-signatures](https://docs.supercycle.com/documentation/configuration/risk/esignatures.md): Require customers to sign rental contracts online or in store before fulfilling a rental.
- [Identity verification](https://docs.supercycle.com/documentation/configuration/risk/identity-verification.md): Verify your customers' identities using Stripe Identity to reduce risk and fraud
- [Using segments](https://docs.supercycle.com/documentation/manage/analytics/segments.md): Learn how to leverage Shopify Segments with Supercycle tags to organize and target customers effectively.
- [Automation overview](https://docs.supercycle.com/documentation/manage/automation/automation.md): Automate with triggers and actions using Shopify Flow
- [Create a workflow](https://docs.supercycle.com/documentation/manage/automation/create-workflow.md): Build automations using Supercycle triggers and actions in Shopify Flow
- [Charge actions](https://docs.supercycle.com/documentation/manage/charges/charge-actions.md): Creating and processing charges
- [Charges overview](https://docs.supercycle.com/documentation/manage/charges/charges.md): Record of charges for usage of product.
- [Dunning](https://docs.supercycle.com/documentation/manage/charges/dunning.md): Automated payment retry system for failed subscription billing
- [Payment attempts](https://docs.supercycle.com/documentation/manage/charges/payments.md): Payment attempts made against a charge.
- [Allocating items to cycles](https://docs.supercycle.com/documentation/manage/cycles/allocation.md): Ally, our item to cycle allocation algorithm
- [Cycles overview](https://docs.supercycle.com/documentation/manage/cycles/cycles.md): Manage active cycles and track their full lifecycle in Supercycle
- [Edit cycles on order](https://docs.supercycle.com/documentation/manage/cycles/edit-an-order.md): Change an existing cycle order directly from Shopify
- [Fulfilling cycles](https://docs.supercycle.com/documentation/manage/cycles/fulfil-a-rental.md): Find, ship, and return cycle orders using Supercycle.
- [Cycle actions](https://docs.supercycle.com/documentation/manage/cycles/rental-actions.md): Processing and updating cycles
- [Cycle statuses](https://docs.supercycle.com/documentation/manage/cycles/rental-statuses.md): Understanding cycle status lifecycle and when each status is triggered
- [Cycle troubleshooting](https://docs.supercycle.com/documentation/manage/cycles/rental-troubleshooting.md): Issues you might encounter with cycles and how to resolve them
- [Item actions](https://docs.supercycle.com/documentation/manage/inventory/item-actions.md): Updating inventory and items
- [Item conditions](https://docs.supercycle.com/documentation/manage/inventory/item-conditions.md): Log the current condition of an item
- [Items overview](https://docs.supercycle.com/documentation/manage/inventory/items.md): Inventory of individuals items
- [Serializing items](https://docs.supercycle.com/documentation/manage/inventory/serializing-items.md): How and why to track items with unique serial numbers
- [Managing method options](https://docs.supercycle.com/documentation/manage/products/managing-method-options.md): You can manage method pricing options in bulk
- [Multi-market pricing](https://docs.supercycle.com/documentation/manage/products/multi-market-pricing.md): Set different method options and prices per Shopify market
- [Product actions](https://docs.supercycle.com/documentation/manage/products/product-actions.md): Updating products and method pricing options
- [Products overview](https://docs.supercycle.com/documentation/manage/products/products.md): Import and manage products available with circular methods
- [Return actions](https://docs.supercycle.com/documentation/manage/returns/return-actions.md): Processing and updating returns
- [Returns overview](https://docs.supercycle.com/documentation/manage/returns/returns.md): Receive and process returned items from customers
- [Scanner overview](https://docs.supercycle.com/documentation/manage/scanner/scanner.md): Manage items from the Supercycle Scanner app.
- [Scanner actions](https://docs.supercycle.com/documentation/manage/scanner/scanner-actions.md): Running operations on the go.
- [Fixed fees](https://docs.supercycle.com/documentation/methods/calendar/fixed-fees.md): Break down pricing with fees
- [Calendar overview](https://docs.supercycle.com/documentation/methods/calendar/overview.md): Learn about running one-off rentals on your store
- [Product setup](https://docs.supercycle.com/documentation/methods/calendar/product-setup.md): Allow customers to rent a product one-off
- [Credit systems](https://docs.supercycle.com/documentation/methods/membership/credit-systems.md): Add price differentiation for items with varying costs
- [Membership overview](https://docs.supercycle.com/documentation/methods/membership/overview.md): Learn about running membership rental plans on your store
- [Plans setup](https://docs.supercycle.com/documentation/methods/membership/plans-setup.md): Create membership plans for your customers to subscribe to
- [Product setup](https://docs.supercycle.com/documentation/methods/membership/product-setup.md): Enable products for membership rental
- [Customer tags](https://docs.supercycle.com/documentation/methods/membership/shopify-tags.md): Organize your membership customers
- [Resale overview](https://docs.supercycle.com/documentation/methods/resale/overview.md): Selling your serialized items.
- [Product setup](https://docs.supercycle.com/documentation/methods/resale/product-setup.md)
- [Add a disclaimer](https://docs.supercycle.com/documentation/methods/subscription/add-a-disclaimer.md): Set clear delivery expectations with a note under requested start date.
- [Migrate subscriptions](https://docs.supercycle.com/documentation/methods/subscription/migration.md): Migrate subscriptions from other Shopify apps or external systems into Supercycle without interrupting billing.
- [Subscription overview](https://docs.supercycle.com/documentation/methods/subscription/overview.md): Offer access to products on a rolling basis
- [Product setup](https://docs.supercycle.com/documentation/methods/subscription/product-setup.md): Enable products for subscription rental
- [Start/end settings](https://docs.supercycle.com/documentation/methods/subscription/subscription-settings.md): Manage how subscription billing starts, stops, and appears on your storefront.
- [Customer emails](https://docs.supercycle.com/documentation/online-store/emails.md): About Supercycle's transactional emails
- [Languages and translations](https://docs.supercycle.com/documentation/online-store/languages.md): Localize, personalize and translate terms
- [Customer portal](https://docs.supercycle.com/documentation/online-store/portal.md): Allow customers to manage their accounts
- [Filter by availability](https://docs.supercycle.com/documentation/online-store/search.md): Allow customers to search by the availability of items
- [Introduction](https://docs.supercycle.com/documentation/overview/introduction.md): Add circular models to Shopify with Supercycle.
- [Methods](https://docs.supercycle.com/documentation/overview/methods.md): Circular commerce is charging for the same item multiple times, we support various models.
- [Platform](https://docs.supercycle.com/documentation/overview/platform.md): Overview of the Supercycle platform and how it works with Shopify
- [POS overview](https://docs.supercycle.com/documentation/point-of-sale/pos-overview.md): Create and manage rentals from Shopify POS.
- [Admin setup](https://docs.supercycle.com/documentation/setup/admin-setup.md): Configure your Shopify admin for Supercycle
- [Importing products](https://docs.supercycle.com/documentation/setup/importing-products.md): Import SKUs into Supercycle to create your rental inventory
- [Methods setup](https://docs.supercycle.com/documentation/setup/methods-setup.md): Configure your method/s
- [Getting started](https://docs.supercycle.com/documentation/setup/setup-guide.md): Get the basics setup on Supercycle.
- [Theme setup](https://docs.supercycle.com/documentation/setup/theme-setup.md): Add Supercycle to your chosen theme

## OpenAPI Specs

- [openapi-v1](https://app.supercycle.com/docs/openapi-v1.yml)
- [openapi](https://docs.supercycle.com/api-reference/openapi.json)