OVIRO LogoOVIRO
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)
idintID chương trình khuyến mãi
company_idintID công ty (tenant)
creator_idintID người tạo
groupintNhóm khuyến mãi (xem bảng mã bên dưới)
typeintLoại khuyến mãi (xem bảng mã bên dưới)
scope_classintPhạm vi áp dụng (xem bảng mã bên dưới)
codestringMã chương trình khuyến mãi
namestringTên chương trình
titlestringTiêu đề hiển thị
title_shortstringTiêu đề ngắn
descriptionstringMô tả chi tiết
statusintTrạng thái (xem bảng mã bên dưới)
avatar_file_id_listarrayDanh sách ID ảnh đại diện
avatar_file_listarrayDanh sách đối tượng File ảnh đại diện
photo_gallery_file_id_listarrayDanh sách ID ảnh thư viện
photo_gallery_file_listarrayDanh sách đối tượng File ảnh thư viện
store_scopeintPhạm vi cửa hàng (1: Tất cả, 3: Chỉ định)
store_id_listarrayDanh sách ID cửa hàng áp dụng
customer_scopeintPhạm vi khách hàng (1: Tất cả, 3: Chỉ định)
value_typeintLoại giá trị giảm (xem bảng mã bên dưới)
valuemixedGiá trị giảm (số hoặc JSON tùy value_type)
bundle_discount_optionsarrayCấu hình giảm giá bundle
min_amountintGiá trị đơn hàng tối thiểu (VNĐ)
max_amountintGiá trị giảm tối đa (VNĐ)
min_quantityintSố lượng sản phẩm tối thiểu
max_quantityintSố lượng sản phẩm tối đa
min_detail_lineintSố dòng chi tiết đơn hàng tối thiểu
allow_payment_method_listarrayDanh sách phương thức thanh toán cho phép
allow_order_source_listarrayDanh sách nguồn đơn hàng cho phép
allow_shipping_type_listarrayDanh sách loại vận chuyển cho phép
allow_shipping_region_id_listarrayDanh sách ID khu vực giao hàng cho phép
allow_weekday_listarrayDanh sách ngày trong tuần cho phép
blackout_dataarrayCác giai đoạn không áp dụng (blackout)
date_startedintThời gian bắt đầu hiệu lực (UNIX timestamp)
date_endedintThời gian kết thúc hiệu lực (UNIX timestamp)
time_startintGiờ bắt đầu trong ngày (giây từ 00:00)
time_endintGiờ kết thúc trong ngày (giây từ 00:00)
date_createdintThời gian tạo (UNIX timestamp)
date_modifiedintThời gian cập nhật (UNIX timestamp)
priorityintMức ưu tiên (số càng lớn càng ưu tiên)
stacking_modeintChế độ cộng dồn (xem bảng mã bên dưới)
mutex_setstringNhóm mutex (các KM cùng mutex_set sẽ loại trừ nhau)
limit_global_countintGiới hạn tổng lượt sử dụng (0 = không giới hạn)
limit_per_customer_countintGiới hạn lượt sử dụng mỗi khách hàng (0 = không giới hạn)
limit_per_day_countintGiới hạn lượt sử dụng mỗi ngày (0 = không giới hạn)
redeem_typeintCách đổi thưởng (xem bảng mã bên dưới)
pass_codestringMã xác nhận (khi redeem_type = 3)
gift_modeintChế độ tặng quà
gift_trigger_block_quantityintSố lượng trigger block
gift_pick_quantityintSố lượng quà được chọn
gift_max_quantityintSố lượng quà tối đa
gift_duplicate_policyintChính sách trùng lặp quà
ad_networkintMạng quảng cáo
ad_network_other_namestringTên mạng QC khác (khi ad_network = Other)
ad_campaign_idstringID chiến dịch QC
ad_set_idstringID ad set
ad_creative_idstringID ad creative
ad_campaign_codestringMã chiến dịch QC
show_on_promotion_pageintHiển thị trên trang khuyến mãi (1: Có, 0: Không)
show_on_bundle_pageintHiển thị trên trang bundle (1: Có, 0: Không)
seo_urlstringURL SEO
seo_titlestringTiêu đề SEO
seo_meta_descriptionstringMô tả Meta SEO
seo_meta_keywordstringTừ khóa SEO
seo_graph_file_idintID file ảnh Open Graph
seo_canonicalstringCanonical URL
seo_optionsmixedTùy chọn SEO nâng cao
is_registeredintĐã đăng ký CTKMM (1: Có, 0: Không)
registration_dateintNgày đăng ký (UNIX timestamp)
registration_codestringMã số đăng ký
registration_notestringGhi chú đăng ký
registration_file_id_listarrayDanh sách ID file đăng ký
registration_file_listarrayDanh sách đối tượng File đăng ký
tagsarrayThẻ (Tags)

