# Introduction

Point multiplier allows to multiply number of points received by member when specific conditions are met. 
If more then one multiplier could be applied the highest multiplier is used. For every rule you need to define separate multiplier.
Point multiplier works only in chosen rule context and rule must be of rewards type.

## Point Multiplier model

Standard Point Multiplier JSON model returned from many API endpoints.

### Example

```json
{
  "id": 5,
  "multiplier": 1.25,
  "schedule_type": "daily",
  "start_date": "2020-01-01",
  "end_date": "2020-01-31",
  "weekdays": [],
  "store_ids": [],
  "created_at": "2019-02-26T13:22:43.495Z",
  "updated_at": "2019-02-28T15:29:24.156Z"
}
```

## Definition

Key | Description                                                                    | Type
--------- |--------------------------------------------------------------------------------| ---------
id        | Point Multiplier ID                                                            | integer
multiplier |  multiplier of reward points                                                  | decimal
schedule_type | Schedule type                                                              | string
start_date    | Schedule start date                                                        | date
end_date  | Schedule end date                                                              | date
weekdays  | Selected weekdays of schedule                                                  | array
store_ids | Store ids                                                                      | array
created_at | Time of point multiplier creation                                                         | Date
updated_at | Time of last point multiplier update                                                      | Date

## Cases and Example

### Case 1

Payload example:

```json
{
  "multiplier": 2,
  "schedule_type": "daily",
  "start_date": "2022-06-10",
  "end_date": "2022-06-10"
}
```

During a specified date range, points can be multiplied by any number 

Example: For receipt scan event: 2x points for all stores on 6/10/2022.

### Case 2

Payload example:

```json
{
  "multiplier": 3,
  "schedule_type": "daily",
  "start_date": "2022-06-10",
  "end_date": "2022-06-20",
  "store_ids": [1034, 1446, 1417]
}
```

During a specified date range, when events happens in specific shops points can be multiplied by any number 

Example:  For receipt scen event: 3x points for store_ids (1034, 1446, 1417) from 6/10/2022 - 6/20/2022 

### Case 3

Payload example:

```json
{
  "multiplier": 5,
  "schedule_type": "monthly",
  "start_date": "2022-06-01",
  "end_date": "2022-06-30",
  "weekdays": [1, 4]
}
```

During a specified date range, points can be multiplied by any number or specific days of the week 

Example: For receipt scen event: 5x points on every Monday and Thursday from 6/1/2022 - 6/30/2022.