# Specials

Specials define rule based price modifiers to support discounting of products.

Specials can be either a **percentage** or a **fixed** amount.

Specials apply for a specified date range

Specials can be applied to:

* **Products** - specific products
* **Categories** - all Products assigned to a category
* **Collections** - all Products assigned to a collection

### Portal View

#### View Specials

Assess the **Special** screen in the console via the console navigation bar.

![](https://3079805559-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LZA-vUHasjE__5Y0ghc%2F-M4EBa_xNL5N8sOEBs_l%2F-M4JGP-1ix5ImXSeuVhm%2Fimage.png?alt=media\&token=2f993efe-c096-484e-9d80-a6a6f2be222e)

#### Add New Special

Click **Add New** to create a new special

![](https://3079805559-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LZA-vUHasjE__5Y0ghc%2F-M4EBa_xNL5N8sOEBs_l%2F-M4JHGF1n9cBp5BOtmdd%2Fimage.png?alt=media\&token=b41a6ed3-6b6f-49ca-a29b-2032b25d88ba)

Specified a:

* Name
* Description
* Special Type: Percentage or Fixed Amount
* Amount (based on Special Type)
* Date Range (from and to)

Click **Submit** to create the new special.

![](https://3079805559-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LZA-vUHasjE__5Y0ghc%2F-M4EBa_xNL5N8sOEBs_l%2F-M4JHAUMUcxNxdB2lYYT%2Fimage.png?alt=media\&token=e1c6a04a-36ec-4ea2-9ff6-eb8eb6925906)

#### Edit Special 

Additional **Details** are specified including the definition of Rules that determined which products specials apply to.  Specials can apply to specific products or all products assigned to specifed Categories or Collections.

![](https://3079805559-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LZA-vUHasjE__5Y0ghc%2F-M4EBa_xNL5N8sOEBs_l%2F-M4JHt5cY8wILcuwDQ9Q%2Fimage.png?alt=media\&token=eb4b1f7c-75fc-4d9d-a122-da0e96494e25)

Click **Save** to commit your modifications.

#### Specials Properties

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

| Element      | Description                                                                                                                                                                          |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| specialId    | Internal Identifier for the special                                                                                                                                                  |
| name         | Name for the special                                                                                                                                                                 |
| description  | Description for the special                                                                                                                                                          |
| specialType  | Percentage or Fixed Amount                                                                                                                                                           |
| amount       | Amount of special, unit based on Special Type                                                                                                                                        |
| startDate    | Start date for the special                                                                                                                                                           |
| endDate      | End date for the special                                                                                                                                                             |
| attributes   | One or more key/value pairs to support customisation of specials                                                                                                                     |
| **Rules**    |                                                                                                                                                                                      |
| categories   | Categories that the special applies to (see [Categories](https://docs.simplestore.io/concepts/categories)), if a Product is assigned to these categories then the special is applied |
| collections  | Collections that the special applies to (see [Specials](https://docs.simplestore.io/concepts/specials)), if a Product is assigned to these collections then the special is applied   |
| products     | Products that the special applies to                                                                                                                                                 |
| {% endtab %} |                                                                                                                                                                                      |

{% tab title="Sample Object" %}

```
{
    "specialId":	string
     "version	string
    "nullable: true
    "name	string
    "nullable: true
    "description	string
    nullable: true
    isActive	boolean
    startOnUtc	string($date-time)
    endOnUtc	string($date-time)
    nullable: true
    specialType	SpecialTypestring
    Enum:
    Array [ 2 ]
    amount	number($decimal)
    rules	[...]
    attributes	{...}
}
```

{% endtab %}
{% endtabs %}