Các bảng mã giá trị (Enums)

Nhóm khuyến mãi (Group)

Giá trịKeyMô tả
1GROUP_SHIPPINGKhuyến mãi vận chuyển
3GROUP_SEASONALKhuyến mãi theo mùa
5GROUP_LOYALTYChương trình khách hàng thân thiết
7GROUP_BUNDLECombo / Bundle

Loại khuyến mãi (Type)

Giá trịKeyMô tả
100TYPE_SHIPPING_DISCOUNTGiảm phí vận chuyển
101TYPE_SEASONAL_ORDER_DISCOUNTGiảm giá đơn hàng theo mùa
103TYPE_SEASONAL_PRODUCT_DISCOUNTGiảm giá sản phẩm theo mùa
105TYPE_SEASONAL_PRODUCT_GIFTTặng sản phẩm theo mùa
109TYPE_SEASONAL_ORDER_GIFTTặng quà theo đơn hàng
305TYPE_LOYALTY_COUPONCoupon khách hàng thân thiết
703TYPE_BUNDLE_VOLUME_DISCOUNTGiảm giá theo số lượng
705TYPE_BUNDLE_BOUGHT_TOGETHERMua kèm
707TYPE_BUNDLE_PRODUCT_MIX_MATCHCombo sản phẩm
709TYPE_BUNDLE_COLLECTION_MIX_MATCHCombo theo bộ sưu tập

Phạm vi áp dụng (Scope Class)

Giá trịKeyMô tả
1SCOPE_CLASS_PRODUCTÁp dụng theo sản phẩm
3SCOPE_CLASS_CARTÁp dụng theo giỏ hàng
5SCOPE_CLASS_SHIPPINGÁp dụng theo phí vận chuyển
7SCOPE_CLASS_BUNDLEÁp dụng theo combo/bundle

Trạng thái (Status)

Giá trịKeyMô tả
1STATUS_PENDINGChờ kích hoạt
3STATUS_RUNNINGĐang chạy
5STATUS_PAUSEDTạm dừng
7STATUS_ENDEDĐã kết thúc
9STATUS_REMOVEDĐã xóa

Loại giá trị giảm (Value Type)

Giá trịKeyMô tả
1VALUETYPE_PERCENTGiảm theo phần trăm (%)
3VALUETYPE_CURRENCYGiảm theo số tiền cố định (VNĐ)
5VALUETYPE_RANGEGiảm theo bậc thang (range)
7VALUETYPE_FIXPRICEGiá cố định
9VALUETYPE_GIFTTặng quà
11VALUETYPE_BUNDLE_CURRENCYGiảm tiền bundle
13VALUETYPE_BUNDLE_FIXPRICEGiá cố định bundle

Chế độ cộng dồn (Stacking Mode)

Giá trịKeyMô tả
1STACKING_MODE_STACKABLECho phép cộng dồn với KM khác
3STACKING_MODE_EXCLUSIVEĐộc quyền, không cộng dồn
5STACKING_MODE_GROUP_EXCLUSIVEĐộc quyền trong cùng nhóm

Cách đổi thưởng (Redeem Type)

Giá trịKeyMô tả
1REDEEM_TYPE_AUTOTự động áp dụng
3REDEEM_TYPE_REQUIRE_CODEYêu cầu nhập mã (pass_code)

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
}

Danh sách Order Promotion

Trả về danh sách khuyến mãi đã áp dụng trên đơn hàng, hỗ trợ phân trang và nhiều bộ lọc.

Tìm kiếm Promotion theo Coupon

Tìm kiếm các chương trình khuyến mãi theo mã coupon. Trả về danh sách Promotion tương ứng (đã loại trùng theo promotion_id).

On this page

JSON Schema
Các bảng mã giá trị (Enums)
Nhóm khuyến mãi (Group)
Loại khuyến mãi (Type)
Phạm vi áp dụng (Scope Class)
Trạng thái (Status)
Loại giá trị giảm (Value Type)
Chế độ cộng dồn (Stacking Mode)
Cách đổi thưởng (Redeem Type)
Ví dụ JSON object