Creating an API key

Authenticating requests with API key

Supercycle

App blocks

Book a demo

Supercycle.com

All Supercycle API calls require authentication via an API key, which can be generated from the Supercycle Admin interface.

Authentication

Let's get your rental store on the road (in under an hour)

Welcome to Supercycle

Rental comes in different shapes to fit different products and customers

Rental methods

Learn how Supercycle builds upon Shopify&rsquo;s strong foundations

Supercycle and Shopify

Install Supercycle

Make Supercycle visible to your customers

Theme engine

Enable payments to continue testing your site

Payments setup

Import SKUs into Supercycle to create your rental inventory

Importing products

Learn about running one-off rentals on your store

Calendar overview

Allow customers to rent a product one-off

Product setup

Fixed fees

Learn about running membership rental plans on your store

Membership overview

Add price differentiation for items with varying costs

Credit systems

Create membership plans for your customers to subscribe to

Plans configuration

Customer tags

Offer access to products on a rolling basis

Subscription overview

Choose a store-wide interval to bill subscription products on

Billing interval setup

Create a deposit amounts to be assigned to subscription rental products

Create deposits

Create and manage inventory in Supercycle

Managing inventory

Add rentable inventory to an imported SKU

Create inventory

Item conditions

Make unavailable

Remove an item from circulation permanently

Retire and delete

Meet our next-generation allocation algorithm

Introducing Ally

Give your team time between rentals to refurbish and fulfill items

Logistics buffers

Order cutoff time

Create rental

Change dates or the item assigned to a rental

Make changes to a rental

Remove rentals that are no longer required

Delete rental

Supercycle returns differ to Shopify returns

About returns

Learn how you and your customers can initiate a rental return

Return creation

Processing returns

Restocking items

Email notifications

Portal URL

Mix and match components to create a custom rental experience.

Overview

Rent buttons are added to the product page to allow customers to rent products.

Methods

Allows customers to search by availability

Availability search

Membership plans

Merchants wishing to run operations outside of Shopify can view and update objects in Supercycle via our REST API

Introduction

List API methods use keyset pagination to limit the number of results returned per request

Pagination

Returns a list of items and their details given parameters. Used by merchants to view their inventory.

List all items

Create a new item against a product that has already been imported into Supercycle.

Create an item

Retrieve an item

Update an item's serial, condition, processing status, or, in future, its metafields.

Update an item

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 products

Import Shopify products into Supercycle by list.

Import products

Returns a list of rentals given parameters. Used by merchants to see rentals due for dispatch, return etc.

List all rentals

Retrieve a rental

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.

Update a rental

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.

List all returns

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).

Create a return

Retrieve a return

Update status of a return or items in a return, or add an item to an existing return.

API Reference

Items

Products

Rentals

ReturnOrders

Authentication

Creating an API key

Authenticating requests with API key

API Reference

Items

Products

Rentals

ReturnOrders

​Creating an API key

​Authenticating requests with API key

Creating an API key

Authenticating requests with API key