Backend API
Fields
Unique identifier for the product.
Human-friendly name of the product.
Indicates whether the product is active and available in the storefront.
Configuration of one or more purchase options for the product. Can be standard for one-time purchases or subscription for a subscription plan. Products can support both purchase options simultaneously.
Designates purchase option as a one-time purchase.
ID of the purchase option.
The name of the purchase option.
A long-form description of the product. May contain HTML or other markup languages.
Indicates whether the purchase option is available for customers to purchase. Inactive products will not be returned on the Frontend.
List price used when sale=false or sale_price is not defined.
Indicates whether the product option is on sale. If true, the sale_price will be used by default when the product is added to a cart.
Sale price used by default when sale=true, overriding price. Overrides product sale price.
Price rules determined by cart quantity or customer account group. Overrides price and sale_price when conditions match.
Price applied when conditions are met.
Customer account group as a condition to apply price.
Maximum quantity as a condition to apply price.
Minimum quantity as a condition to apply price.
Array of account groups that are eligible to access the purchase option within the storefront.
Designates purchase option for a subscription plan.
ID of the subscription plan purchase option.
Name of the subscription plan purchase option.
A long-form description of the purchase option. May contain HTML or other markup languages.
Indicates whether the purchase option is available for customers to purchase. Inactive products will not be returned on the Frontend.
Array of account_group names for which the purchase option is available.
Array defining subscription plans and their respective configurations.
ID of the purchase option subscription plan.
Name of the subscription plan.
A long-form description of the subscription plan. May contain HTML or other markup languages.
Indicates whether the subscription plan is available for customers to purchase. Inactive products will not be returned on the Frontend.
List price used when sale=false or sale_price is not defined.
Price rules determined by cart quantity or customer account group. Overrides price and sale_price when conditions match.
Price applied when conditions are met.
Customer account group as a condition to apply price.
Maximum quantity as a condition to apply price.
Minimum quantity as a condition to apply price.
Determines the billing schedule for the subscription plan.
Subscription plan billing interval. Can be daily, weekly, monthly, or yearly.
Possible enum values:
Multiplier for billing interval. For example, to make the billing cycle once every two weeks, set interval=weekly and interval_count=2.
Specifies a limit to the number of billing cycles for the subscription plan. For example, limit=10 would stop billing the customer after the tenth billing cycle.
Number of days offered as a free trial on the subscription plan before the customer is billed. If a subscription is canceled by the last day of the trial period, an invoice won't be issued.
An object containing custom attribute values, keyed by each attribute's id. A value can be a single value or an array.
Indicates whether the product is a bundle of other products.
List of products sold as a bundle. Applicable only when bundle=true.
Unique identifier for the bundle item.
ID of the bundled product.
Expandable link to the bundled product.
Quantity of the bundled product. Defaults to 1.
ID of the bundled variant, if applicable.
Expandable link to the bundled product variant, if applicable.
This field is a copy of the item's product.name.
Expandable link to the primary category.
Primary category, commonly used as a navigation anchor.
Expandable link to all related product categories.
Index of categories used for fast lookup operations.
List of related product category IDs.
Index of category IDs and their respective sort positions.
Unique code to identify the gift card product.
Cost of goods (COGS) used to calculate gross margins.
List of products to display as cross-sells on a shopping cart page.
Unique identifier for the cross-sell object.
ID of the cross-sell product.
Expandable link to the cross-sell product.
Type of discount to apply, either fixed or percent.
Possible enum values:
Discount to apply as a fixed amount. Applicable only when discount_type=fixed.
Discount to apply as a percentage. Applicable only when discount_type=percent.
Three-letter ISO currency code in uppercase. Defaults to your store's base currency.
Indicates whether the product has custom options enabled.
Date and time the product was created.
Date and time the product was last updated.
Method of fulfillment automatically assigned based on type:
- shipment means the product will be physically shipped to a customer.
- subscription means the product will be fulfilled as a subscription when an order is placed. giftcard delivery means the product will be fulfilled as a gift card when an order is placed.
- null means the product will not be fulfilled by one of the above methods.
Note: A bundle has its child products fulfilled individually; each product in the bundle must have its own fulfillment method.
Possible enum values:
A long-form description of the product. May contain HTML or other markup languages.
Indicates whether the product has been discontinued.
List of images depicting the bundle.
Unique identifier for the image.
A brief description of the image, intended for display as a caption or alt text.
An object representing the image's source file.
Unique identifier for the file.
Optional file name.
A reference to the raw file data.
MIME content type of the file.
Date the file was uploaded.
Image height in pixels, if applicable.
Size of the file in bytes.
A set of arbitrary data that is typically used to store custom values.
An MD5 hash of the file contents. This can be used to uniquely identify the file for caching purposes.
Indicates whether the file is private.
A public URL to reference the file. Updated automatically if file content changes.
Image width in pixels, if applicable.
Page title used to override product name in storefronts.
Page keywords used for search engine optimization purposes.
Page description used for search engine optimization purposes.
Options that allow for variations of the base product. If the option is part of a variant or required=true, an option value must be set for the product to be added to a cart.
Unique identifier for the object.
Human-friendly name of the option.
Some brief hint text to help the user understand this option.
Type of user input to display for this option in a storefront. The select type is ideal for dropdown or radio selections, toggle can be used either to show another option or as a price modifier, and text fields can capture user input like a message.
Possible enum values:
Specifies another option ID that affects visibility of this option. The option will only appear when one of the parent_value_ids is selected.
IDs of parent option values that will make the option appear if selected.
Extra price for the option, added to the product's price/sale_price. If the option is part of a variant, the variant's price/sale_price will override this value.
Indicates whether the option requires a value when the product is added to a cart.
Indicates whether the option specifies the billing interval of a subscription plan.
List of possible values for this option.
Unique identifier for the object.
Human-friendly name of the option value.
Name of the product color.
A brief description of the option value, intended for displaying to customers.
Extra price added to the product's price/sale_price if the option value is selected. Overrides option price.
Extra weight added to the product's shipment_weight if the option value is selected. The unit should match the store's default as configured in general settings.
When product type=subscription, this is the billing interval used when this option value is selected. Can be monthly, yearly, weekly, or daily.
Possible enum values:
When product type=subscription, this number multiplies subscription_interval to determine the billing frequency when this option is selected. For example, to make a subscription bill every two weeks, set subscription_interval=weekly and subscription_interval_count=2.
When product type=subscription, refers to a number of days offered as a trial before an invoice is issued.
Image depicting the product.
Unique identifier for the object.
A reference to the raw file data.
Date the file was uploaded.
Size of the file in bytes.
An MD5 hash of the file contents. This can be used to uniquely identify the file for caching purposes.
Optional file name.
MIME content type of the file.
Arbitrary data
Unique identifier for the attribute.
Description for the product options.
Indicates the options are active.
Indicates there are multiple selections for options.
Indicates the option is a variant.
Reflects the non-sale price of the product
List price used when sale=false or sale_price is not defined. This value is intended for use via the frontend. See the purchase_options array to manage a product's price.
Price rules determined by cart quantity or customer account group. Overrides price and sale_price when conditions match.
Price applied when conditions are met.
Customer account group as a condition to apply price.
Maximum quantity as a condition to apply price.
Minimum quantity as a condition to apply price.
Minimum quantity of the product that can be sold at once.
Specifies a quantify multiple the product must be sold in.
Array of related product IDs.
Indicates whether the product is on sale. If true, the sale_price will be used by default when the product is added to a cart.
Sale price used to override list price when sale=true.
Product dimensions when packed for shipping. Typically used by third-party carriers in box packing algorithms to optimize shipping costs.
Length of the product in unit.
Width of the product in unit.
Height of the product in unit.
Either in(inches) or cm(centimeters).
Possible enum values:
ID of location from /settings/shipping/locations. If specified, shipping is calculated from this location. Otherwise, the store's default location will be used.
If specified, shipping is calculated using this as the maximum number of items per package. Otherwise, Swell assumes any quantity fits into a single package.
Product shipping price rules to override default shipping rules.
Shipping service required for this rule to apply.
Customer group required for this rule to apply.
Shipping country required for this rule to apply.
Fixed amount to add when rule is applied. Only applicable when fee_type=fixed.
Percentage of the shipping price to add when rule is applied. Only applicable when fee_type=percent.
Type of fee to apply in addition to price, either fixed or percent.
Possible enum values:
Maximum package quantity when rule is applied.
Shipping price when rule is applied.
Shipping state required for this rule to apply.
Maximum order subtotal for this rule to apply.
Minimum order subtotal for this rule to apply.
Maximum order item weight for this rule to apply.
Minimum order item weight for this rule to apply.
Shipping zip/postal code required for this rule to apply.
If specified, shipping is calculated using this weight. Otherwise, Swell assumes 1 lb/oz/kg—depending on the store's default weight unit.
The default billing interval when this product is used as a subscription plan. Can be monthly, yearly, weekly, or daily.
Possible enum values:
Multiplier when combined with subscription_interval. For example, to make a subscription bill every two weeks, set subscription_interval=weekly and subscription_interval_count=2.
Number of days offered as a free trial before the customer is billed. If a subscription is canceled by the last day of the trial period, an invoice won't be issued.
Stock keeping unit (SKU) used to track inventory in a warehouse.
Lowercase, hyphenated identifier typically used in URLs. When creating a product, a slug will be generated automatically from the name. Maximum length of 1,000 characters.
Expandable list of stock adjustments for the product.
Indicates whether the product can be backordered if out of stock.
Quantity of the product currently in stock (including all variants), based on the sum of the stock entries. Includes positive quantities, excluding variants that have negative stock values.
Quantity of the product in stock across inventory locations, if the product has no variants.
Minimum stock value including all variants. May represent negative variant stock levels.
Sum total of all product stock values.
Stock distributed over inventory locations, if multi-location inventory is enabled.
List of custom inventory locations for this product.
Location identifier.
Location name.
Indicates whether the product can be purchased as a preorder.
Indicates whether the product's stock is purchasable.
String indicating the product's stock status for the purpose of ordering. When stock_purchasable=true, an order can be placed for this product regardless of current stock status. Otherwise an order submission will be blocked unless stock status is available, preorder, or backorder.
Possible enum values:
Indicates whether the product has stock tracking enabled.
A brief product summary.
Array of searchable tags to aid in search discoverability.
Indicates the tax class for the product.
Product tax code for tracking with Avalara, TaxJar, etc.
ID of an alternate theme template used to render this product in a storefront, if applicable.
Implies the ordering and fulfillment options available for the product. Can be standard, subscription, bundle, or giftcard. A standard product is a physical item that will be shipped to a customer.
List of products to display as up-sells on a product detail page.
Unique identifier for the up-sell.
ID of the up-sell product.
Expandable link to the up-sell product.
Indicates whether the product has variant generation enabled.
Expandable list of variants representing unique variations of the product. Each variant is a combination of one or more options. For example, Size and Color.
Indicates whether the product is virtual.
The product model
{
"name": "Iron dagger",
"sku": "00090616",
"active": true,
"purchase_options": {
"standard": {
"active": true,
"price": 10,
"sale_price": null,
"sale": false,
"prices": []
},
"subscription": {
"active": true,
"plans": [
{
"name": "Monthly",
"description": "1 dagger/month",
"price": 9,
"billing_schedule": {
"interval": "monthly",
"interval_count": 1,
"limit": null,
"trial_days": 14
},
"id": "627c6f180d375a001296b593",
"active": true
}
]
}
},
"variable": true,
"description": "<h3>Damage: 7</h3><h3>Weight: 8</h3><h3>Health: 98</h3><h3>Speed: 1.4</h3><h3>Reach: 0.6</h3>",
"tags": [],
"meta_title": null,
"meta_description": null,
"slug": "iron-dagger",
"attributes": {
"blade": "",
"dagger": "",
"type": [
"Fine",
"Rusty"
]
},
"delivery": "shipment",
"bundle": null,
"price": 10,
"stock_tracking": false,
"options": [
{
"id": "627c6e36e80393798c171670",
"values": [
{
"id": "627c6f18e80393798c171673",
"name": "Fine",
"price": null,
"shipment_weight": null,
"description": "A better-than-usual iron dagger"
},
{
"id": "627c6f18e80393798c171674",
"name": "Rusty",
"price": 0,
"shipment_weight": null,
"description": "This dagger's seen better days"
}
],
"name": "Type",
"active": true,
"input_type": "select",
"variant": true,
"description": null,
"required": true,
"attribute_id": "type"
}
],
"currency": "USD",
"sale": false,
"sale_price": null,
"prices": [],
"type": "standard",
"tax_class": "standard",
"date_created": "2022-05-12T02:21:12.534Z",
"stock_status": null,
"date_updated": "2022-05-12T02:37:45.666Z",
"category_index": {
"sort": {
"627c6db5632818001272f8ed": 0,
"627c6dc30d375a001296a8b7": 0
},
"id": [
"627c6db5632818001272f8ed",
"627c6dc30d375a001296a8b7"
]
},
"cross_sells": [],
"up_sells": [
{
"id": "627c7225e80393798c17167b",
"product_id": "627c715e632818001274ebd8"
}
],
"id": "627c6f180d375a001296b580"