OMSKhuyến mãi
Promotion Object Schema
Đối tượng đại diện cho thông tin chương trình khuyến mãi
JSON Schema
| Trường (Field) | Kiểu (Type) | Mô tả (Description) |
|---|---|---|
id | int | ID chương trình khuyến mãi |
company_id | int | ID công ty (tenant) |
creator_id | int | ID người tạo |
group | int | Nhóm khuyến mãi (xem bảng mã bên dưới) |
type | int | Loại khuyến mãi (xem bảng mã bên dưới) |
scope_class | int | Phạm vi áp dụng (xem bảng mã bên dưới) |
code | string | Mã chương trình khuyến mãi |
name | string | Tên chương trình |
title | string | Tiêu đề hiển thị |
title_short | string | Tiêu đề ngắn |
description | string | Mô tả chi tiết |
status | int | Trạng thái (xem bảng mã bên dưới) |
avatar_file_id_list | array | Danh sách ID ảnh đại diện |
avatar_file_list | array | Danh sách đối tượng File ảnh đại diện |
photo_gallery_file_id_list | array | Danh sách ID ảnh thư viện |
photo_gallery_file_list | array | Danh sách đối tượng File ảnh thư viện |
store_scope | int | Phạm vi cửa hàng (1: Tất cả, 3: Chỉ định) |
store_id_list | array | Danh sách ID cửa hàng áp dụng |
customer_scope | int | Phạm vi khách hàng (1: Tất cả, 3: Chỉ định) |
value_type | int | Loại giá trị giảm (xem bảng mã bên dưới) |
value | mixed | Giá trị giảm (số hoặc JSON tùy value_type) |
bundle_discount_options | array | Cấu hình giảm giá bundle |
min_amount | int | Giá trị đơn hàng tối thiểu (VNĐ) |
max_amount | int | Giá trị giảm tối đa (VNĐ) |
min_quantity | int | Số lượng sản phẩm tối thiểu |
max_quantity | int | Số lượng sản phẩm tối đa |
min_detail_line | int | Số dòng chi tiết đơn hàng tối thiểu |
allow_payment_method_list | array | Danh sách phương thức thanh toán cho phép |
allow_order_source_list | array | Danh sách nguồn đơn hàng cho phép |
allow_shipping_type_list | array | Danh sách loại vận chuyển cho phép |
allow_shipping_region_id_list | array | Danh sách ID khu vực giao hàng cho phép |
allow_weekday_list | array | Danh sách ngày trong tuần cho phép |
blackout_data | array | Các giai đoạn không áp dụng (blackout) |
date_started | int | Thời gian bắt đầu hiệu lực (UNIX timestamp) |
date_ended | int | Thời gian kết thúc hiệu lực (UNIX timestamp) |
time_start | int | Giờ bắt đầu trong ngày (giây từ 00:00) |
time_end | int | Giờ kết thúc trong ngày (giây từ 00:00) |
date_created | int | Thời gian tạo (UNIX timestamp) |
date_modified | int | Thời gian cập nhật (UNIX timestamp) |
priority | int | Mức ưu tiên (số càng lớn càng ưu tiên) |
stacking_mode | int | Chế độ cộng dồn (xem bảng mã bên dưới) |
mutex_set | string | Nhóm mutex (các KM cùng mutex_set sẽ loại trừ nhau) |
limit_global_count | int | Giới hạn tổng lượt sử dụng (0 = không giới hạn) |
limit_per_customer_count | int | Giới hạn lượt sử dụng mỗi khách hàng (0 = không giới hạn) |
limit_per_day_count | int | Giới hạn lượt sử dụng mỗi ngày (0 = không giới hạn) |
redeem_type | int | Cách đổi thưởng (xem bảng mã bên dưới) |
pass_code | string | Mã xác nhận (khi redeem_type = 3) |
gift_mode | int | Chế độ tặng quà (xem bảng mã bên dưới) |
gift_trigger_block_quantity | int | Số lượng trigger block |
gift_pick_quantity | int | Số lượng quà được chọn |
gift_max_quantity | int | Số lượng quà tối đa |
gift_duplicate_policy | int | Chính sách trùng lặp quà (xem bảng mã bên dưới) |
ad_network | int | Mạng quảng cáo (xem bảng mã bên dưới) |
ad_network_other_name | string | Tên mạng QC khác (khi ad_network = Other) |
ad_campaign_id | string | ID chiến dịch QC |
ad_set_id | string | ID ad set |
ad_creative_id | string | ID ad creative |
ad_campaign_code | string | Mã chiến dịch QC |
show_on_promotion_page | int | Hiển thị trên trang khuyến mãi (1: Có, 0: Không) |
show_on_bundle_page | int | Hiển thị trên trang bundle (1: Có, 0: Không) |
seo_url | string | URL SEO |
seo_title | string | Tiêu đề SEO |
seo_meta_description | string | Mô tả Meta SEO |
seo_meta_keyword | string | Từ khóa SEO |
seo_graph_file_id | int | ID file ảnh Open Graph |
seo_canonical | string | Canonical URL |
seo_options | mixed | Tùy chọn SEO nâng cao |
is_registered | int | Đã đăng ký CTKMM (1: Có, 0: Không) |
registration_date | int | Ngày đăng ký (UNIX timestamp) |
registration_code | string | Mã số đăng ký |
registration_note | string | Ghi chú đăng ký |
registration_file_id_list | array | Danh sách ID file đăng ký |
registration_file_list | array | Danh sách đối tượng File đăng ký |
tags | array | Thẻ (Tags) |
Các bảng mã giá trị (Enums)
Nhóm khuyến mãi (Group)
| Giá trị | Key | Mô tả |
|---|---|---|
| 1 | GROUP_SHIPPING | Khuyến mãi vận chuyển |
| 3 | GROUP_SEASONAL | Khuyến mãi theo mùa |
| 5 | GROUP_LOYALTY | Chương trình khách hàng thân thiết |
| 7 | GROUP_BUNDLE | Combo / Bundle |
Loại khuyến mãi (Type)
| Giá trị | Key | Mô tả |
|---|---|---|
| 100 | TYPE_SHIPPING_DISCOUNT | Giảm phí vận chuyển |
| 101 | TYPE_SEASONAL_ORDER_DISCOUNT | Giảm giá đơn hàng theo mùa |
| 103 | TYPE_SEASONAL_PRODUCT_DISCOUNT | Giảm giá sản phẩm theo mùa |
| 105 | TYPE_SEASONAL_PRODUCT_GIFT | Tặng sản phẩm theo mùa |
| 109 | TYPE_SEASONAL_ORDER_GIFT | Tặng quà theo đơn hàng |
| 305 | TYPE_LOYALTY_COUPON | Coupon khách hàng thân thiết |
| 703 | TYPE_BUNDLE_VOLUME_DISCOUNT | Giảm giá theo số lượng |
| 705 | TYPE_BUNDLE_BOUGHT_TOGETHER | Mua kèm |
| 707 | TYPE_BUNDLE_PRODUCT_MIX_MATCH | Combo sản phẩm |
| 709 | TYPE_BUNDLE_COLLECTION_MIX_MATCH | Combo theo bộ sưu tập |
Phạm vi áp dụng (Scope Class)
| Giá trị | Key | Mô tả |
|---|---|---|
| 1 | SCOPE_CLASS_PRODUCT | Áp dụng theo sản phẩm |
| 3 | SCOPE_CLASS_CART | Áp dụng theo giỏ hàng |
| 5 | SCOPE_CLASS_SHIPPING | Áp dụng theo phí vận chuyển |
| 7 | SCOPE_CLASS_BUNDLE | Áp dụng theo combo/bundle |
Trạng thái (Status)
| Giá trị | Key | Mô tả |
|---|---|---|
| 1 | STATUS_PENDING | Chờ kích hoạt |
| 3 | STATUS_RUNNING | Đang chạy |
| 5 | STATUS_PAUSED | Tạm dừng |
| 7 | STATUS_ENDED | Đã kết thúc |
| 9 | STATUS_REMOVED | Đã xóa |
Loại giá trị giảm (Value Type)
| Giá trị | Key | Mô tả |
|---|---|---|
| 1 | VALUETYPE_PERCENT | Giảm theo phần trăm (%) |
| 3 | VALUETYPE_CURRENCY | Giảm theo số tiền cố định (VNĐ) |
| 5 | VALUETYPE_RANGE | Giảm theo bậc thang (range) |
| 7 | VALUETYPE_FIXPRICE | Giá cố định |
| 9 | VALUETYPE_GIFT | Tặng quà |
| 11 | VALUETYPE_BUNDLE_CURRENCY | Giảm tiền bundle |
| 13 | VALUETYPE_BUNDLE_FIXPRICE | Giá cố định bundle |
Chế độ cộng dồn (Stacking Mode)
| Giá trị | Key | Mô tả |
|---|---|---|
| 1 | STACKING_MODE_STACKABLE | Cho phép cộng dồn với KM khác |
| 3 | STACKING_MODE_EXCLUSIVE | Độc quyền, không cộng dồn |
| 5 | STACKING_MODE_GROUP_EXCLUSIVE | Độc quyền trong cùng nhóm |
Cách đổi thưởng (Redeem Type)
| Giá trị | Key | Mô tả |
|---|---|---|
| 1 | REDEEM_TYPE_AUTO | Tự động áp dụng |
| 3 | REDEEM_TYPE_REQUIRE_CODE | Yêu cầu nhập mã (pass_code) |
Chế độ tặng quà (Gift Mode)
| Giá trị | Key | Mô tả |
|---|---|---|
| 1 | GIFT_MODE_ORDER_PICK_ONE | Quà theo đơn: chọn 1 quà |
| 3 | GIFT_MODE_ORDER_PICK_SOME | Quà theo đơn: chọn một số quà |
| 7 | GIFT_MODE_ORDER_PICK_ALL | Quà theo đơn: tặng tất cả quà |
| 11 | GIFT_MODE_PRODUCT_SAME_POOL | Quà theo sản phẩm: tặng từ cùng nhóm sản phẩm mua |
| 13 | GIFT_MODE_PRODUCT_SECONDARY_POOL | Quà theo sản phẩm: tặng từ nhóm sản phẩm quà riêng |
Chính sách trùng lặp quà (Gift Duplicate Policy)
| Giá trị | Key | Mô tả |
|---|---|---|
| 1 | GIFT_DUPLICATE_POLICY_ALLOW | Cho phép chọn trùng quà |
| 3 | GIFT_DUPLICATE_POLICY_DISTINT | Mỗi quà chỉ được chọn một lần |
Mạng quảng cáo (Ad Network)
| Giá trị | Key | Mô tả |
|---|---|---|
| 1 | ADNETWORK_FACEBOOK | Meta Ads (Facebook, Instagram) |
| 3 | ADNETWORK_GOOGLE | Google Ads |
| 5 | ADNETWORK_TIKTOK | TikTok Ads |
| 7 | ADNETWORK_ZALO | Zalo Ads |
| 9 | ADNETWORK_COC_COC | Cốc Cốc Ads |
| 21 | ADNETWORK_SHOPEE | Shopee Ads / Campaign |
| 23 | ADNETWORK_LAZADA | Lazada Ads / Campaign |
| 25 | ADNETWORK_TIKI | Tiki Ads / Campaign |
| 99 | ADNETWORK_OTHER | Khác (xem ad_network_other_name) |
Ví dụ JSON object
{
"id": 200,
"company_id": 10311,
"creator_id": 1,
"group": 3,
"type": 101,
"scope_class": 3,
"code": "GIAM5PHAN",
"name": "Giảm 5% đơn hàng",
"title": "Giảm 5% cho đơn từ 500K",
"title_short": "Giảm 5%",
"description": "Giảm 5% tổng giá trị đơn hàng khi mua từ 500.000đ",
"avatar_file_id_list": [],
"avatar_file_list": [],
"photo_gallery_file_id_list": [],
"photo_gallery_file_list": [],
"store_scope": 1,
"store_id_list": [],
"customer_scope": 1,
"value_type": 1,
"value": 5,
"bundle_discount_options": [],
"min_amount": 500000,
"max_amount": 100000,
"min_quantity": 0,
"max_quantity": 0,
"min_detail_line": 0,
"allow_payment_method_list": [],
"allow_order_source_list": [],
"allow_shipping_type_list": [],
"allow_shipping_region_id_list": [],
"allow_weekday_list": [],
"blackout_data": [],
"date_started": 1741000000,
"date_ended": 1743500000,
"time_start": 0,
"time_end": 0,
"priority": 10,
"stacking_mode": 1,
"mutex_set": "",
"limit_global_count": 1000,
"limit_per_customer_count": 3,
"limit_per_day_count": 100,
"redeem_type": 1,
"pass_code": "",
"gift_mode": 1,
"gift_trigger_block_quantity": 0,
"gift_pick_quantity": 0,
"gift_max_quantity": 0,
"gift_duplicate_policy": 1,
"ad_network": 0,
"ad_network_other_name": "",
"ad_campaign_id": "",
"ad_set_id": "",
"ad_creative_id": "",
"ad_campaign_code": "",
"show_on_promotion_page": 1,
"show_on_bundle_page": 0,
"seo_url": "giam-5-phan-tram",
"seo_title": "Giảm 5% đơn hàng từ 500K",
"seo_meta_description": "",
"seo_meta_keyword": "",
"seo_graph_file_id": 0,
"seo_canonical": "",
"seo_options": null,
"is_registered": 0,
"registration_date": 0,
"registration_code": "",
"registration_note": "",
"registration_file_id_list": [],
"registration_file_list": [],
"tags": [],
"status": 3,
"date_created": 1741000000,
"date_modified": 1741500000
}