> For the complete documentation index, see [llms.txt](https://docs.omnichat.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.omnichat.ai/en/features/coupons-add-on-module.md).

# Coupons (Add-On Module)

You can customise the coupon layout and deliver the coupons in different situations by different messaging channels through Omnichat

{% hint style="info" %}
Available for: WhatsApp, Facebook, Instagram and LINE
{% endhint %}

Follow the steps to design your unique coupon.

## Setting of Coupon

### Step 1

Create a Coupon

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FnstpQB1ligxr5LCd1GDZ%2F%E6%88%AA%E5%9C%96%202023-03-08%20%E4%B8%8B%E5%8D%886.31.49.png?alt=media&amp;token=eb62ca23-d31b-4bd3-9e5c-667e2c4e658d" alt=""><figcaption></figcaption></figure>

### Step 2

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FvcCJfZzbvWsz8NuOAIHf%2F%E5%84%AA%E6%83%A0%E5%88%B8.png?alt=media&amp;token=98f12c42-2ec2-4ab4-9313-8b6d70f8a22a" alt=""><figcaption></figcaption></figure>

1. **Coupon Name** : You can set the coupon name
2. **Coupon Type** : You can choose "Marketing" or "Customer Service", if you have purchased OMO features there are 3 types of coupons: "Marketing" , "Customer Service" and "Sales"

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FErJqpB3Jv3iJQX36zQ72%2F%E6%88%AA%E5%9C%96%202023-03-10%20%E4%B8%8B%E5%8D%884.42.37.png?alt=media&amp;token=1fb4c316-10b6-43e1-84cc-174e5e94caed" alt=""><figcaption><p>General Plan</p></figcaption></figure>

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FWqGdXSLZtqK8DdmkF3S2%2FOMO.png?alt=media&amp;token=bc5ac7c8-cda4-4288-becc-cfb635b6035a" alt=""><figcaption><p>OMO Features</p></figcaption></figure>

* Administrator, Manager, Customer Service Manager can send "Customer Service" type coupon on conversation page
* Select the type of "Customer Service" , you can send out coupons to customers on "Conversation" page (per below screencap)

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FjXIQjXAyuarsPUvkAWNP%2F%E6%88%AA%E5%9C%96%202023-03-10%20%E4%B8%8B%E5%8D%885.48.31.png?alt=media&amp;token=a47f9250-db52-45d2-88d1-03443738045d" alt=""><figcaption><p>Send the "Customer Service" type coupon on conversation page</p></figcaption></figure>

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2Ft81U2KzOVkAnyH586ZtW%2F%E6%88%AA%E5%9C%96%202023-03-10%20%E4%B8%8B%E5%8D%885.55.53.png?alt=media&amp;token=1adaddbb-b3a0-4b8a-a4c3-b16d1e2365fa" alt=""><figcaption><p>set the limit of Per staff</p></figcaption></figure>

#### If you have purchased the OMO feature, there are three types of coupons: Sales, Marketing and Customer service

* For OMO features, the type of Sales coupon, you can select the applicable branch
* The "Sending limit per person" means the maximum number of the coupon that **each salesperson** can send

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FK1yPyhGPgdG3sFaGfqMO%2F%E6%88%AA%E5%9C%96%202023-03-10%20%E4%B8%8B%E5%8D%886.15.51.png?alt=media&amp;token=44709cb8-d73b-4bd7-a6bc-57b6f74d2989" alt=""><figcaption><p>Select the applicable branch</p></figcaption></figure>

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FNgBY9RjmlPlgQI6iinlz%2F%E6%88%AA%E5%9C%96%202023-03-10%20%E4%B8%8B%E5%8D%886.16.42.png?alt=media&amp;token=f03154bc-c029-4da2-bcba-558887fbb5c5" alt=""><figcaption><p>Set the limit for per staff</p></figcaption></figure>

* If the total number of the coupon is 0 or the salesperson cannot send to the same person repeatedly, the coupon option will be shown in grey colour as an indication
* The remaining coupon means the number of coupons that the salesperson can still send out (under the "Sending limit per person")

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FvKrVj5NaWbDiC46OgYrs%2F%E6%88%AA%E5%9C%96%202023-03-10%20%E4%B8%8B%E5%8D%886.49.49.png?alt=media&amp;token=fef535e7-fe1e-4102-af01-085d04322dbe" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
"Sales" type coupons can only be sent by the **Salesperson** or **Sales Manager** on "Conversation" page
{% endhint %}

3. **Sending period**: You can choose when the coupon will be sent out
4. **Collection period**:

* Custom Time: The coupon can only be used from start time to end time
* The expiry time calculated from the received time: The expiry time will calculate from the customer received the coupon

5. **Rules**: You can set the rules of the coupon. Total characters cannot exceed 1000
6. **Coupon Code**: You can set the coupon code

* Fix Code: You can customise the coupon code
* Codes: You can set the code and the quantity

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FDLjSvrLVau0uYntyfB9V%2F%E6%88%AA%E5%9C%96%202023-03-13%20%E4%B8%8B%E5%8D%885.08.22.png?alt=media&amp;token=267396fb-5c42-457f-95e8-7f38c910200d" alt=""><figcaption></figcaption></figure>

**If you choose to Upload code**<br>

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FWCKsabczgAtTNj7DUljt%2F%E6%88%AA%E5%9C%96%202023-03-13%20%E4%B8%8B%E5%8D%885.20.41.png?alt=media&amp;token=87ff94c4-4b38-426b-a7c9-e0fc8caceec3" alt=""><figcaption></figcaption></figure>

1. Normal code: If the coupon code is generated by the E-shop platform, you can download the "Example file" and paste the coupon code into the file, then click "Upload" to select the file
2. Support LINE POINTS code
3. Click the button to download the Example file
4. Upload code: You can upload the code file

{% hint style="danger" %}
Note: When the coupon type is set to “Batch Serial Numbers,” the system does not support using it in conjunction with the broadcast (push notification) feature.
{% endhint %}

### Step 3

Barcode

**If you need to show the barcode, QR Code, CODE\_39, CODE\_128 and EAN\_13 are currently supported**

{% hint style="info" %}
Note: that the **EAN\_13** barcode format only supports **12 numeric digits**.

If the value contains any non-numeric characters or exceeds **12 digits**, the barcode generation will fail.
{% endhint %}

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FcsxZCpk3njvmHDZWf6mQ%2F%E6%88%AA%E5%9C%96%202023-03-13%20%E4%B8%8B%E5%8D%885.30.16.png?alt=media&amp;token=b0a70237-6999-42e5-8ba8-f9d070694030" alt=""><figcaption></figcaption></figure>

#### If you choose not to show the Barcode, you can set the button to link to the specific URL, such as the official website/ the promotional product URL

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FuxINC8VgLNppnFQfEABz%2F%E6%88%AA%E5%9C%96%202023-03-13%20%E4%B8%8B%E5%8D%885.42.02.png?alt=media&amp;token=18aa2061-d565-4cb4-8ec6-0c5980d86b1b" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Customer slick "Copy", the pop up window will show up and copy the code at the same time
{% endhint %}

1. Background Colour
2. Coupon Image: No limit on file size
3. Coupon Border Colour
4. Button Background Colour / Button Text Colour
5. Whether to show the barcode: If yes, we support the barcode format: CODE\_39 and CODE\_128
6. The Rules of the Coupon
7. Received Rule Setting

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2Fa2RJBKXOAQLpEBnSMSzE%2F%E6%88%AA%E5%9C%96%202023-03-13%20%E4%B8%8B%E5%8D%886.02.32.png?alt=media&amp;token=d62efbc4-9ded-4787-ac7c-7c163ce8fb55" alt=""><figcaption></figcaption></figure>

#### If you open the redemption verification code setting, you can set "Generic Verification Code" or "Multiple Sets Of Verification Codes"

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FLomKvi2pFIeuNMI33YUL%2F%E6%88%AA%E5%9C%96%202023-03-14%20%E4%B8%8B%E5%8D%882.29.27.png?alt=media&amp;token=76baea22-8171-499a-b8da-377ae162afa3" alt=""><figcaption></figcaption></figure>

### Step 4

Repeated redemption times

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FeVy2UXujUHt96IROWfET%2F%E6%88%AA%E5%9C%96%202023-07-05%20%E4%B8%8B%E5%8D%883.08.22.png?alt=media&amp;token=df0dbbee-cac1-4196-9d39-2de73f1a4631" alt=""><figcaption></figcaption></figure>

* When you choose unlimited, it means each customer has the opportunity to receive the coupon repeatedly
* When you set the times of each customer can receive, when they has reached the limit, the reminder message will show up
* You can add customer name in reminder message

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FAk8BOsJStQXno4O2z8Af%2F%E6%88%AA%E5%9C%96%202023-03-14%20%E4%B8%8B%E5%8D%883.01.29.png?alt=media&amp;token=090c3b83-56e2-4352-a561-9c9fee65484c" alt=""><figcaption><p>Marketing type coupon</p></figcaption></figure>

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FP3L9eXECwcyMQNujg6MW%2F%E6%88%AA%E5%9C%96%202023-03-14%20%E4%B8%8B%E5%8D%885.33.22.png?alt=media&amp;token=852ddac7-32c8-432d-87f7-95c5b429e6bd" alt=""><figcaption><p>Sales type coupon (OMO feature)</p></figcaption></figure>

### Step 5

Layout of coupon

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FkNOvvwapJlglno3ZcTN6%2F%E5%9C%96%E7%89%87%201.png?alt=media&amp;token=3cc7c69c-9629-4080-9fee-6f7abca0d693" alt=""><figcaption></figcaption></figure>

1. Background Color
2. Border Color
3. Button Background Color
4. Button Text Color
5. Brand image (Optional): The recommended ratio is 1:1, and the default picture is the team head. If you want to re-upload or delete the picture after uploading, you can move the mouse cursor over the picture
6. Coupon image (Optional): There is no size limit but image width is recommended to be at least 660 pixel

### Step 6

Click "Save" after completing the setting and click "OK", the coupon will proceed to "Draft". You can test the "Drafted" coupon and click "Publish" to activate the coupon after testing

{% hint style="info" %}

1. The "Drafted" Coupon cannot edit the coupon code
2. You can test the "Draft" Coupon, but the testing record will be cleared after published. So, remember to click "Publish" when you are ready to launch
   {% endhint %}

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FeecW41zg6POh2nuNsIIm%2F%E6%88%AA%E5%9C%96%202023-03-14%20%E4%B8%8A%E5%8D%8811.07.26.png?alt=media&amp;token=12b38d9f-6703-4788-b0e0-421c63468488" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
After publishing the coupon, click "edit" to edit the coupon
{% endhint %}

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FOx8U7YQa4XLDsv5odRUJ%2F%E6%88%AA%E5%9C%96%202023-03-23%20%E4%B8%8B%E5%8D%8812.02.52%202.png?alt=media&amp;token=0a6135b4-a8dc-4a32-b70b-4c6c1e5c5ed7" alt=""><figcaption></figcaption></figure>

## Set the bot for the Coupon Module

{% hint style="info" %}

1. The coupon will not be sent if it does not match the scheduled time (not ready / overdue) or there are no more coupon quotas.
2. If the bot has other blocks, other blocks will be sent normally, but the coupon block will not.
3. The bot should include the coupon module which must be used on a single channel only
   {% endhint %}

Path: "Advanced Automation" -> "Bot Builder" -> Select "Coupon"

Select the Coupon on the Coupon block.

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2Fk8n9b8TPDVZngnlos0DT%2F%E6%88%AA%E5%9C%96%202023-03-14%20%E4%B8%8B%E5%8D%8812.08.26.png?alt=media&amp;token=9d932845-377f-4cd3-a74c-633b599b7ff1" alt=""><figcaption></figcaption></figure>

## The Coupon Code Record

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2FETGUkM2hY9kKQkQ6S5VN%2F%E6%88%AA%E5%9C%96%202023-03-23%20%E4%B8%8B%E5%8D%8812.04.36.png?alt=media&amp;token=e1e195f6-ad93-4f69-88b2-0d20bb0256d1" alt=""><figcaption></figcaption></figure>

1. Search: You can search for the coupon created before
2. Received: You can check how many coupons have been sent so far
3. Opened: You can check how many customers have opened the coupon so far
4. Rows per page: You can choose 5, 10, 15 or all
5. Duplicate: Except the coupon code will not be copied, the rest of the content will be copied. Coupons in all status can be copied
6. Coupon Code Record: You can click the "Coupon code record" button to view the performance

<figure><img src="https://2848678129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3u2I1osIy6mEi07X1z46%2Fuploads%2F8L5aYsXVpLiIMnvuP7Yt%2F%E6%88%AA%E5%9C%96%202023-03-14%20%E4%B8%8B%E5%8D%881.58.09.png?alt=media&amp;token=51573010-735b-4347-bb2c-2b322e99dc2a" alt=""><figcaption></figcaption></figure>

1. Search: You can search by guest name
2. Export coupon collection list: The list can be exported as CSV file, and imported into the "Audience & Broadcast" to push directly to the group of customers
3. Received Time: The time when the system sends the coupon to the consumer
4. Opened Time: The time when the customers open the coupon
5. Redeemed Time: If you choose to show the Barcode, the time when customers press the "Redeem button". (Please refer to your POS machine for the actual redeemed time
6. Triggered method: Which Omnichat features is used to trigger this coupon
7. Name of Verification Code: If you have set the consumer to redeem the coupon, the salesperson clicks the "Redeem button" and needs to enter this "Verification Code"
8. Rows per page: You can choose 5, 10 or 15
