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

• Xem các common request params

• Các key của mảng data array dùng để tạo data json string:

Key	Type	Description
page	int	Phân trang, giá trị mặc định sẽ là 1.
id	int	Tìm kiếm theo ID đợt phát hành coupon.
couponCode	string	Tìm kiếm theo mã coupon.
productStoreId	int	Tìm kiếm theo ID sản phẩm.
depotId	int	Tìm kiếm theo ID kho.
name	string	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

data = [
      "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" => int, // 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
              "options" => {
                "notApplyWithDiscountPromotion" => Boolean // chương trình có cho áp dụng cùng chương trình chiết khấu hay không.True: có,False: không
              }
          ],
          ...
      ]
]

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

• Xem các common request params

• Các key của mảng data array dùng để tạo data json string:

Key	Type	Description
page	int	Phân trang (giá trị mặc định là 1)
batchId	int $^{{\color{red}*}}$	ID đợt phát hành coupon, lấy từ /api/promotion/coupon?act=list

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

data = [
      "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 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

• Xem các common request params

• Các key của mảng data array dùng để tạo data json string:

Param	Type	Description
page	int	Phân trang (giá trị mặc định là 1)
icpp	int	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 $^{{\color{red}*}}$	ID đợt phát hành coupon, lấy từ /api/promotion/coupon?act=list

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

data = [
    "totalPages" => int, // tổng số page
    "page" => int, // page hiện tại
    "data" => [
        productIds => [ productId, productId...] // mảng int các sản phẩm được áp dụng
    ]
]

Lấy thông tin coupon code

• /api/promotion/coupon?act=check: Tính năng này được sử dụng để kiểm tra mã coupon có hợp lệ hay không (khoảng ngày, điều kiện được áp dụng, sản phẩm được áp dụng)

Request

• Xem các common request params

• Các key của mảng data array dùng để tạo data json string:

Param	Type	Description
couponCode	string $^{{\color{red}*}}$	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

data = [
    "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

• Xem các common request params

• Các key của mảng data array dùng để tạo data json string:

Param	Type	Description
couponCode	string $^{{\color{red}*}}$	Mã coupon

Response

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

[
    "code" => 1, // 1 = đã cập nhật thành công, 0 = failed
    "messages" => array
]

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

• Xem các common request params

• Các key của mảng data array dùng để tạo data json string:

Param	Type	Description
couponCode	string $^{{\color{red}*}}$	Mã coupon

Response

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

[
    "code" => 1 // 1 = đã cập nhật thành công, 0 = failed,
    "messages" => array
]

Tạo chương trình coupon

• /api/promotion/coupon?act=addbatch: Tính năng này được sử dụng để tạo chương trình coupon

Request

• Xem các common request params

• Các key của mảng data array dùng để tạo data json string:

Param	Type	Description
name	string(255) $^{{\color{red}*}}$	Tên chương trình coupon
status	int $^{{\color{red}*}}$	Trạng thái: 1 - Hoạt động, 2 - Ngừng hoạt động
startDate	string $^{{\color{red}*}}$	Định dạng: Y-m-d. Ngày áp dụng từ
endDate	string $^{{\color{red}*}}$	Định dạng: Y-m-d. Ngày áp dụng đến
codeLength	int $^{{\color{red}*}}$	Độ dài mã coupon: 5 - 5 kí tự, 6 - 6 kí tự, 7 - 7 kí tự, 8 - 8 kí tự, 9 - 9 kí tự, 10 - 10 kí tự
numberOfCodes	int $^{{\color{red}*}}$	Số lượng mã coupon muốn tạo (Tối đa 20.000 mã)
canUsedTimes	int $^{{\color{red}*}}$	Số lần sử dụng của từng mã
valueType	int $^{{\color{red}*}}$	Kiểu giảm giá: 1 - Tiền mặt, 2 - Chiết khấu
value	int $^{{\color{red}*}}$	Giá trị coupon
depotId	int or array	ID hoặc mảng ID kho được áp dụng mã coupon
categoryId	int or array	ID hoặc mảng ID doanh mục được áp dụng mã coupon
fromValue	int	Áp dụng cho hóa đơn có tổng tiền từ
toValue	int	Áp dụng cho hóa đơn có tổng tiền đến
prefix	string(5)	Kí tự thêm vào trước mã coupon
suffix	string(5)	Kí tự thêm vào sau mã coupon
valueMax	int	Giá trị giảm giá tối đa
description	string(255)	Mô tả
notApplyWithDiscountPromotion	int	Không áp dụng cùng chương trình chiết khấu. Giá trị truyền lên: 1

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 if code = 1

[
    "code" => 1 // 1 = đã cập nhật thành công, 0 = failed,
    "messages" => array
    "data" => [
        'couponBacthId' => 1251230 // ID chương trình coupon trên Nhanh.vn
    ]
]

Thêm mã coupon vào chương trình

• /api/promotion/coupon?act=increasecode: Tính năng này được sử dụng để cập nhật thêm mã vào chương trình coupon đã có trên hệ thống

Request

• Xem các common request params

• Các key của mảng data array dùng để tạo data json string:

Param	Type	Description
couponBatchId	int $^{{\color{red}*}}$	ID chương trình coupon
couponNumber	int $^{{\color{red}*}}$	Số lượng mã coupon muốn thêm (Tối đa 1000 mã)
canUsedTimes	int $^{{\color{red}*}}$	Số lần sử dụng từng mã coupon

Response

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

[
    "code" => 1 // 1 = đã cập nhật thành công, 0 = failed,
    "messages" => array
]