# 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

![](https://3079805559-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LZA-vUHasjE__5Y0ghc%2F-M3usSy3pTiJJHpbWu89%2F-M3usWqb-Mo8xWptoODv%2Fimage.png?alt=media\&token=13b3cf5d-1a6d-4241-b399-bf3bfd2c43d8)

### Product Properties

{% tabs %}
{% tab title="Attributes" %}

| 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](https://docs.simplestore.io/getting-started/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        | <p>Dictionary (key, value) of alternate Titles other languages to support internationalisation (i18n) and localisation (l10n):</p><ul><li>Key = ja-JP</li><li>Value = \<Title in Japanese></li></ul>                                                                                                                                                                  |
| descriptions  | <p>Dictionary (key, value) of alternate Descriptions other languages to support internationalisation (i18n) and localisation (l10n), for example:</p><ul><li>Key = ja-JP</li><li>Value = \<Description in Japanese></li></ul>                                                                                                                                         |
| isActive      | Active (True) or InActive (False)                                                                                                                                                                                                                                                                                                                                     |
| status        | <p>Available = Product is Available</p><p>Out Of Stock = Product is Out of Stock</p><p>Discontinued = Product has been discontinued</p><p>Unavailable = Product is unavailable</p>                                                                                                                                                                                    |
| 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](https://docs.simplestore.io/concepts/categories))                                                                                                                                                                                                                                                 |
| collections   | One or many collections the Product is assigned to (see [Collections](https://docs.simplestore.io/concepts/collections))                                                                                                                                                                                                                                              |
| files\[]      | One or many assets associated with the Product (see [Assets](https://docs.simplestore.io/concepts/assets))                                                                                                                                                                                                                                                            |
| paymentMethod | <p>Defines the supported payment methods for a product:</p><p>CurrencyOnly = Can be paid with by currency ONLY, not eligible to be paid for with points</p><p>RewardsOrCurrency = Can be paid with currency or rewards points in full</p><p>RewardsOnly = Can be paid in rewards points ONLY</p><p>RewardsPlusPay = Can be paid with a mix of currency and points</p> |
| basePrice     | See [Pricing](https://docs.simplestore.io/concepts/pricing)                                                                                                                                                                                                                                                                                                           |
| price         | See [Pricing](https://docs.simplestore.io/concepts/pricing)                                                                                                                                                                                                                                                                                                           |
| baseRewards   | See [Rewards ](https://docs.simplestore.io/concepts/rewards)                                                                                                                                                                                                                                                                                                          |
| rewards       | See [Rewards ](https://docs.simplestore.io/concepts/rewards)                                                                                                                                                                                                                                                                                                          |
| inventory     | See [Inventory](https://docs.simplestore.io/concepts/inventory)                                                                                                                                                                                                                                                                                                       |
| {% endtab %}  |                                                                                                                                                                                                                                                                                                                                                                       |

{% tab title="Sample Object" %}

```
{
  "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"	{}
}
```

{% endtab %}
{% endtabs %}

####
