A Product represents a product in your Liftoff account.
Note that a Product may have multiple ProductVariants with different SKUOption values.
For example, you may have a Product in your Liftoff account named Gel-Ink Pen. That Product may have multiple ProductVariants with different values for a SKUOption named Color.
Properties
| Name | Type | Description |
|---|---|---|
| Id | int | The ID of the product. |
| AccountId | int | The ID of the Liftoff account that the product belongs to. (Note: This account ID will always correspond to the account code you use in your authentication credentials.) |
| Account (via $expand) | Account | The Liftoff account that the product belongs to. |
| Type | ProductType | The type of product. Valid values are Product (for standard products) and Bundle (for bundles of products). |
| Code | string | The code for the product. Maximum length is 35 characters. Codes may contain letters, numbers, and hyphens. |
| Name | string | The name of the product. Displayed in product listings and search results. |
| Description | string | A brief description of the product. Displayed in product listings and search results. |
| IsPublished | boolean | Flag that indicates whether the product is active in your Liftoff account. |
| DefaultFulfillmentWorkflowId | int | The ID of the default fulfillment workflow for the product. |
| DefaultFulfillmentWorkflow | FulfillmentWorkflow | The default fulfillment workflow for the product. |
| UrlPath | string | The URL path for the product's landing page. The URL path does not include https://, your domain name, or a leading slash. |
| Title | string | The title of the product's landing page. |
| PageText | string | The HTML that appears in the content area of your product's landing page. |
| SearchTerms | string | Comma-delimited list of search terms for the product. Must contain only letters, numbers, hyphens, and spaces. These terms are used by your Liftoff site's search feature. They do not impact searches conducted by external search engines such as Google. |
| MetaDescription | string | Content for the product landing page's meta description tag. This is an optional value for SEO purposes. Maximum length is 250 characters, but most search engines truncate this value to 150-160 characters. |
| MetaKeywords | string | Content for the product landing page's meta keywords tag. This is an optional value for SEO purposes. Place a comma between each keyword. |
| TrackInventory | boolean | Flag that indicates whether to enable inventory tracking for the product's SKUs. |
| DisplayStockLevel | boolean | Flag that indicates whether to display the current stock level to users. Not applicable if trackInventory is false. |
| AllowOutOfStockOrders | boolean | Flag that indicates whether to allow ordering if the stock level is 0. Not applicable if trackInventory is false. |
| AggregateLowStockNotices | boolean | Flag that indicates whether to aggregate low stock notices into a single email for all affected variants of the product. Not applicable if trackInventory is false. |
| RequireBudget | boolean | Flag that indicates whether a budget or gift card is required to order this product. |
| ProductSelectionType | ProductSelectionType | Valid values are Standard and Cascade. If the product has multiple SKUs, the product selection type specifies whether to present all option dropdowns to the user at once (Standard), or to step the user through selecting one option at a time (Cascade). |
| TaxCode | string | The code for the product's tax category. |
| ProductClassification | string | The product classification that the product belongs to. |
| SKUOptions (via $expand) | SKUOption array | The collection of SKU options for the product. |
| ConfigurationOptions (via $expand) | ConfigurationOption array | The collection of configuration options for the product. |