Thẻ quà tặng điện tử Got It có các định dạng sau:
| Định dạng | Mô tả | Ví dụ trên sandbox |
|---|---|---|
| Single Link – Link đơn https://v.gotit.vn/xxxxxxxx |
Một Link chứa duy nhất 01 mã thẻ quà tặng. Khách hàng được sử dụng 1 lần duy nhất | https://v-stg.gotit.vn/mVb8XN2D |
| Group Link – Link nhóm https://g.gotit.vn/xxxxxxxx |
Một Link chứa ít nhất 02 mã thẻ quà tặng đơn. | https://g-stg.gotit.vn/nY7aV5HT |
| Splittable Voucher - Link ví https://e.gotit.vn/xxxxxxx Chưa hỗ trợ tích hợp qua API |
Một Link chứa duy nhất 01 mã thẻ quà tặng. Tuy nhiên, khách hàng có thể tách nhỏ thành nhiều mã thẻ quà tặng có giá trị sử dụng khác nhau | https://e-stg.gotit.vn/BjnU25tp |
Got It hỗ trợ khách hàng các hình thức bảo mật sau:
| Loại bảo mật | Mô tả |
|---|---|
| Mã xác thực OTP | Đơn vị phát hành sẽ định danh Thẻ quà tặng thuộc end-user nào. Khi mở voucher sử dụng, hệ thống sẽ yêu cầu nhập OTP xác thực trước khi thể hiện thông tin voucher. Có 2 hình thức nhận OTP: sms qua số điện thoại end-user và email. |
| Mật khẩu cố định | Đơn vị phát hành sẽ cài mật khẩu cố định, end-user cần nhập đúng mật khẩu để thấy thông tin voucher. |
| Cover link Chưa hỗ trợ phát hành qua API |
Đơn vị sẽ phát hành voucher dưới hình thức 1 đường link định danh (cover link). End-user sẽ chủ động định danh bằng cách mở link và nhập số điện thoại của mình. |
Đối với việc sử dụng thẻ quà tặng trực tiếp tại cửa hàng thương hiệu đối tác, Thẻ quà tặng bắt buộc phải có 03 đặc điểm nhận diện sau.
- Logo Got It
- Mã thẻ quà tặng: bao gồm mã quà tặng (thông thường là 10 số, có những trường hợp đặc biệt sẽ từ 12 đến 15 số và chữ) và Mã vạch (Barcode) là dạng hình hiển thị mã vạch chuẩn code-128, được tạo nên dựa trên mã quà tặng. Khi máy scan quét qua mã vạch, thì sẽ nhận được kết quả là chuỗi ký tự của mã quà tặng
- Hạn sử dụng
Bên dưới là hướng dẫn chi tiết cho từng loại hiển thị:
| Thông tin | Mô tả | Minh họa |
|---|---|---|
| Danh mục ngành hàng | Gồm các thông tin: 1. Tên ngành hàng 2. Icon |
 |
| Danh sách thương hiệu theo ngành hàng | Gồm các thông tin: 1. Logo Thương Hiệu 2.Tên Thương Hiệu 3.Mô tả ngắn |
 |
| Danh sách sản phẩm thuộc thương hiệu | Gồm các thông tin: 1. Tên sản phẩm 2. Hình ảnh sản phẩm 3. Giá trị hay mệnh giá sản phẩm 4. Tên thương hiệu |
 |
| Chi tiết sản phẩm | Gồm các thông tin: 1. Tên sản phẩm 2. Hình ảnh sản phẩm 3. Giá trị hay mệnh giá sản phẩm 4. Tên thương hiệu 5. Mô tả hoặc thông tin sản phẩm 6. Điều khoản sử dụng |
 |
| Chi tiết Thẻ quà tặng | Gồm các thông tin: 1. Tên sản phẩm 2. Hình ảnh sản phẩm 3. Giá trị hay mệnh giá sản phẩm 4. Tên thương hiệu 5. Logo Got It 6. Mã thẻ quà tặng và barcode 7. Hạn sử dụng 8. Điều khoản sử dụng 9. Hướng dẫn sử dụng 10. Địa điểm áp dụng |
 |
