Danh sách coupon

Coupon là các mã giảm giá ngẫu nhiên do shop tạo ra trên hệ thống của Nhanh.vn, shop có thể tạo nhiều chương trình Coupon, mỗi chương trình có nhiều mã Coupon. Mã Coupon là duy nhất (unique không trùng nhau) trên toàn bộ các chương trình Coupon.
Coupon được đùng để tặng cho khách hàng, khi khách mua hàng, có thể đọc mã cho thu ngân, hoặc điền mã coupon trên các form đặt hàng trên website / app để được áp dụng giảm giá.
Coupon có thể được cài đặt:
Khoảng ngày được áp dụng.
Giá trị giảm giá theo %, theo tiền mặt.
Chỉ áp dụng cho hóa đơn từ bao nhiêu.
Chỉ được dùng ở cửa hàng nào.
Chỉ được giảm tối đa bao nhiêu tiền (VD giảm 15% nhưng tối đa 100K).
Coupon cũng có thể được cài đặt để chỉ được sử dụng 1 lần duy nhất hoặc được áp dụng bao nhiêu lần (canUsedTimes), bạn cần chú ý con số này để khi tặng mã Coupon cho khách hàng không nên vượt quá số lượt được sử dụng, tránh tình huống những khách hàng sau không dùng được mã coupon nữa.
Lấy danh sách chương trình Coupon
/api/promotion/coupon?act=list
Request
See common request params​
Cấu trúc data đẩy lên
1
data = [
2
  page: int, //page load
3
  id: int // lọc ID đợt phát hành coupon
4
  couponCode: string // lọc theo mã coupon,
5
  productStoreId: int // Lọc theo ID sản phẩm
6
  depotId: int // Lọc theo ID kho
7
  name: string // Lọc theo tên đợt phát hành coupon
8
]
Copied!
Response
Key
Data Type(Max-length)
Description
code
int
1 = success or 0 = failed
messages
array
is an array of error messages if code = 0
data
array
is an array of coupons
1
[
2
    {
3
        'totalPages': int //tổng số page
4
        'page': int // page hiện tại
5
        'result': [ // Kết quả trả về
6
            // coupon 1
7
            [
8
                'id': int //id coupon
9
                'depotIds': array // mảng ID kho được áp dụng
10
                'name': string // Tiêu đề coupon
11
                'categories': string // Danh mục
12
                'description': string // Mô tả,
13
                'startDate': string // Ngày bắt đầu
14
                'endDate': string // Ngày kết thúc
15
                'fromValue':  int // Chỉ được áp dụng cho hóa đơn có giá trị từ fromValue
16
                'numberOfCodes':  int // Số coupon
17
                'canUsedTimes': int // Số lần có thể sử dụng
18
                'usedTimes':  int // Số lần đã sử dụng
19
                'assignedTimes':  int // Số lần đã tặng
20
                'valueType': Kiểu giảm giá 1 = tiền mặt, 2= %
21
                'value':  float // Giá trị coupon
22
                'valueMax':  float // Giá trị tối đa (VD Coupon giảm 15% nhưng tối đa chỉ được 100K)
23
                'status':  int // Trạng thái 1 = Active, 2 = Inactive
24
                'createdDatetime':  string // Ngày tạo
25
            ]
26
            // coupon 2
27
        ]
28
}
Copied!
Lấy danh sách coupon code
/api/promotion/coupon?act=codes: Tính năng này được sử dụng để lấy danh sách mã coupon
Request
See common request params​
Cấu trúc data đẩy lên
1
data = [
2
  page: int, //page load
3
  batchId: int // ID đợt phát hành coupon (bắt buộc)
4
]
Copied!
Response
Key
Data Type(Max-length)
Description
code
int
1 = success or 0 = failed
messages
array
is an array of error messages if code = 0
data
array
is an array of coupon code
1
[
2
    {
3
        'totalPages': int //tổng số page
4
        'page': int // page hiện tại
5
        'result': [ // Kết quả trả về
6
            // couponCode 1
7
            [
8
                'code': string // Mã coupon
9
                'value': int // Giá trị coupon
10
                'valueType': int // Kiểu áp dụng (1 = Tiền mặt, 2 = %)
11
                'valueMax': int // Giá trị giảm giá tối đa (VD được giảm 15% nhưng tối đa 100K)
12
                'canUsedTimes': int // Số lần còn có thể dùng
13
                'usedTimes': int // Số lần đã dùng
14
                'assignedTimes': int // Số lần đã tặng
15
                'status' : int // Trạng thái (1 - Mới, 2 - Đã sử dụng, 3 - Đã bị hủy, 4 - Đã tặng)
16
             ]
17
             // couponCode 2
18
             ...
19
         ]
20
}
Copied!
Lấy thông tin coupon code
/api/promotion/coupon?act=check: Tính năng này được sử dụng để lấy chi tiết mã coupon(khoảng ngày, điều kiện được áp dụng, sản phẩm được áp dụng)
Request
See common request params​
Cấu trúc data đẩy lên
1
data = [
2
  couponCode: string // Mã coupon,
3
]
Copied!
Response
Key
Data Type(Max-length)
Description
code
int
1 = success or 0 = failed
messages
array
is an array of error messages if code = 0
data
array
is an array of coupon
1
[
2
    {
3
        'result': [ // Kết quả trả về
4
            // coupon
5
            [
6
                'batchId': int // ID đợt phát hành coupon
7
                'batchName': string // Tên đợt phát hành coupon
8
                'depotIds': array // Mảng ID kho được áp dụng
9
                'categoryIds' : array // Mảng ID danh mục
10
                'fromValue' : int // Giá trị áp dụng
11
                'canUsedTimes': int // Số lần có thể sử dụng coupon
12
                'usedTimes': int // Số lần đã sử dụng coupon
13
                'code': string // Mã coupon
14
                'value': string // Giá trị
15
                'valueMax': string // Giá trị tối đa
16
                'startDate': string // Ngày bắt đầu,
17
                'endDate': string // Ngày kết thúc
18
                'description': string // Mô tả
19
                'products': array // Mảng danh sách sản phẩm được áp dụng
20
            ]
21
        ]
22
}
Copied!
Tặng mã coupon
/api/promotion/coupon?act=giveaway: Tính năng này được sử dụng để bạn tặng mã coupon cho khách hàng xong, thì cần báo để server cập nhật lại số lần đã tặng, tránh việc 1 mã được tặng nhiều lần và khách khác không thể sử dụng được nữa.
Request
See common request params​
Cấu trúc data đẩy lên
1
data = [
2
  couponCode: string // Mã coupon,
3
]
Copied!
Response
Key
Data Type(Max-length)
Description
code
int
1 = success or 0 = failed
messages
array
is an array of error messages if code = 0
1
[
2
    {
3
        'result': [ // Kết quả trả về
4
            'code' : 1
5
        ]
6
}
Copied!
Sử dụng mã coupon
/api/promotion/coupon?act=use: Tính năng này được sử dụng để thông báo cho server biết 1 mã coupon đã được sử dụng, tránh việc 1 mã được sử dụng nhiều lần.
Request
See common request params​
Cấu trúc data đẩy lên
1
data = [
2
  couponCode: string // Mã coupon
3
]
Copied!
Response
Key
Data Type(Max-length)
Description
code
int
1 = success or 0 = failed
messages
array
is an array of error messages if code = 0
1
[
2
    {
3
        'result': [ // Kết quả trả về
4
            'code' : 1 // đã cập nhật thành công
5
        ]
6
}
Copied!