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

Param
Type
Description
page
int (optional)
Phân trang, giá trị mặc định sẽ là 1.
id
int (optional)
Tìm kiếm theo ID đợt phát hành coupon.
couponCode
string (optional)
Tìm kiếm theo mã coupon.
productStoreId
int (optional)
Tìm kiếm theo ID sản phẩm.
depotId
int (optional)
Tìm kiếm theo ID kho.
name
string (optional)
Tìm kiếm tên đợt phát hành coupon.

Response

  • JSON decode the response to get the structure:
Key
Type
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
data = [
2
"totalPages" => int //tổng số page
3
"page" => int // page hiện tại
4
"result" => [ // Kết quả trả về
5
// coupon 1
6
[
7
"id" => int, //id coupon
8
"depotIds" => array, // mảng ID kho được áp dụng
9
"name" => string, // Tiêu đề coupon
10
"categories" => string, // Danh mục
11
"description" => string, // Mô tả,
12
"startDate" => string, // Ngày bắt đầu
13
"endDate" => string, // Ngày kết thúc
14
"fromValue" => int, // Chỉ được áp dụng cho hóa đơn có giá trị từ fromValue
15
"numberOfCodes" => int, // Số coupon
16
"canUsedTimes" => int, // Số lần có thể sử dụng
17
"usedTimes" => int, // Số lần đã sử dụng
18
"assignedTimes" => int, // Số lần đã tặng
19
"valueType" => int, // Kiểu giảm giá 1 = tiền mặt, 2= %
20
"value" => float, // Giá trị coupon
21
"valueMax" => float, // Giá trị tối đa (VD Coupon giảm 15% nhưng tối đa chỉ được 100K)
22
"status" => int, // Trạng thái 1 = Active, 2 = Inactive
23
"createdDatetime" => string // Ngày tạo
24
],
25
...
26
]
27
]
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

Param
Type
Description
page
int (optional)
Phân trang (giá trị mặc định là 1)
batchId
int (required)
ID đợt phát hành coupon

Response

  • JSON decode the response to get the structure:
Key
Type
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
data = [
2
"totalPages" => int, //tổng số page
3
"page" => int, // page hiện tại
4
"result" => [ // Kết quả trả về
5
// couponCode 1
6
[
7
"code" => string, // Mã coupon
8
"value" => int, // Giá trị coupon
9
"valueType" => int, // Kiểu áp dụng (1 = Tiền mặt, 2 = %)
10
"valueMax" => int, // Giá trị giảm giá tối đa (VD được giảm 15% nhưng tối đa 100K)
11
"canUsedTimes" => int, // Số lần còn có thể dùng
12
"usedTimes" => int, // Số lần đã dùng
13
"assignedTimes" => int, // Số lần đã tặng
14
"status" => int, // Trạng thái (1 - Mới, 2 - Đã sử dụng, 3 - Đã bị hủy, 4 - Đã tặng)
15
],
16
// couponCode 2
17
...
18
]
19
]
Copied!

Lấy danh sách sản phẩm được áp dụng coupon

  • /api/promotion/coupon?act=products: Tính năng này được sử dụng để lấy danh sản phẩm coupon, dùng trong tình huống bạn tạo các coupon chỉ muốn áp dụng cho 1 số sản phẩm cụ thể. Nếu kết quả trả về productIds là null hoặc 1 mảng rỗng nghĩa là mã coupon được áp dụng cho tất cả sản phẩm (không bị giới hạn chỉ được áp dụng cho 1 vài sản phẩm nào đó)

Request

Param
Type
Description
page
int (optional)
Phân trang (giá trị mặc định là 1)
icpp
int (optional)
Số lượng sản phẩm trên 1 trang. Mặc định là 10. Tối đa không quá 20.
couponBatchId
int (required)
ID đợt phát hành coupon

Response

  • JSON decode the response to get the structure:
Key
Type
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
data = [
2
"totalPages" => int, // tổng số page
3
"page" => int, // page hiện tại
4
"data" => [
5
productIds => [ productId, productId...] // mảng int các sản phẩm được áp dụng
6
]
7
]
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

Param
Type
Description
couponCode
string (required)
Mã coupon

Response

Key
Type
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
data = [
2
"result" => [ // Kết quả trả về
3
// coupon
4
[
5
"batchId" => int, // ID đợt phát hành coupon
6
"batchName" => string, // Tên đợt phát hành coupon
7
"depotIds" => array, // Mảng ID kho được áp dụng
8
"categoryIds" => array, // Mảng ID danh mục
9
"fromValue" => int, // Giá trị áp dụng
10
"canUsedTimes" => int, // Số lần có thể sử dụng coupon
11
"usedTimes" => int, // Số lần đã sử dụng coupon
12
"code" => string, // Mã coupon
13
"value" => string, // Giá trị
14
"valueMax" => string, // Giá trị tối đa
15
"startDate" => string, // Ngày bắt đầu,
16
"endDate" => string, // Ngày kết thúc
17
"description" => string, // Mô tả
18
"products" => array, // Mảng danh sách sản phẩm được áp dụng
19
]
20
]
21
]
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

Param
Type
Description
couponCode
string (required)
Mã coupon

Response

Key
Type
Description
code
int
1 = success or 0 = failed
messages
array
is an array of error messages if code = 0
1
[
2
"code" => 1, // 1 = đã cập nhật thành công, 0 = failed
3
"messages" => array
4
]
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

Param
Type
Description
couponCode
string (required)
Mã coupon

Response

Key
Type
Description
code
int
1 = success or 0 = failed
messages
array
is an array of error messages if code = 0
1
[
2
"code" => 1 // 1 = đã cập nhật thành công, 0 = failed,
3
"messages" => array
4
]
Copied!