| Chi tiết Thẻ quà tặng Grab | Khác với định dạng mã quà tặng của các thương hiệu đối tác khác, Grab là định dạng deeplink để nạp thẻ quà tặng vào tài khoản Grab bằng ứng dụng trên điện thoại thông minh hoặc trên ứng dụng trên website của Grab. Bởi vì theo định dạng deeplink nên Ứng dụng của khách hàng phải trình bày deeplink dưới dạng nút nhấn, khi người dùng nhấn vào sẽ trỏ về đường dẫn của deeplink |  |
Các bước cơ bản để tích hợp với Got It:
- Đăng ký tài khoản doanh nghiệp.
Bạn cần hoàn thành quá trình đăng ký với đầy đủ thông tin, trạng thái mặc định của doanh nghiệp sẽ là
chưa xác thực. Thông tin tích hợp mặc định sẽ môi trườngsandbox.
- Tham khảo và chọn loại Thẻ quà tặng và định dạng phát hành đến người dùng cuối (end-user).
- Tiến hành tích hợp theo tài liệu được cung cấp.
- Đối tác tiến hành kiểm thử phần mềm, tham khảo các testcase của Got It cung cấp để kiểm tra các lỗi phổ biến trong quá trình phát hành voucher.
- Sau khi đối tác hoàn thành tích hợp và kiểm thử, Got It sẽ xác thực dịch vụ trên môi trường test trước khi chuyển qua môi trường thực tế (production).
- Sau khi được xác nhận, tài khoản doanh nghiệp của bạn sẽ được chuyển sang trạng thái đã xác thực. Got It sẽ cung cấp các thông tin production cho người chịu trách nhiệm chính (PIC) của đối tác. Phía đối tác cũng cung cấp thông tin
địa chỉ IPkết nối API để Got It thêm vào whitelist.
Các thông tin production cần được
bảo mật ở mức độ cao nhấtđể tránh tình trạng bị đánh cắp thông tin.
- Đối tác cập nhật các thông tin tích hợp theo môi trường production.
- Tiến hành phát hành voucher cho doanh nghiệp.
Tất cả yêu cầu gửi đến phải chứa trường “X-GI-Authorization” trên header, API Key do Got It cung cấp.
- API Key: Thông tin để định danh tài khoản doanh nghiệp
Khách hàng có trách nhiệm bảo mật thông tin API key . Nếu khách hàng để lộ API Key sẽ phải chịu trách nhiệm cho mọi voucher phát sinh từ phía API Key này.
Trường hợp khách hàng muốn nâng cao bảo mật, vui lòng tham khảo mục Các vấn đề bảo mật và cấu hình thêm các thông tin sau:
- Private Key: Thông tin để tạo chữ ký điện tử
signatureCó độ dài 2048 bit. - Public Key: Thông tin để xác thực chữ ký điện tử theo thuật toán
RSA.
luôn luôn là “application/json”
Môi trường Sandbox: https://biz-stg.gotit.vn/api/…
Môi trường Production: https://biz.gotit.vn/api/…
Ngôn ngữ sử dụng cho các trường dạng text (Ví dụ: tên sản phẩm, điều khoản sử dụng…)
Tiếng Anh
Tiếng Việt
Để đảm bảo request được gọi đúng từ phía đối tác, Got It sẽ tiến hành thêm địa chỉ IP của server đối tác vào whitelist. Đối tác cần cung cấp địa chỉ IP của server môi trường production trước khi triển khai thực tế.
Bên cạnh đó, với đối tác có nhu cầu bảo mật cao hơn, Got It hỗ trợ phương thức xác thực chữ ký điện tử và mã hóa dữ liệu trên mỗi yêu cầu HTTP Request - HTTP Response
Để chứng thực dữ liệu khi client call API, Got It cung cấp cơ chế mã hóa bất đối xứng RSA hay còn gọi là hệ mã hóa public key, nó sử dụng một cặp key private key để mã hóa và public key giải mã.
GotIt và khách hàng sẽ tạo ra cặp private - public key có độ dài là 2084 bit, 2 bên sẽ trao đổi public key. Khi khách hàng call đến Got It, khách hàng sẽ dùng private key của mình ký trên dữ liệu gửi đi theo quy tắc được Got It định nghĩa.
Got It sẽ dùng public key mà đối tác cung cấp để giải mã chữ ký và xác minh dữ liệu là đúng và được gửi từ phía client. Sau đó, Got It sẽ dùng private key của mình ký trên dữ liệu trả về, đối tác sẽ dùng public key Got It cung cấp để xác thực chữ ký.
Các bước tích hợp
- Got It và client sẽ cùng tạo cặp private key và public key theo chuẩn
RSA 2048 bitvà trao đổi public key với nhau. Public key sẽ có dạng như sau:
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAs6nbG7CAlkfJSC5KVjxb
93re5zw+BXCYh9QrmjwR40rg5RtEZyNnLjSS0Os2nHVl9/ke0Np2dUOgb1+ZOG9t
…
ClfHrIp6umA+dwrWbP/MfzQ1euELyCfSgKPfILlQHJ7dvE4QaJ1rJAsJkQc9ysFj
dQIDAQAB
-----END PUBLIC KEY-----
- Khi gọi API, phía client cần truyền thêm tham số
signature(được mã hóa SHA1 with RSA và base64) vào request body. Chữ ký được tạo từaccess codecó cú pháp tương ứng với từng API, cụ thể như sau:
API phát hành voucher /transaction, /transactiongroup
[API Key]|campaignNm|expiryDate|voucherRefId
API kiểm tra thông tin voucher transaction/check, transaction/checkmultiple
[API Key]|voucherRefId
- Got It sẽ dùng
public keymà client cung cấp để xác thực signature này, nếu đúng sẽ tiến hành xử lý API, nếu sai sẽ báo lỗi (3003: The signature is incorrect). - Got It sẽ đính kèm chữ ký của Got It ở
headercủa response, đối tác sẽ xác thực chữ ký dựa trênpublic keycủa Got It cung cấp trên toàn bộ response body.
Mỗi tài khoản đối tác sẽ có một hạn mức tổng giá trị voucher được phép phát hành (ngân sách). Ngân sách của mỗi tài khoản sẽ được thiết lập trước khi triển khai thực tế (production). Got It sẽ theo dõi và thông báo cho đối tác tiến hành gia hạn khi tổng giá trị voucher được phát hành sắp đạt ngưỡng của ngân sách (~80%).
Một số thương hiệu hợp tác với Got It không áp dụng trực tiếp mã quà tặng 10 số của Got It mà cần phải chuyển đổi sang mã quà tặng của riêng thương hiệu đó mới có thể áp dụng được. Có 3 hình thức chuyển đổi:
| Hình thức | Mô tả |
|---|---|
| Convert từ voucher multi | Khách hàng sẽ chọn thương hiệu trong danh sách thương hiệu Got It và bấm “Đổi mã ngay” để chuyển đổi. |
| Phát hành voucher auto-convert | Thông tin voucher trả về với voucher code đã được chuyển đổi thành code đối tác. |
| Nhắn tin tổng đài Got It | Khách hàng sẽ nhắn tin lên tổng đài của Got It với cú pháp tương ứng với thương hiệu cần chuyển đổi. |
Lưu ý: Mã Got It sau khi chuyển đổi thành Mã đối tác sẽ được xem là “Đã sử dụng” tại thương hiệu.
Vui lòng liên hệ Got It để được cập nhật danh sách các thương hiệu cần chuyển đổi code trước khi sử dụng.
Thông tin chi tiết voucher
Mã số voucher.Chứa 10 số, duy nhất không trùng lắp với bất cứ voucher nào khác
Link của voucher. Để hiển thị voucher trên trình duyệt
Link của hình ảnh voucher. Để hiển thị voucher dưới dạng hình ảnh
Thông tin chi tiết sản phẩm
Mã trạng thái hiện tại của voucher
Tên trạng thái hiện tại của voucher
Mã giao dịch do khách hàng đặt khi gọi giao dịch tạo voucher
Examples
{
"voucherCode": "",
"voucherLink": "",
"voucherImageLink": "",
"product": {
"productId": 1,
"productNm": "",
"productImg": "",
"brandId": 1,
"brandNm": "",
"size": [
{
"priceId": 1,
"priceNm": "",
"pricePrice": 1
}
],
"productDesc": "",
"terms": "",
"storeList": [
{
"storeId": 1,
"storeNm": "",
"storeAddr": "",
"lat": 1,
"long": 1
}
],
"link": "",
"productType": ""
},
"stateCode": 1,
"stateText": "Used, Expired, Canceled",
"voucherRefId": ""
}Mỗi voucher của Got It sẽ gắn liền với với một sản phẩm. Sản phẩm có thể là một sản phẩm cụ thể của một thương hiệu (vd: ly cafe Highlands); hoặc mệnh giá như tiền mặt dùng để thanh toán hóa đơn tại cửa hàng (vd: phiếu mua hàng mệnh giá 100K VND tại Ministop).
Kiểu dữ liệu của sản phẩm:
Mã số sản phẩm
Tên sản phẩm
Link đến hình ảnh sản phẩm
Mã số thương hiệu
Tên thương hiệu
Mảng chứa tất cả mệnh giá của sản phẩm
Mô tả sản phẩm
Điều khoản sử dụng
Mảng chứa tất cả thông tin cửa hàng có thể sử dung voucher
Link xem thông tin sản phẩm
c (cash/mệnh giá tiền mặt thanh toán) hoặc i (item/quy đổi sản phẩm)
Thông tin mệnh giá sản phẩm
Mã số mệnh giá / kích thước sản phẩm
Tên mệnh giá/ kích thước sản phẩm
Mệnh giá
Thông tin cửa hàng chấp nhận sử dụng voucher Got It trong thanh toán
Mã số cửa hàng
Tên cửa hàng
Địa chỉ cửa hàng
Số Lat trên bản đồ Google
Số Long trên bản đồ Google
Thông tin thương hiệu
Mã số thương hiệu
Tên thương hiệu
Link đến hình ảnh thương hiệu (logo hoặc hình ảnh chủ đạo của thương hiệu)
Tên thương hiệu dùng cho URL
Mảng chứa danh sách mã ngành mà thương hiệu này thuộc về
Điều khoản sử dụng riêng của thương hiệu
Danh sách các API dùng để lấy dữ liệu gốc, hiển thị thông tin Danh mục ngành hàng, Thương hiệu, Sản phẩm và phát hành voucher.
{CategoryID}{brand_id}Dùng để lấy danh sách ngành hàng của các thương hiệu hợp tác với Got It.
Responses
Trả về mảng chứa danh sách ngành hàng của thương hiệu
Body
Mã của danh mục
Tên danh mục
Icon của danh mục
Tên ngành hàng dùng cho URL
Thứ tự hiển thị
Examples
[
{
"categoryId": 2,
"categoryNm": "Cafe và Bánh",
"categoryImg": "https://img.gotit.vn/category/cafe-va-banh.png",
"slug": "fastfood-cafe",
"order": 1
},
{
"categoryId": 1,
"categoryNm": "Nhà Hàng",
"categoryImg": "https://img.gotit.vn/category/nha-hang.png",
"slug": "restaurants",
"order": 2
},
{
"categoryId": 3,
"categoryNm": "Mỹ Phẩm và Làm Đẹp",
"categoryImg": "https://img.gotit.vn/category/my-pham-va-lam-dep.png",
"slug": "fashion-cosmetic",
"order": 3
},
{
"categoryId": 7,
"categoryNm": "Mua Sắm",
"categoryImg": "https://img.gotit.vn/category/mua-sam.png",
"slug": "shopping",
"order": 4
}
]Dùng để lấy toàn bộ danh sách thương hiệu
Responses
Trả về mảng chứa danh sách thương hiệu
Body
Mã của thương hiệu
Tên thương hiệu
Logo thương hiệu
Tên thương hiệu dùng cho URL
Mô tả ngắn về thương hiệu
Thông tin về thương hiệu
Mảng chứa danh sách mã ngành hàng mà thương hiệu này thuộc về
Có sắp xếp hay không
Điều kiện sử dụng riêng (T&C) của thương hiệu. Lưu ý: Bên cạnh T&C chung của Got It, một số thương sẽ có T&C riêng. Đối tác khi tích hợp hiển thị thông tin thương hiệu phải hiển thị trường này.
Examples
[
{
"brandId": 176,
"brandNm": "7eleven",
"brandImg": "https://img-stg.gotit.vn/compress/brand/1601629052_jxKZM.png",
"slug": "7eleven",
"shortDesc": null,
"description": "",
"categoryID": [],
"sort": 1,
"serviceGuide": null
},
{
"brandId": 1108,
"brandNm": "Al Fresco",
"brandImg": "https://img-stg.gotit.vn/",
"slug": "al-fresco",
"shortDesc": "",
"description": "",
"categoryID": [],
"sort": 1,
"serviceGuide": null
},
{
"brandId": 163,
"brandNm": "Bách Hóa Xanh",
"brandImg": "https://img-stg.gotit.vn/compress/brand/2020/06/1593161173_AmVgm.png",
"slug": "bach-hoa-xanh",
"shortDesc": "Bách Hóa Xanh",
"description": "Bách Hóa Xanh được đưa vào thử nghiệm cuối năm 2015, là chuỗi cửa hàng chuyên bán lẻ thực phẩm tươi sống (thịt cá, rau củ, trái cây…) và nhu yếu phẩm với hơn 1.000 siêu thị tại các tỉnh thành Miền Nam và Nam Trung Bộ. Bách Hoá Xanh cung cấp những sản phẩm thiết yếu hàng ngày tươi ngon, nguồn gốc rõ ràng, đa dạng về chủng loại; giá cả hợp lý so với chợ truyền thống và các cửa hàng nhỏ lẻ; trong một không gian sạch sẽ, thân thiện và tại những địa điểm dễ tiếp cận đối với người nội trợ.",
"categoryID": [
7
],
"sort": 1,
"serviceGuide": "<p>- Được áp dụng để thanh toán cho tất cả sản phẩm của Thế giới di động/ Điện máy xanh/ Bách hóa xanh/ Nhà thuốc An Khang.</p>\r\n\r\n<p>- Mã MWG chỉ có giá trị sử dụng một lần duy nhất, nhân viên MWG phải thực hiện kiểm tra mã và nhận thanh toán nếu mã hợp lệ khi KH xuất trình mã MWG có dấu hiệu nhận diện là logo Got It dưới bất kì hình thức nào (trên link, màn hình chụp điện thoại, in ra giấy..).</p>\r\n\r\n<p>- Được sử dụng thanh toán cho các sản phẩm đang được khuyến mãi, giảm giá.</p>\r\n\r\n<p>- Được sử dụng nhiều Mã MWG để thanh toán đồng thời và thanh toán chung với các hình thức thanh toán khác.</p>\r\n\r\n<p>- Vui lòng xem kỹ thời hạn sử dụng trên mã MWG, Got It không chịu trách nhiệm gia hạn thời gian sử dụng với bất kì lý do gì.</p>\r\n\r\n<p>- Vui lòng xuất trình mã MWG cho cashier/nhà cung cấp để thực hiện thanh toán. Không xuất trình mã MWG cho cashier/ nhà cung cấp khi khách hàng chưa chắc chắn sử dụng.</p>\r\n\r\n<p>- Mã MWG sẽ không được hoàn lại sau khi quy đổi từ mã Got It và không được bán lại.</p>\r\n\r\n<p>- Mã MWG không có giá trị quy đổi thành tiền mặt. Khách hàng có thể được yêu cầu trả thêm tiền nếu sử dụng quá giá trị của mã MWG.</p>\r\n\r\n<p>- Khách hàng có trách nhiệm bảo mật thông tin mã MWG sau khi đặt mua. Got It sẽ không chịu trách nhiệm hoàn trả các mã thẻ bị mất.</p>\r\n\r\n<p>- Got It không chịu trách nhiệm đối với chất lượng của sản phẩm hoặc dịch vụ được cung cấp cũng như đối với các tranh chấp về sau giữa khách hàng và nhà cung cấp.</p>\r\n\r\n<p>- Got It có quyền sửa chữa hoặc thay đổi điều khoản và điều kiện mà không thông báo trước.</p>"
},
]{CategoryID}Dùng để lấy danh sách toàn bộ thương hiệu trong một ngành hàng cụ thể.
Path variables
Mã số ngành hàng
Responses
Mảng chứa danh sách thương hiệu
Body
Mã thương hiệu
Tên thương hiệu
Logo thương hiệu
Mô tả ngắn về thương hiệu
Thông tin về thương hiệu
Sắp xếp hay không
Điều kiện sử dụng riêng (T&C) của thương hiệu. Lưu ý: Bên cạnh T&C chung của Got It, một số thương sẽ có T&C riêng. Đối tác khi tích hợp hiển thị thông tin thương hiệu phải hiển thị trường này.
Examples
[
{
"brandId": 209,
"brandNm": "Pizza Hut",
"brandImg": "https://img-stg.gotit.vn/compress/brand/2021/01/1611628245_fA5Tm.png",
"shortDesc": "",
"description": "",
"sort": 1,
"serviceGuide": null
},
{
"brandId": 63,
"brandNm": "Highlands Coffee",
"brandImg": "https://img-stg.gotit.vn/compress/brand/1507286551_cmUef.png",
"shortDesc": "CAFÉ & BÁNH NGỌT",
"description": "Được sinh ra từ niềm đam mê bất tận với hạt cà phê Việt Nam. Highlands Coffee đã không ngừng mang đến những sản phẩm cà phê thơm ngon, sánh đượm trong không gian thoải mái và lịch sự, dịch vụ chu đáo với mức giá phù hợp.",
"sort": 1,
"serviceGuide": "<p>Đặt hàng qua hotline: GIAO HÀNG MIỄN PHÍ trong bán kính 3km từ cửa hàng gần nhất.</p>"
},
{
"brandId": 1102,
"brandNm": "Starbucks",
"brandImg": "https://img-stg.gotit.vn/compress/brand/1614135218_YBY4U.png",
"shortDesc": "HCM",
"description": "HCM",
"sort": 1,
"serviceGuide": ""
}
]{brand_id}Lấy thông tin chi tiết của một thương hiệu
Path variables
Responses
Body
Mã số thương hiệu
Tên thương hiệu
Địa chỉ đầy đủ của trụ sở chính
Đường dẫn file Logo của thương hiệu
Điều kiện sử dụng riêng (T&C) của thương hiệu. Lưu ý: Bên cạnh T&C chung của Got It, một số thương sẽ có T&C riêng. Đối tác khi tích hợp hiển thị thông tin thương hiệu phải hiển thị trường này.
Danh sách cửa hàng của thương hiệu
Mã số cửa hàng
Tên cửa hàng
Địa chỉ đầy đủ của cửa hàng
Địa chỉ email đại diện cửa hàng
Số điện thoại của cửa hàng
Vị trí Lat trên bản đồ Google
Vị trí Long trên bản đồ Google
Tên thương hiệu
Mã số quận/huyện (định danh của Got It)
Tên quận/huyện
Mã số tỉnh/thành phố (định danh của Got It)
Tên tỉnh/thành phố
Examples
{
"brandId": 63,
"brandNm": "Highlands Coffee",
"brandAddr": "135/37/50 Nguyễn Hữu Cảnh, Q. Bình Thạnh, Tp.HCM",
"brandLogo": "https://img-stg.gotit.vn/compress/brand/1507286551_cmUef.png",
"serviceGuide": "<p>Đặt hàng qua hotline: GIAO HÀNG MIỄN PHÍ trong bán kính 3km từ cửa hàng gần nhất.</p>",
"stores": [
{
"storeId": 913,
"storeNm": "Diamond Plaza (HCM)",
"storeAddr": "34 Lê Duẩn, Phường Bến Nghé, Quận 1, Hồ Chí Minh",
"storeEm": "",
"storePh": "(028) 38220068",
"lat": 10.781063,
"long": 106.698442,
"brandNm": "Highlands Coffee",
"districtId": 1,
"districtNm": "Quận 1",
"cityId": 1,
"cityNm": "Hồ Chí Minh"
},
{
"storeId": 958,
"storeNm": "Pearl Plaza (HCM)",
"storeAddr": "561A Điện Biên Phủ, P.25, Q.Bình Thạnh, TP.HCM",
"storeEm": "",
"storePh": "(028) 35106688",
"lat": 10.800118,
"long": 106.718488,
"brandNm": "Highlands Coffee",
"districtId": 14,
"districtNm": "Bình Thạnh",
"cityId": 1,
"cityNm": "Hồ Chí Minh"
},
{
"storeId": 1101,
"storeNm": "Saigon Trade (HCM)",
"storeAddr": "37 Tôn Đức Thắng, P.Bến Nghé , Q.1, TP.HCM",
"storeEm": "",
"storePh": "(028) 39105689",
"lat": 10.784248,
"long": 106.703563,
"brandNm": "Highlands Coffee",
"districtId": 1,
"districtNm": "Quận 1",
"cityId": 1,
"cityNm": "Hồ Chí Minh"
},
{
"storeId": 1102,
"storeNm": "Opera (HCM)",
"storeAddr": "7 Công Trường Lam Sơn, P.Bến Nghé , Q.1, TP.HCM",
"storeEm": "",
"storePh": "(028) 38225017",
"lat": 10.776936,
"long": 106.703735,
"brandNm": "Highlands Coffee",
"districtId": 1,
"districtNm": "Quận 1",
"cityId": 1,
"cityNm": "Hồ Chí Minh"
}
]
}Dùng để lấy danh sách sản phẩm theo tiêu chí lựa chọn
Request body
Mệnh giá thấp nhất
Mệnh giá cao nhất
Mã số ngành hàng
Sắp xếp: ‘asc’ - tăng dần, ‘desc’ - giảm dần
Mã số thương hiệu
Tiêu chí phân trang
Kích thước trang, số lượng dòng dữ liệu trả về. Trường bắt buộc.
Mã số trang. Trường bắt buộc.
Tổng số trang. Chỉ có giá trị khi response trả về. Không cần truyển vào trong request.
Examples
{
"minPrice": 0,
"maxPrice": 0,
"CategoryId": 0,
"orderBy" : "asc",
"brandId" : 46,
"pagination": {
"pageSize": 1000,
"page": 1,
"pageTotal" : 0
}
}Responses
Body
Mảng chứa danh sách sản phẩm
Mã sản phẩm
Tên sản phẩm
Link đến hình ảnh sản phẩm
Mã số thương hiệu
Tên thương hiệu
Logo thương hiệu
Điều kiện sử dụng riêng (T&C) của thương hiệu. Lưu ý: Bên cạnh T&C chung của Got It, một số thương sẽ có T&C riêng. Đối tác khi tích hợp hiển thị thông tin thương hiệu phải hiển thị trường này.
Mã ngành hàng của thương hiệu
Tên ngành hàng của thương hiệu
Loại sản phẩm. Có 2 loại chính: c (cash/mệnh giá tiền mặt thanh toán) hoặc i (item/quy đổi sản phẩm)
Mảng chứa tất cả mệnh giá của sản phẩm
Mã số mệnh giá / kích thước sản phẩm
Tên mệnh giá/ kích thước sản phẩm
Mệnh giá
Link xem thông tin sản phẩm
Mảng chứa tất cả thông tin cửa hàng có thể sử dụng voucher
Mã số cửa hàng
Tên cửa hàng
Địa chỉ cửa hàng
Số Lat trên bản đồ Google
Số Long trên bản đồ Google
Số điện thoại của cửa hàng
Mã thành phố
Tên tỉnh/thành phố của địa chỉ cửa hàng
Mã quận/huyện
Tên quận/huyện của địa chỉ cửa hàng
Thông tin phân trang
Kích thước trang, số lượng dòng dữ liệu trả về. Trường bắt buộc.
Mã số trang. Trường bắt buộc.
Tổng số trang. Chỉ có giá trị khi response trả về. Không cần truyển vào trong request.
Dùng để lấy thông tin chi tiết của 1 sản phẩm
Request body
Mã số sản phẩm
Thông số phân trang cho cửa hàng
Số phần tử 1 trang
Số thứ tự trang cần lấy
Examples
{
"productId": 1408
}Responses
Trả về thông tin chi tiết sản phẩm
Body
Mã số sản phẩm
Tên sản phẩm
Link đến hình ảnh sản phẩm
Mảng chứa danh sách các link hình ảnh khác của sản phẩm
Mã số thương hiệu
Tên thương hiệu
Loại sản phẩm. Có 2 loại chính: c (cash/mệnh giá tiền mặt thanh toán) hoặc i (item/quy đổi sản phẩm)
Tên thương hiệu trên URL
Số điện thoại liên hệ của thương hiệu
Địa chỉ kinh doanh của thương hiệu
Mô tả thương hiệu
Điều kiện sử dụng riêng (T&C) của thương hiệu. Lưu ý: Bên cạnh T&C chung của Got It, một số thương sẽ có T&C riêng. Đối tác khi tích hợp hiển thị thông tin thương hiệu phải hiển thị trường này.
Điều kiện áp dụng chung của voucher Got It
Logo thương hiệu
Link xem thông tin chi tiết sản phẩm
Mảng chứa tất cả mệnh giá của sản phẩm
Mã số mệnh giá / kích thước sản phẩm
Tên mệnh giá/ kích thước sản phẩm
Mệnh giá
Tên sản phẩm trên URL
Mô tả chi tiết sản phẩm
Mô tả ngắn về sản phẩm
Điều khoản sử dụng
Mã thương hiệu
Mảng chứa tất cả thông tin cửa hàng có thể sử dụng voucher
Mã số cửa hàng
Tên cửa hàng
Địa chỉ cửa hàng
Số Lat trên bản đồ Google
Số Long trên bản đồ Google
Số điện thoại của cửa hàng
Mã tỉnh/thành phố
Tên tỉnh/thành phố của địa chỉ cửa hàng
Mã quận/huyện
Tên quận/huyện của địa chỉ cửa hàng
Thương hiệu của cửa hàng
Tên thương hiệu
Mã thương hiệu
Link hình ảnh logo thương hiệu
Mã ngành hàng của thương hiệu
Danh sách thương hiệu chấp nhận voucher
Mã thương hiệu
Tên thương hiệu
Link Logo thương hiệu
Tên URL của thương hiệu
Số điện thoại thương hiệu
Địa chỉ thương hiệu
Mô tả thương hiệu
Điều khoản và điều kiện sử dụng của thương hiệu
Mã ngành hàng của thương hiệu
Số lượng cửa hàng chấp nhận sử dụng voucher của sản phẩm này.
Số lượng trang được tính trên pageSize mà đối tác truyền qua. Mặc định là 1.
Danh sách API dùng để phát hành và kiểm tra thông tin voucher.
Giao dịch phát hành voucher (chỉ trả về kết quả cho khách hàng, không gửi đến người dùng cuối)
Request headers
Request body
Mã số sản phẩm.
Mã số mệnh giá sản phẩm. Trong mỗi sản phẩm sẽ chứa 1 hoặc nhiều mã số mệnh giá tương ứng với giá trị hoặc kích thước sản phẩm quy đổi.
Số lượng voucher cần phát hành
Tên campaign. Không đặt theo tên người nhận voucher hoặc nội dung thay đổi hằng ngày, thường xuyên. Cú pháp: “Tên riêng do khách hàng quy định” + [Tháng] + [Năm] (vd: “Got It Promotion - Jul 2019”)
Ngày hết hạn voucher. Cú pháp “YYYY-MM-DD”. Ngày hết hạn được quy định trong hợp đồng giữa đối tác với Got It. Thông thường là 3 tháng tính từ ngày phát hành. Khách hàng tự tính toán và truyền thông tin ngày hết hạn hợp lý.
Mã số duy nhất định danh giao dịch của phía khách hàng, dùng để đối chiếu, đối soát.
Yêu cầu bảo mật voucher. = 1 nếu yêu cầu phải nhập mật khẩu thì mới được xem voucher
Loại hình bảo mật voucher. Gồm các loại sau:
1: nếu OTP được gửi qua số điện thoại
7: nếu OTP được gửi qua email
8: nếu mật khẩu là 1 số cố định - được truyền vào ở phía dưới
Truyền vào mật khẩu cố định(tương ứng với otp_type = 8 đã truyền vào ở trường phía trên). Yêu cầu: 6 số liên tục.
Tên người nhận voucher
Số điện thoại cũng được dùng để nhận OTP khi end-user mở voucher link, tương ứng otp_type = 1 ở trên. Yêu cầu: 10 số liền nhau.
Địa chỉ email được dùng để nhận OTP khi end-user mở voucher link, tương ứng otp_type = 7 ở trên.
Chữ ký điện tử. Dành cho trường hợp khách hàng muốn xác thực thông tin API.
Ngày bắt đầu hiệu lực của voucher, ngày này phải lớn hơn ngày tạo và format là “YYYY-MM-DD”. Lưu ý: trước ngày này thì voucher sẽ ở trạng thái Inactive và không thể sử dụng.
Examples
{
"productId": 1,
"productPriceId": 1,
"quantity": 1,
"campaignNm": "Client Order Jul 2019",
"expiryDate": "2019-12-31",
"voucherRefId": "XYZ1020199",
"use_otp":1,
"otp_type":1,
"receiver_name":"Sơn Trần",
"phone":"0909992044"
}Responses
Body
Chính là tên campaign (campaignNm) phía trên do khách hàng tự đặt
Mảng chứa danh sách thông tin các voucher mà đối tác yêu cầu phát hành
Mã số voucher gồm 10 số và là duy nhất không trùng lắp với bất cứ voucher nào khác. Các voucher sử dụng phương thức bảo mật OTP/password thì voucherCode=null.
Link của voucher. Để hiển thị voucher trên trình duyệt
Mã link của voucher gồm 8 ký tự và là duy nhất không trùng lắp với bất cứ voucher nào khác.
Link của hình ảnh voucher. Để hiển thị voucher dưới dạng hình ảnh.
Mã định danh giao dịch do phía đối tác truyền vào ở request.
Ngày hết hạn voucher.
Thông tin sản phẩm của voucher
Mã sản phẩm
Tên sản phẩm
Link đến hình ảnh sản phẩm
Mã số thương hiệu
Tên thương hiệu
Điều kiện sử dụng riêng (T&C) của thương hiệu. Lưu ý: Bên cạnh T&C chung của Got It, một số thương sẽ có T&C riêng. Đối tác khi tích hợp hiển thị thông tin thương hiệu phải hiển thị trường này.
Link dẫn đến thông tin sản phẩm
Mệnh giá của sản phẩm/voucher
Mã số mệnh giá / kích thước sản phẩm
Tên mệnh giá/ kích thước sản phẩm
Mệnh giá
Mô tả sản phẩm
Điều khoản sử dụng
Loại sản phẩm. Có 2 loại chính: c (cash/mệnh giá tiền mặt thanh toán) hoặc i (item/quy đổi sản phẩm)
Examples
[
{
"refId": "Testing",
"invoiceNo": "00000000000",
"vouchers": [
{
"voucherCode": "3266741203",
"voucherLink": "https://v-stg.gotit.vn/RY1Cjib2",
"voucherLinkCode": "RY1Cjib2",
"voucherImageLink": "https://v-stg.gotit.vn/save-voucher/vi/eyJpdiI6ImJPUmtBelFcLzNTNWxIcmZNK01oMDR3PT0iLCJ2YWx1ZSI6InlFNTZGZW1IKzRMNzV1M0dFbTluTnhCTG5nZkIxVkRyb2NKb3hvbFQxeUI1U0FNdkp5VjlWeEpJQUEzNHJRV2ciLCJtYWMiOiI0YjIxMGNjNWRlYzVlNzE3NjNiODA1YzQ2NzFjNjRiZWJmZTYyNzYxOGM3MjFjYWI4MjUzMWVmMzZmZjM5ZThiIn0=",
"voucherRefId": "API-testing",
"expiryDate": "2021-12-31",
"product": {
"productId": 1408,
"productNm": "Quà tặng Got It (new)",
"productImg": "https://img-stg.gotit.vn/compress/580x580/2018/02/1518432100_go0gN.png",
"brandId": 46,
"brandNm": "Got It",
"brandServiceGuide": null,
"link": "https://v-stg.gotit.vn/got-it-da-nang/got-it/qua-tang-got-it-new-1408.html",
"size": {
"sizeId": 2756,
"priceNm": "1",
"pricePrice": 30000
},
"productDesc": "<p>Quà Tặng Got It được sử dụng dễ dàng tại các cửa hàng thuộc hệ thống đối tác của Got It. </p>\n\n<p>Cùng Got It thể hiện sự quan tâm với những món quà đa dạng, chất lượng từ các thương hiệu uy tín.</p>\n\n<p>Quà Tặng Got It được áp dụng đồng thời chương trình khuyến mãi tại:</p>\n\n<p>- Highlands Coffee, Ding Tea, Beard Papa's, Smoothie Factory, BreadTalk, The Sushi Bar, ThaiExpress, Ngõ-Restaurant, Shabu Ya, Spice Temple, SumoBBQ, GoGi House, Kichi Kichi, Daruma, Ashima, iSushi, Ba Con Cừu, Osaka Osho, Itacho Ramen, Vuvuzela, K-Pub, Crystal Jade Kitchen, Cowboy's Jack, City Beer Station, Manwah, Hutong, Phố Ngon 37, Kintaro Udon, Magic Pan, Sừng Quăn, iCook, Shogun, Hoàng Yến Buffet, Hoàng Yến Buffet Premier, Hoàng Yến Hot Pot, Stix, Taka, John Henry, Aino Sofia, Freelancer, Vera, Wow, Jockey, Ministop, 3Sach Food, Yves Rocher France, Lock&Lock, Plus One.</p>\n\n<p>- Tous les Jours: áp dụng ưu đãi, không áp dụng khuyến mãi.</p>\n\n<p>- Baskin Robbins: không áp dụng khuyến mãi vào các ngày Lễ, Tết.</p>\n\n<p>- Shop&Go: áp dụng tất cả sản phẩm, ngoại trừ Phone Card/ Payoo/ Thuốc Lá/ Rượu.</p>\n\n<p>- Ministop: áp dụng tất cả sản phẩm, trừ các sản phẩm của bên thứ 3.</p>\n\n<p>Quà Tặng Got It không được áp dụng khuyến mãi tại:</p>\n\n<p>- Phúc Long, Catherine Denoual Maison, Glow Sky Bar, Urban Kitchen Bar, Shooz, Geox.</p>\n\n<p>Sử dụng tại Lotte Mart, vui lòng lưu ý:</p>\n\n<p>- Mỗi eGift chỉ sử dụng được 1 lần. Được áp dụng nhiều eGift trên một hoá đơn nhưng không áp dụng quá 10 eGift (không phân biệt mệnh giá). Vui lòng tách hoá đơn nếu muốn sử dụng nhiều hơn 10 eGift.</p>\n\n<p>- Lotte Mart không nhận trả hàng, không hủy hóa đơn và không hoàn tiền cho những hóa đơn thanh toán bằng Got It eGift.</p>\n\n<p>- Lotte Mart không hoàn lại tiền thừa chênh lệch giữa mệnh giá eGift và giá trị hóa đơn.</p>\n\n<p>- Lotte Mart không xuất hóa đơn cho những hóa đơn thanh toán bằng Got It, kể cả với các hình thức thanh toán khác như tiền mặt, thẻ ngân hàng....</p>\n\n<p>- Trong trường hợp khách hàng muốn xuất hóa đơn cho phần thanh toán bằng các hình thức khác vui lòng báo trước cho thu ngân để xuất hóa đơn riêng. Mọi trường hợp xuất chung hóa đơn với hóa đơn thanh toán bằng Got It eGift , Lotte Mart sẽ từ chối giải quyết.</p>\n",
"terms": "<p>- eGift chỉ có giá trị sử dụng một lần.</p>\n\n<p>- Được áp dung nhiều eGift trên cùng một hóa đơn.</p>\n\n<p>- Vui lòng xem kỹ thời hạn sử dụng trên eGift.</p>\n\n<p>- Vui lòng xuất trình eGift cho cashier/nhà cung cấp để thực hiện quy đổi. Không xuất trình eGift cho cashier/ nhà cung cấp khi khách hàng chưa chắc chắn sử dụng.</p>\n\n<p>- eGift chỉ được sử dụng cho sản phẩm hoặc dịch vụ cụ thể được thể hiện trên eGift. Trong trường hợp sản phẩm hoặc dịch vụ này đã hết hàng, người nhận có thể lựa chọn sản phẩm hoặc dịch vụ khác có cùng giá trị.</p>\n\n<p>- eGift đã mua sẽ không được hoàn lại tiền, và không được bán lại.</p>\n\n<p>- eGift không có giá trị quy đổi thành tiền mặt. Khách hàng có thể được yêu cầu trả thêm tiền nếu sử dụng quá giá trị của eGift.</p>\n\n<p>- Khách hàng có trách nhiệm bảo mật thông tin mã thẻ quà tặng sau khi đặt mua. Got It sẽ không chịu trách nhiệm hoàn trả các mã thẻ bị mất hoặc ở trạng thái “Đã sử dụng” với bất kì lý do gì.</p>\n\n<p>- Got It không chịu trách nhiệm đối với chất lượng của sản phẩm hoặc dịch vụ được cung cấp cũng như đối với các tranh chấp về sau giữa khách hàng và nhà cung cấp.</p>\n\n<p>- Got It có quyền sửa chữa hoặc thay đổi điều khoản và điều kiện mà không thông báo trước.</p>\n",
"productType": "c"
}
},
{
"voucherCode": "5642068467",
"voucherLink": "https://v-stg.gotit.vn/p6tKvacs",
"voucherLinkCode": "p6tKvacs",
"voucherImageLink": "https://v-stg.gotit.vn/save-voucher/vi/eyJpdiI6IjdoNVlJXC9LSUxDYTBVbzVZU0YzVUV3PT0iLCJ2YWx1ZSI6IkJ0bGZ3Q3ZROUZORDJ5UEZ6NkY4djNWZFRkK2YyN3V4ZU1kNVpFSEtaMjZxNnpXMU9IbzRwRzJEaXN1SExuSUkiLCJtYWMiOiIxMmNhOGQxYzMyZDY0MjZiYThjNTY4YWQwZGRlNGI0Nzk1NzBhMGMxNGYzOTc2NWQ5ODU2OTRkMzhjMzMxZDczIn0=",
"voucherRefId": "API-testing",
"expiryDate": "2021-12-31",
"product": {
"productId": 1408,
"productNm": "Quà tặng Got It (new)",
"productImg": "https://img-stg.gotit.vn/compress/580x580/2018/02/1518432100_go0gN.png",
"brandId": 46,
"brandNm": "Got It",
"brandServiceGuide": null,
"link": "https://v-stg.gotit.vn/got-it-da-nang/got-it/qua-tang-got-it-new-1408.html",
"size": {
"sizeId": 2756,
"priceNm": "1",
"pricePrice": 30000
},
"productDesc": "<p>Quà Tặng Got It được sử dụng dễ dàng tại các cửa hàng thuộc hệ thống đối tác của Got It. </p>\n\n<p>Cùng Got It thể hiện sự quan tâm với những món quà đa dạng, chất lượng từ các thương hiệu uy tín.</p>\n\n<p>Quà Tặng Got It được áp dụng đồng thời chương trình khuyến mãi tại:</p>\n\n<p>- Highlands Coffee, Ding Tea, Beard Papa's, Smoothie Factory, BreadTalk, The Sushi Bar, ThaiExpress, Ngõ-Restaurant, Shabu Ya, Spice Temple, SumoBBQ, GoGi House, Kichi Kichi, Daruma, Ashima, iSushi, Ba Con Cừu, Osaka Osho, Itacho Ramen, Vuvuzela, K-Pub, Crystal Jade Kitchen, Cowboy's Jack, City Beer Station, Manwah, Hutong, Phố Ngon 37, Kintaro Udon, Magic Pan, Sừng Quăn, iCook, Shogun, Hoàng Yến Buffet, Hoàng Yến Buffet Premier, Hoàng Yến Hot Pot, Stix, Taka, John Henry, Aino Sofia, Freelancer, Vera, Wow, Jockey, Ministop, 3Sach Food, Yves Rocher France, Lock&Lock, Plus One.</p>\n\n<p>- Tous les Jours: áp dụng ưu đãi, không áp dụng khuyến mãi.</p>\n\n<p>- Baskin Robbins: không áp dụng khuyến mãi vào các ngày Lễ, Tết.</p>\n\n<p>- Shop&Go: áp dụng tất cả sản phẩm, ngoại trừ Phone Card/ Payoo/ Thuốc Lá/ Rượu.</p>\n\n<p>- Ministop: áp dụng tất cả sản phẩm, trừ các sản phẩm của bên thứ 3.</p>\n\n<p>Quà Tặng Got It không được áp dụng khuyến mãi tại:</p>\n\n<p>- Phúc Long, Catherine Denoual Maison, Glow Sky Bar, Urban Kitchen Bar, Shooz, Geox.</p>\n\n<p>Sử dụng tại Lotte Mart, vui lòng lưu ý:</p>\n\n<p>- Mỗi eGift chỉ sử dụng được 1 lần. Được áp dụng nhiều eGift trên một hoá đơn nhưng không áp dụng quá 10 eGift (không phân biệt mệnh giá). Vui lòng tách hoá đơn nếu muốn sử dụng nhiều hơn 10 eGift.</p>\n\n<p>- Lotte Mart không nhận trả hàng, không hủy hóa đơn và không hoàn tiền cho những hóa đơn thanh toán bằng Got It eGift.</p>\n\n<p>- Lotte Mart không hoàn lại tiền thừa chênh lệch giữa mệnh giá eGift và giá trị hóa đơn.</p>\n\n<p>- Lotte Mart không xuất hóa đơn cho những hóa đơn thanh toán bằng Got It, kể cả với các hình thức thanh toán khác như tiền mặt, thẻ ngân hàng....</p>\n\n<p>- Trong trường hợp khách hàng muốn xuất hóa đơn cho phần thanh toán bằng các hình thức khác vui lòng báo trước cho thu ngân để xuất hóa đơn riêng. Mọi trường hợp xuất chung hóa đơn với hóa đơn thanh toán bằng Got It eGift , Lotte Mart sẽ từ chối giải quyết.</p>\n",
"terms": "<p>- eGift chỉ có giá trị sử dụng một lần.</p>\n\n<p>- Được áp dung nhiều eGift trên cùng một hóa đơn.</p>\n\n<p>- Vui lòng xem kỹ thời hạn sử dụng trên eGift.</p>\n\n<p>- Vui lòng xuất trình eGift cho cashier/nhà cung cấp để thực hiện quy đổi. Không xuất trình eGift cho cashier/ nhà cung cấp khi khách hàng chưa chắc chắn sử dụng.</p>\n\n<p>- eGift chỉ được sử dụng cho sản phẩm hoặc dịch vụ cụ thể được thể hiện trên eGift. Trong trường hợp sản phẩm hoặc dịch vụ này đã hết hàng, người nhận có thể lựa chọn sản phẩm hoặc dịch vụ khác có cùng giá trị.</p>\n\n<p>- eGift đã mua sẽ không được hoàn lại tiền, và không được bán lại.</p>\n\n<p>- eGift không có giá trị quy đổi thành tiền mặt. Khách hàng có thể được yêu cầu trả thêm tiền nếu sử dụng quá giá trị của eGift.</p>\n\n<p>- Khách hàng có trách nhiệm bảo mật thông tin mã thẻ quà tặng sau khi đặt mua. Got It sẽ không chịu trách nhiệm hoàn trả các mã thẻ bị mất hoặc ở trạng thái “Đã sử dụng” với bất kì lý do gì.</p>\n\n<p>- Got It không chịu trách nhiệm đối với chất lượng của sản phẩm hoặc dịch vụ được cung cấp cũng như đối với các tranh chấp về sau giữa khách hàng và nhà cung cấp.</p>\n\n<p>- Got It có quyền sửa chữa hoặc thay đổi điều khoản và điều kiện mà không thông báo trước.</p>\n",
"productType": "c"
}
}
]
}
]Dùng để kiểm tra thông tin voucher với VoucherRefId
Request body
Voucher Ref Id đã truyền khi yêu cầu phát hành voucher
Examples
{
"voucherRefId": "XYZ1020199"
}Responses
Body
Chính là tên campaign khách hàng đã đặt khi gọi hàm /transaction
Thông tin voucher tương ứng với voucherRefID mà khách hàng đã truyền ở request.
Mã số voucher gồm 10 số và là duy nhất không trùng lắp với bất cứ voucher nào khác
Link của voucher. Để hiển thị voucher trên trình duyệt
Link của hình ảnh voucher. Để hiển thị voucher dưới dạng hình ảnh.
Mã định danh giao dịch do phía đối tác truyền vào ở request.
Ngày hết hạn voucher.
Mã trạng thái hiện tại của voucher. Có các trạng thái sau:
1: New - Chưa sử dụng
2: Sent - Đã gửi cho khách hàng qua sms hoặc email bởi Got It và chưa được sử dụng
3: Opened - Khách hàng đã mở link voucher và chưa được sử dụng
4: Used - Đã sử dụng.
8: Expired - Đã hết hạn.
9: Canceled - Đã hủy
Tên trạng thái hiện tại của voucher tương ứng với stateCode
Tên và địa chỉ cửa hàng đã sử dụng voucher (trường hợp voucher đã được sử dụng).
Thời gian sử dụng voucher (trường hợp voucher đã được sử dụng). Định dạng YYYY-MM-DD HH:MM:SS
Thương hiệu của cửa hàng sử dụng voucher (trường hợp voucher đã được sử dụng)
Thông tin sản phẩm của voucher
Mã sản phẩm
Tên sản phẩm
Link đến hình ảnh sản phẩm
Mã số thương hiệu
Tên thương hiệu
Điều kiện sử dụng riêng (T&C) của thương hiệu. Lưu ý: Bên cạnh T&C chung của Got It, một số thương sẽ có T&C riêng. Đối tác khi tích hợp hiển thị thông tin thương hiệu phải hiển thị trường này.
Mệnh giá của sản phẩm/voucher
Mã số mệnh giá / kích thước sản phẩm
Tên mệnh giá/ kích thước sản phẩm
Mệnh giá
Mô tả sản phẩm
Điều khoản sử dụng
Mảng chứa tất cả thông tin cửa hàng có thể sử dụng voucher
Mã số cửa hàng
Tên cửa hàng
Địa chỉ cửa hàng
Số Lat trên bản đồ Google
Số Long trên bản đồ Google
Examples
{
"refId": "xxx00002436",
"invoiceNo": "0000000000",
"voucher": {
"voucherCode": "0575754416",
"voucherLink": "https://v-stg.gotit.vn/xLhrk3453453",
"voucherImageLink": "https://v-stg.gotit.vn/save-voucher/vi/eyJpdiI6IlZnRFFZWHNUWjZnd1VLUkJMK0xVc3c9PSIsInZhbHVlIjoid1FZcnQzakdcL3JCdWxXMVk5M2NcL1BVQ3k0QktKUTUrWVRlelJ3VnQrSDRVM2tZYXpnaEpWS3pmOXFwRXFnQUdzYTkzR1...........",
"voucherRefId": "xxx00002436",
"expiryDate": "2019-11-12",
"stateCode": 1,
"stateText": "New",
"used_store": [],
"used_time": "",
"used_brand": "",
"product": {
"productId": 1408,
"productNm": "Quà tặng Got It (new)",
"productImg": "https://img.gotit.vn/compress/580x580/2018/02/1518432100_go0gN.png",
"brandId": 46,
"brandNm": "Got It",
"size": {
"sizeId": 2710,
"priceNm": "1",
"pricePrice": 50000
},
"productDesc": "<p>Quà Tặng Got It được sử dụng dễ dàng tại các cửa hàng thuộc hệ thống đối tác của Got It. </p>\n\n<p>Cùng Got It thể hiện sự quan tâm với những món quà ...........",
"terms": "<p>- eGift chỉ có giá trị sử dụng một lần.</p>\r\n\r\n<p>- Được áp dung nhiều eGift trên cùng một hóa đơn.</p>\r\n\r\n<p>- Vui lòng xem kỹ thời hạn sử dụng trên eGift.</p>\r\n\r\n<p>..............",
"storeList": [
{
"storeId": 38,
"storeNm": "Glow Sky Bar (HCM)",
"storeAddr": "Tầng thượng President Place, 93 Nguyễn Du, P Bến Nghé, Q1, TPHCM",
"lat": 10.77688,
"long": 106.698281
},
{
"storeId": 56,
"storeNm": "Urban Kitchen + Bar (HCM)",
"storeAddr": "18 Ngô Văn Năm, P Bến Nghé, Q1, TPHCM",
"lat": 10.781089,
"long": 106.706435
},
{
"storeId": 1647,
"storeNm": "Mandarin (HN)",
"storeAddr": "Tầng 1, Khu nhà D, Hoàng Minh Giám, P.Trung Hòa, Q.Cầu Giấy, HN",
"lat": 0,
"long": 0
},
.......................
]
}
}
}Giao dịch phát hành nhiều voucher cùng lúc. Dữ liệu trả về sẽ là group link đại diện cho những voucher con bên trong.
Request body
Mã số sản phẩm.
Mã số mệnh giá sản phẩm. Trong mỗi sản phẩm sẽ chứa 1 hoặc nhiều mã số mệnh giá tương ứng với giá trị hoặc kích thước sản phẩm quy đổi.
Số lượng voucher cần phát hành tương ứng với mệnh giá (productPriceID) phía trên.
Tên campaign. Không đặt theo tên người nhận voucher hoặc nội dung thay đổi hằng ngày, thường xuyên. Cú pháp: “Tên riêng do khách hàng quy định” + [Tháng] + [Năm] (vd: “Got It Promotion - Jul 2019”)
Ngày hết hạn voucher. Cú pháp “YYYY-MM-DD”. Ngày hết hạn được quy định trong hợp đồng giữa đối tác với Got It. Thông thường là 3 tháng tính từ ngày phát hành. Khách hàng tự tính toán và truyền thông tin ngày hết hạn hợp lý.
Mã số duy nhất định danh giao dịch của phía khách hàng, dùng để đối chiếu, đối soát.
Yêu cầu bảo mật voucher. = 1 nếu yêu cầu phải nhập mật khẩu thì mới được xem voucher
Loại hình bảo mật voucher. Gồm các loại sau:
1: nếu OTP được gửi qua số điện thoại
7: nếu OTP được gửi qua email
8: nếu mật khẩu là 1 số cố định - được truyền vào ở phía dưới
Truyền vào mật khẩu cố định(tương ứng với otp_type = 8 đã truyền vào ở trường phía trên). Yêu cầu: 6 số liên tục.
Tên người nhận voucher
Số điện thoại cũng được dùng để nhận OTP khi end-user mở voucher link, tương ứng otp_type = 1 ở trên. Yêu cầu: 10 số liền nhau.
Địa chỉ email được dùng để nhận OTP khi end-user mở voucher link, tương ứng otp_type = 7 ở trên.
Chữ ký điện tử. Dành cho trường hợp khách hàng muốn xác thực thông tin API.
Examples
{
"productId": 1,
"productPriceId": 1,
"quantity": 1,
"campaignNm": "Client Order Jul 2019",
"expiryDate": "2019-12-31",
"voucherRefId": "XYZ1020199",
"use_otp":1,
"otp_type":1,
"receiver_name":"Sơn Trần",
"phone":"0909992044"
}Responses
Body
Mã đơn hàng phát hành voucher
Chính là tên campaign (campaignNm) phía trên do khách hàng tự đặt
Thông tin của group voucher
Link của group voucher
8 ký tự cuối của link
Mảng chứa danh sách thông tin các voucher mà đối tác yêu cầu phát hành
Link của hình ảnh voucher. Để hiển thị voucher dưới dạng hình ảnh.
Link của voucher. Để hiển thị voucher trên trình duyệt
Mã số voucher gồm 10 số và là duy nhất không trùng lắp với bất cứ voucher nào khác
Mã sản phẩm
Mã mệnh giá
Mệnh giá
Ngày hết hạn voucher.
Examples
{
"refId": "Campaign AAA - Jul 2021",
"invoiceNo": "00000000000",
"groupVouchers": {
"voucherLink": "https://g-stg.gotit.vn/LuEBiKeH",
"voucherLinkCode": "LuEBiKeH"
},
"vouchers": [
{
"product_image": "https://img.gotit.vn/compress/580x580/2018/02/1518432100_go0gN.png",
"link": "https://v-stg.gotit.vn/J2emG6Hq",
"code": "5351368627",
"product_id": "1408",
"price_id": "2710",
"value": 50000,
"expired_date": "2020-12-31"
},
{
"product_image": "https://img.gotit.vn/compress/580x580/2018/02/1518432100_go0gN.png",
"link": "https://v-stg.gotit.vn/FQkVcR63",
"code": "3139798533",
"product_id": "1408",
"price_id": "2711",
"value": 100000,
"expired_date": "2020-12-31"
},
{
"product_image": "https://img.gotit.vn/compress/580x580/2018/02/1518432100_go0gN.png",
"link": "https://v-stg.gotit.vn/5cHePrRz",
"code": "8699773908",
"product_id": "1408",
"price_id": "2711",
"value": 100000,
"expired_date": "2020-12-31"
}
]
}Dùng để kiểm tra thông tin các voucher với cùng VoucherRefId (cho trường hợp phát hành group voucher bằng hàm /transactiongroup)
Request body
Voucher Ref Id đã truyền khi yêu cầu phát hành voucher
Examples
{
"voucherRefId": "XYZ1020199"
}Responses
Body
Examples
{
"refId": "xxx00002436",
"invoiceNo": "0000000000",
"voucher": {
"voucherCode": "0575754416",
"voucherLink": "https://v-stg.gotit.vn/xLhrk3453453",
"voucherImageLink": "https://v-stg.gotit.vn/save-voucher/vi/eyJpdiI6IlZnRFFZWHNUWjZnd1VLUkJMK0xVc3c9PSIsInZhbHVlIjoid1FZcnQzakdcL3JCdWxXMVk5M2NcL1BVQ3k0QktKUTUrWVRlelJ3VnQrSDRVM2tZYXpnaEpWS3pmOXFwRXFnQUdzYTkzR1...........",
"voucherRefId": "xxx00002436",
"expiryDate": "2019-11-12",
"stateCode": 1,
"stateText": "New",
"used_store": [],
"used_time": "",
"used_brand": "",
"product": {
"productId": 1408,
"productNm": "Quà tặng Got It (new)",
"productImg": "https://img.gotit.vn/compress/580x580/2018/02/1518432100_go0gN.png",
"brandId": 46,
"brandNm": "Got It",
"size": {
"sizeId": 2710,
"priceNm": "1",
"pricePrice": 50000
},
"productDesc": "<p>Quà Tặng Got It được sử dụng dễ dàng tại các cửa hàng thuộc hệ thống đối tác của Got It. </p>\n\n<p>Cùng Got It thể hiện sự quan tâm với những món quà ...........",
"terms": "<p>- eGift chỉ có giá trị sử dụng một lần.</p>\r\n\r\n<p>- Được áp dung nhiều eGift trên cùng một hóa đơn.</p>\r\n\r\n<p>- Vui lòng xem kỹ thời hạn sử dụng trên eGift.</p>\r\n\r\n<p>..............",
"storeList": [
{
"storeId": 38,
"storeNm": "Glow Sky Bar (HCM)",
"storeAddr": "Tầng thượng President Place, 93 Nguyễn Du, P Bến Nghé, Q1, TPHCM",
"lat": 10.77688,
"long": 106.698281
},
{
"storeId": 56,
"storeNm": "Urban Kitchen + Bar (HCM)",
"storeAddr": "18 Ngô Văn Năm, P Bến Nghé, Q1, TPHCM",
"lat": 10.781089,
"long": 106.706435
},
{
"storeId": 1647,
"storeNm": "Mandarin (HN)",
"storeAddr": "Tầng 1, Khu nhà D, Hoàng Minh Giám, P.Trung Hòa, Q.Cầu Giấy, HN",
"lat": 0,
"long": 0
},
.......................
]
}
}
}Dùng để gửi voucher đến người dùng cuối
Gửi thông tin voucher đến Email người dùng cuối
Request body
8 ký tự cuối của link voucher
Địa chỉ email người dùng cuối
Tên người nhận (người dùng cuối)
Tên người gửi
Nội dung lời nhắn
Examples
{
"voucherLinkCode": "abcde123",
"email": "sontran@dayone.vn",
"receiverNm": "Son Tran",
"senderNm": "Got It",
"message": "Have a good day"
}Responses
Lệnh gửi thành công
Body
Trạng thái lệnh gửi. Nếu thành công sẽ nhận: stt = 1
Lệnh gửi đã thất bại
Body
Mã số lỗi
Thông báo lỗi
Gửi SMS thông tin voucher đến người dùng cuối.
Đối tác cần cung cấp nội dung SMS để Got It tiến hành đăng ký với nhà cung cấp dịch vụ SMS và cấu hình trước vào tài khoản đối tác.
Request body
8 ký tự cuối của link voucher
Số điện thoại người nhận (cú pháp: 09xxxx, 012… số điện thoại 10 hoặc 11 số, không có +84 ở đầu)
Tên người nhận (người dùng cuối)
Tên người gửi
Examples
{
"voucherLinkCode": "abcde123",
"phoneNo": "0909123456",
"receiverNm": "Son Tran",
"senderNm": "Got It"
}Responses
Lệnh gửi thành công
Body
Trạng thái lệnh gửi. Nếu thành công sẽ nhận: stt = 1
Lệnh gửi thất bại
Body
Mã số lỗi
Thông báo lỗi
Lưu ý: Trong lúc tích hợp có thể xuất hiện 1 số mã lỗi không xuất hiện trong danh sách mã lỗi ở đây.
API Key Related 00XX
Lỗi liên quan đến API Key
| Code | Message | Description |
|---|---|---|
| 0001 | API Key is empty | Thiếu API Key |
| 0002 | API Key is not valid | API Key không đúng |
Parameter Related 10XX
Lỗi liên quan đến cú pháp tham số truyền vào
| Code | Message | Description |
|---|---|---|
| 1010 | The expiry date is not valid. The format must be “yyyy-mm-dd” and not exceed the specified expiry period of this account. | Ngày hết hạn voucher không hợp lệ hoặc không đúng format “yyyy-mm-dd” |
| 1011 | Product ID or ProductPriceID or Quantity or Expiry date is missing | Thiếu một trong các tham số Product Id, Price Id, Số lượng voucher hoặc Ngày hết hạn |
| 1012 | Price ID does not match with this product | Price Id không đúng /không phù hợp với sản phẩm |
| 1013 | Pagination or PageSize or page was missing | Tham số phân trang không đúng |
| 1015 | Active date is not valid | Ngày kích hoạt không khả dụng |
Value Related 20XX
Lỗi liên quan đến giá trị tham số
| Code | Message | Description |
|---|---|---|
| 2001 | Product ID is not valid | Thiếu Product Id hoặc Product Id không đúng |
| 2002 | Category ID is not valid | Thiếu Category Id hoặc Category Id |
| 2004 | Voucher code is not valid | Voucher code không đúng |
| 2005 | Email is not valid | Địa chỉ email người nhận không đúng |
| 2006 | Phone number is not valid | Số điện thoại người nhận không đúng |
| 2007 | Voucher Ref ID is not valid | Voucher Ref Id không đúng/không tồn tại |
| 2008 | Voucher Ref ID already exists | Voucher Ref Id đã tồn tại/ trùng lặp |
| 2014 | Product id not allowed | Tài khoản khách hàng không được phép tạo voucher với product ID này |
Others
| Code | Message | Description |
|---|---|---|
| 3002 | Your account has limited voucher call | Tài khoản của khách hàng đã hết hạn mức tối đa tổng giá trị voucher được phát hành. Vui lòng liên hệ Got It để được bổ sung hạn mức. |
| 3003 | The signature is incorrect | Chữ ký không chính xác |
| 5003 | The merchant code is out of stock | Hết tồn kho mã voucher của đối tác (Trường hợp auto-convert từ code Got It thành code của đối tác) |
| 9999 | Unknown Error Occurred | Lỗi chưa xác định |
Thông tin để phát hành voucher test
| Tên sản phẩm | Giá trị | Product ID | Price ID |
|---|---|---|---|
| Thẻ quà tặng tiền mặt Got It | 100.000 VND | 1408 | 2711 |
| Thẻ quà tặng tiền mặt Got It | 500.000 VND | 1408 | 2713 |
| Thẻ quà tặng tiền mặt BigC | 50.000 VND | 954 | 10291 |
| Thẻ quà tặng Ly cafe Highland Phin Sữa Đá size vừa | 35.000 VND | 772 | 5753 |
| Thẻ quà tặng Nạp điện thoại | 50.000 VND | 987 | 2168 |