AntCRM - API tích điểm và đổi quà

I. API tích điểm

  1. Lịch sử tích điểm

URL: /history-point?type=point

Method: GET

Content-Type: application/json


Tham số

Loại

Bắt buộc

Giải thích

createdAtRangeFrom

number


Thời gian bắt đầu 

createdAtRangeTo

number


Thời gian kết thúc

phone

String


Số điện thoại khách hàng

email

String


Email khách hàng

page

number


Số thứ tự của trang, mỗi trang tối đa 20 bản ghi


Kết quả trả về: 

HTTP Response Code:  200

Response:
[{

  "type": 1, // loại tích luỹ

  "score": 100, // số điểm tích lũy

  "status": 1, // trạng thái tích lũy (thành công : 1, thất bại: 0)

  "product": {

    "code": "TIVI01", // mã sản phẩm tích lũy

    "name": "Tivi", // tên sản phẩm tích lũy

    "id": "64d9f28b2b3ba308b322c710"

  },

  "contact": {

    "phones": [

      {

        "type": "Work",

        "_id": "64db290a7796fe24bfe876a8",

        "value": "0867123456"

      }

    ],

    "name": "Garnacho",

    "emails": [

      {

        "type": "Work",

        "_id": "64db290a7796fe24bfe876a9",

        "value": "garnacho@gmail.com"

      }

    ],

    "lastname": "",

    "customerId": 475,

    "id": "64db290a7796fe24bfe876a7"

  },

  "org": "62c10674cbe832bc9245a5b8",

  "code": "TIVInpmx8b98pfg", // mã code tích lũy

  "serialNumber": "npmx8b98pfg", // serial number tích luỹ

  "createdAt": 1692084490615, // thời gian tích lũy

  "id": "64db290a7796fe24bfe876b4"

}]


  1. Tích điểm

URL: /accumulate

Method: POST

Content-Type: application/json


Tham số

Loại

Bắt buộc

Giải thích

code

string

Y

Mã code tích lũy

data

object

Y

{
“emails”: [{type: “Work”, value: “xyz@example.com”}],  // email khách hàng đổi quà
“name”: “thong”, // tên khách hàng đổi quà

“phones”: [{type: “Work”, value: “023232”}]  // số điện thoại khách hàng đổi quà
}


Kết quả trả về: 

HTTP Response Code:  200

Response:
{

"success": 1,

}


II. API đổi quà 

  1. Lịch sử tích điểm

URL: /history-point

Method: GET

Content-Type: application/json


Tham số

Loại

Bắt buộc

Giải thích

createdAtRangeFrom

number


Thời gian bắt đầu 

createdAtRangeTo

number


Thời gian kết thúc

phone

String


Số điện thoại khách hàng

email

String


Email khách hàng

page

number


Số thứ tự của trang, mỗi trang tối đa 20 bản ghi


Kết quả trả về: 

HTTP Response Code:  200

Response:
[{

  "type": 2, // loại đổi quà

  "score": 10, // số điểm dùng để đổi quà

  "status": 1,// trạng thái đổi quà (thành công : 1, thất bại: 0)

  "gift": {

    "code": "DAUMAY01", // mã code của phần quà

    "name": "Đầu máy", // tên phần quà

    "score": 10, // số điểm để đổi quà

    "id": "64d9f2ec2b3ba308b322c782"

  },

  "contact": {

    "phones": [

      {

        "type": "Work",

        "_id": "64db290a7796fe24bfe876a8",

        "value": "0867123456"

      }

    ],

    "name": "Garnacho",

    "emails": [

      {

        "type": "Work",

        "_id": "64db290a7796fe24bfe876a9",

        "value": "garnacho@gmail.com"

      }

    ],

    "customerId": 475, // id contact trên CRM

    "id": "64db290a7796fe24bfe876a7"

  },

  "org": "62c10674cbe832bc9245a5b8",

  "createdAt": 1692085265818, // thời gian đổi quà

  "id": "64db2c11cbad5f4fdd254567"

}]


  1. Tích điểm

URL: /redeem

Method: POST

Content-Type: application/json


Tham số

Loại

Bắt buộc

Giải thích

code

string

Y

Mã code phần quà

data

object

Y

{
“email”: “xyz@example.com”, // email khách hàng đổi quà

“phone”: “023232” // số điện thoại khách hàng đổi quà
}


Kết quả trả về: 

HTTP Response Code:  200

Response:
{

"success": 1,

}



Bài viết này có hữu ích không? Đánh giá: 0
Chi tiết bài viết:
Ngày đăng: 25/08/2023 3:47PM
Lần cập nhật gần đây: 30/08/2023 2:52PM (Thuận Trần - thuan.tran@antbuddy.com)
Chia sẻ bài viết:   
Tác giả:Thuận Trần (thuan.tran@antbuddy.com)