Lấy 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

  data = [
    page: int, //page load
    id: int // lọc ID đợt phát hành coupon
    couponCode: string // lọc theo mã coupon,
    productStoreId: int // Lọc theo ID sản phẩm
    depotId: int // Lọc theo ID kho
    name: string // Lọc theo tên đợt phát hành 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 coupons

[
    {
        'totalPages': int //tổng số page
        'page': int // page hiện tại
        'result': [ // Kết quả trả về
            // coupon 1
            [
                'id': int //id coupon
                'depotIds': array // mảng ID kho được áp dụng
                'name': string // Tiêu đề coupon
                'categories': string // Danh mục
                'description': string // Mô tả,
                'startDate': string // Ngày bắt đầu
                'endDate': string // Ngày kết thúc
                'fromValue':  int // Chỉ được áp dụng cho hóa đơn có giá trị từ fromValue
                'numberOfCodes':  int // Số coupon
                'canUsedTimes': int // Số lần có thể sử dụng
                'usedTimes':  int // Số lần đã sử dụng
                'assignedTimes':  int // Số lần đã tặng
                'valueType': Kiểu giảm giá 1 = tiền mặt, 2= %
                'value':  float // Giá trị coupon
                'valueMax':  float // Giá trị tối đa (VD Coupon giảm 15% nhưng tối đa chỉ được 100K)
                'status':  int // Trạng thái 1 = Active, 2 = Inactive
                'createdDatetime':  string // Ngày tạo
            ]
            // coupon 2
        ]
}

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

data = [
  page: int, //page load
  batchId: int // ID đợt phát hành coupon (bắt buộc)
]

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 code

[
    {
        'totalPages': int //tổng số page
        'page': int // page hiện tại
        'result': [ // Kết quả trả về
            // couponCode 1
            [
                'code': string // Mã coupon
                'value': int // Giá trị coupon
                'valueType': int // Kiểu áp dụng (1 = Tiền mặt, 2 = %)
                'valueMax': int // Giá trị giảm giá tối đa (VD được giảm 15% nhưng tối đa 100K)
                'canUsedTimes': int // Số lần còn có thể dùng
                'usedTimes': int // Số lần đã dùng
                'assignedTimes': int // Số lần đã tặng
                'status' : int // Trạng thái (1 - Mới, 2 - Đã sử dụng, 3 - Đã bị hủy, 4 - Đã tặng)
             ]
             // couponCode 2
             ...
         ]
}

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

  data = [
    couponCode: string // 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

[
    {
        'result': [ // Kết quả trả về
            // coupon
            [
                'batchId': int // ID đợt phát hành coupon
                'batchName': string // Tên đợt phát hành coupon
                'depotIds': array // Mảng ID kho được áp dụng
                'categoryIds' : array // Mảng ID danh mục
                'fromValue' : int // Giá trị áp dụng
                'canUsedTimes': int // Số lần có thể sử dụng coupon
                'usedTimes': int // Số lần đã sử dụng coupon
                'code': string // Mã coupon
                'value': string // Giá trị
                'valueMax': string // Giá trị tối đa
                'startDate': string // Ngày bắt đầu,
                'endDate': string // Ngày kết thúc
                'description': string // Mô tả
                'products': array // Mảng danh sách sản phẩm được áp dụng
            ]
        ]
}

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

  data = [
    couponCode: string // Mã coupon,
  ]

Response

Key	Type	Description
code	int	1 = success or 0 = failed
messages	array	is an array of error messages if code = 0

[
    {
        'result': [ // Kết quả trả về
            'code' : 1
        ]
}

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

 data = [
   couponCode: string // Mã coupon
 ]

Response

Key	Type	Description
code	int	1 = success or 0 = failed
messages	array	is an array of error messages if code = 0

[
    {
        'result': [ // Kết quả trả về
            'code' : 1 // đã cập nhật thành công
        ]
}