Glossary

All Swell Terms

A

AccountModel

The account model

AccountModel

The customer account model

Account AddressesModel

The account addresses model

Account CardModel

The card model

Account creditModel

The credit model

AddressModel

This is the address model

Related Items
Asset fieldModel

For binary files such as media and documents. Stored as an array of files if `multi` is `true`, otherwise as a single file.

AttributeModel

The attributes model

B

Bool fieldModel

A true/false value. Stored as a boolean.

C

CartModel

The cart model

CategoryModel

the category model

Color fieldModel

For representing color swatches as Hex, RGB, or HSL codes. Stored as a string.

ContactModel

The contact model

CouponModel

The coupon model

Coupon UseModel

The use model

Coupon codeModel

The coupon code model

Coupon generationModel

The generation model

Credit memoModel

The credit memo model

CurrencyModel

The currency model

collection fieldModel

A nested collection of records or references to records in another collection. Stored as an array. Can be infinitely nested, and supports either single or multiple item types.

D

Date fieldModel

For date and time input. Stored as an ISO 8601 date/time string. A variety of input formats are accepted for the value, including Unix time in milliseconds, a parseable timestamp string, or simply \'now\'.

DownloadModel

The download model

E

EventModel

The events model

Events webhookModel

The events webhook model

F

Field group fieldModel

For grouping several conceptually related fields together to make the editing UI more intuitive and less cluttered. Stored as an array of fields.

G

Gift CardModel

The gift card model

Gift card debitModel

the debit model

I

InvoiceModel

The invoice model

icon fieldModel

Choose from a list of icons. Stored as a string.

int fieldModel

For values that need to be parsed as numbers. Stored as a float if `digits` are specified, otherwise as an integer.

L

Long Text fieldModel

For multiple lines of text that can have formatting. Stored as a string.

lookup fieldModel

For referencing a record of another model. Stored as a string.

N

NotificationModel

The notification model

O

OrderModel

The order model

P

PageModel

The page model

PagesModel

The pages model

PaymentModel

The payment object

Product

A product is a thing you can buy!

ProductModel

The product model

Product variantModel

The variant model

PromotionModel

The promotion model

Promotion UseModel

The use model

R

RefundModel

The refund model

ReturnModel

The return model

ReviewModel

The review model

S

Select fieldModel

For defining multiple options that can be chosen from. The stored value type depends on how `options` and `multi` are configured.

ShipmentModel

The shipment model

Short Text fieldModel

For a single line of text. Stored as a string.

StockModel

The stock model

SubscriptionModel

The subscription model

T

Tags fieldModel

For a set of arbitrary tags that can be ordered manually. Stored as an array of strings.

W

WebhookModel

The webhook model

Still have questions?

Chat with us

If your plan includes support, open a chat from your admin dashboard.

Check out our community

Search and ask questions in Swell's active community