Skip to main content
Custom fields add your own fields to items, cycles, and consignors, so you can capture information Supercycle’s standard fields don’t cover: specialized attributes, internal notes, or data specific to how you run the business. Each field is a custom field definition, and every record of that type gets the field. Definitions are managed under Custom data. For products, variants, orders, and customers, use Shopify metafields instead. Shopify metafields and Supercycle custom fields can coexist on the same record. For read-only fields computed from a formula, see Calculated fields.

​
Create a custom field definition

1

Open custom data settings

Go to Custom data and select Items, Cycles, or Consignors.
2

Add a definition

Select Add definition.

Select Add definition, name the field, then Save.

3

Set the field details

Enter a Name, the display name shown on the record, such as Purchase order number. The Key is generated from the name and can be edited. Set the Type from the field types below.
4

Save

Select Save in the save bar.
The type can’t be changed after the definition is created. Choose it carefully.

​
Field types

​
Display as relative time

Definitions with type Date or Date and time have a Display as relative time checkbox. Tick it to show how long ago the date was instead of the date itself, so January 1, 2025 reads as 1 year 8 months. It suits anything you’d otherwise keep up to date by hand, such as the age of a bike. Store the purchase date once and the elapsed time stays accurate on its own. Dates less than a month old show in days, hours, or minutes. Only the display changes: the stored value is still a date, editing the field still uses the date picker, and the API returns the date. The checkbox clears if you change the type away from date or date and time.

​
Include in consignor payouts

When consignment is on, item and cycle definitions with type Money or Integer have an Include in consignor payouts checkbox. Tick it to add the field as a column on consignor payout breakdown reports, for example a repair fee your revenue share formula deducts. Values read live from the entry’s item or cycle when you open the payout, so fees entered after the sale still appear. Money columns on the payout itself stay frozen at earning time. If the field is empty or its source record was deleted, the cell is blank. The checkbox clears if you change the type away from money or integer.

​
Manage custom field definitions

Select a definition’s name in the custom data table to edit it. You can change the name and key, but not the type. The table shows how many items or cycles use each definition, which helps you spot unused fields. Delete an unused definition with Delete on its page.
Deleting a definition removes its values from every record and can’t be undone.

​
Considerations

Use clear, descriptive names your team recognizes, such as Warranty expiration or Purchase order number. Keys are generated from the name, but you can edit them for API consistency. Use lowercase letters, numbers, and underscores only.