Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.supercycle.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Create items

You should create inventory inside your Supercycle product, not your Shopify product, as Supercycle is responsible for inventory management after import.
1

Navigate to the product

In Shopify Admin, head to Supercycle > Products > Product.
2

Add inventory

In the variants table, under the status you want to add a product, select the current quantity dropdown followed by Add inventory.
3

Add serials

On the next page, add a serial number on a new line for each item you’d like to create.Alternatively, select Add without serials and enter a number of items. You can add serials to the newly created items later from their item page.
Click Review to continue.
4

Review new items

Review the items you’re about to add and click Add inventory to save your changes.
1

Download the import template

Always use the provided template (Sample CSV). Exports often contain extra columns that imports ignore.
Download example CSV
2

Fill in required columns

Every row represents one item. Include these columns:
ColumnPurpose
ItemUnique ID for the item (for example, #2001). New ID = new item. Existing ID = update that item.
Variant Shopify IDLinks the item to its Shopify product variant.
SKUStock keeping unit. Recommended even if Variant ID is included.
VisibilitySets whether the item is available or unavailable.
StatusWorkflow state, such as processed, unprocessed, or retired.
Optional columns include Condition.
Mandatory fields for the import
3

Add new items

Use a new Item ID or Serial number and provide the correct Variant Shopify ID and SKU.
Example:
Example CSV row for new items
4

Update existing items

Keep the same Item ID but change values like condition, visibility, or status.
Example:
Example CSV row for updating existing items
5

Deactivate items

The importer cannot delete items. To remove an item from circulation, set:
  • Visibility = unavailable
  • Status = retired
Example:
Example CSV row for deactivating items
6

Upload the file

Import the completed CSV into Supercycle. Changes are applied immediately, and the store owner receives an email report showing how many items were added, how many were updated, and any failures.

​
Common mistakes

  • Leaving Variant Shopify ID and SKU blank → item cannot be linked.
  • Reusing an Item ID for a new unit → overwrites instead of creating.
You can create a new item by scanning a serial number with the Supercycle Scanner.
1

Scan a barcode, QR code or RFID tag

If the scanned serial number doesn’t already exist in Supercycle, the Create item model will open automatically.
2

Select a product

Press Select a product, this will load of list of all the products in Supercycle. Scroll or search to find the product and variant for the item you have scanned.
3

Select a status

Confirm the status for the new item (Active, Draft, Retired, Sold).
4

Create the item

Press Create item to finish adding the new item to your inventory.
After the item is created, Supercycle opens the item details page. From there, you can review and update additional info, such as the pick location.

​
Make item unavailable

If there’s something wrong with an item and you need to stop future rentals from being placed on it temporarily, you can make it unavailable.
Making an item unavailable won’t remove its existing future rentals. You should go through its existing rentals and reassign them if necessary.
Make item unavailable by changing the Visibility status to Draft.
If you need to make an item permanently unavailable, you should retire the item.

​
Delete items

If an item has no previous rentals on it, you can delete it. We recommend only using this for items created accidentally, as all of the item’s data will be permanently deleted (affecting analytics on stock utilization).
Delete items action from the Actions options on the Inventory table.

​
Retire item

Retiring an item will prevent future rentals from being placed against it. Retiring can be reversed, although if you intend to remove an item from circulation temporarily we recommend making it unavailable instead.
Retire item from the Visibility field.

​
Update item condition

Update condition from the Condition field.
Update condition action from the Actions options on the Inventory table.
Update item condition action from the Actions options on the Cycles table.

​
Update item processing state

Update processing state from the Warehouse field.
Update status action from the Actions options on the Inventory table.
Update item status action from the Actions options on the Cycles table.

​
Update item warehouse location

Update location from the Location field.
Update location action from the Actions options on the Inventory table.

​
Update item tags

Update tags from the Tags field.
Use the add_tag or remove_tag tool with:
  • resource_type - item
  • resource_id - Item ID (e.g. #1042)
  • tag - Tag title to add or remove
Use the Update an item endpoint with the tagsAttributes parameter.