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

Introduction

Supercycle

Everything you need to know to add circular models to Shopify with Supercycle.

Welcome to Supercycle

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

Supercycle and Shopify

Quickstart

Circular commerce is charging for the same item multiple times, we support various models.

Methods

Resale

Import and manage products available with circular methods

Products

Returns

Invoices

Emails

Portal

Allow customers to search by the availability of items

Search

Localize, personalize and translate terms

Languages

Enable payments to continue testing your site

Payments

Deposits

Custom data fields for your items and rentals

Custom data

Add configurable app blocks to your Shopify theme.

Overview

Allows customers to search by availability

Availability search

Show available membership plans on any page

Membership plans

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

Items

Conditions

Rentals

Ally, our item to rental allocation algorithm

Allocation

Enable when items are stored at multiple physical locations

Locations

Give your team time between rentals to refurbish and fulfill items

Buffers

Order cutoff time

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

Authentication

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

Pagination

List all conditions

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.

Admin API

Conditions

Items

Products

Rentals

ReturnOrders

Introduction