Product

Search…
Product
A Product represents something that can be purchased within the the Simple Store platform.
The Product object comprises both a standard set of default fields along with a flexible model to extend the product to meet your customisation needs.
The Product can be associated with Categories, Collection, Assets and Attributes.
Portal View
Product Properties
Attributes
Sample Object
Element
Description
productId
Unique Identifer for the Product
slug
A Url slug used to identify a product
shortUrl
A globally unique id identifier (see QuickBuy)
version
An incremental version number tracking changes to the Product configuration
title
Default Title for the Product
description
Default Description for the Product
titles
Dictionary (key, value) of alternate Titles other languages to support internationalisation (i18n) and localisation (l10n):
Key = ja-JP
Value = <Title in Japanese>
descriptions
Dictionary (key, value) of alternate Descriptions other languages to support internationalisation (i18n) and localisation (l10n), for example:
Key = ja-JP
Value = <Description in Japanese>
isActive
Active (True) or InActive (False)
status
Available = Product is Available
Out Of Stock = Product is Out of Stock
Discontinued = Product has been discontinued
Unavailable = Product is unavailable
attributes
Attributes are a list of Key/Value to support customisation of a product
categories
One or many categories the Product is assigned to (see Categories)
collections
One or many collections the Product is assigned to (see Collections)
files[]
One or many assets associated with the Product (see Assets)
paymentMethod
Defines the supported payment methods for a product:
CurrencyOnly = Can be paid with by currency ONLY, not eligible to be paid for with points
RewardsOrCurrency = Can be paid with currency or rewards points in full
RewardsOnly = Can be paid in rewards points ONLY
RewardsPlusPay = Can be paid with a mix of currency and points
basePrice
See Pricing​
price
See Pricing​
baseRewards
See Rewards ​
rewards
See Rewards ​
inventory
See Inventory​
{
  "productId": "string",
  "slug": "string",
  "shortUrl": "string",
  "version": "string",
  "title": "string",
  "description": "string",
  "titles": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "descriptions": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "isActive": true,
  "status": "Available",
  "attributes": {},
  "categories": [
    {
      "key": "string",
      "value": "string",
      "slug": "string"
    }
  ],
  "collections": [
    {
      "key": "string",
      "value": "string",
      "slug": "string"
    }
  ],
  "files": [
    {
      "fileId": "string",
      "contentType": "string",
      "accessPermission": "string",
      "accessUrl": "string",
      "attributes": {},
      "edgeUrl": "string"
    }
  ],
  "paymentMethod": "CurrencyOnly",
  "basePrice"	{}
  "price"	{}
  "baseRewards"	{}
  "rewards"	{}
  "inventory"	{}
}
​
Concepts - Previous
Pricing
Next - Concepts
Rewards
Last modified 2yr ago
Copy link
Outline
Portal View
Product Properties
Portal View

Product Properties

​
