Create conversion

API để tao chuyển đổi/đơn hàng

Base URL:

http://<host-name>/api/v1/create-conversion

Method: POST

Header:

Content-Type:               application/json
X-At-User:                  {user}
X-At-User-Type:             api
X-At-User-Access-Token :    {access_token}

Example Request

  {
        "click_id": "dfa4872bfc2e43a5893cc62f8cff0a54",
        "campaign_id": "5",
        "order_id": "No.0009",,
        "action_time": 1565861331933,
        "currency": "VND",
        "conversion_parts": [
            {
                "id": "1",
                "sku": "SKU002",
                "url": "http://tiki.vn/1122",
                "price": 3990000,
                "discount": 300000,
                "name": "Z MODERN PRO",
                "category_name": "MODERNALPHABET",
                "category_id": "MODERNALPHABET",
                "quantity": 1
            }
        ]
    }

Attribute

Type

Required

Description

1

click_id

string

Yes

Id từ link chia sẻ của publisher

2

campaign_id

int

Yes

id của chiến dịch

3

order_id

string

Yes

id đơn hàng của đối tác

5

action_time

microtime

No

Thời gian tạo conversion

6

conversion_parts

(object)

No

Thông tin từng sản phẩm trong đơn hàng

6.1

id

string

No

Id của sản phẩm

6.2

sku

string

No

Mã định danh sản phẩm bên phía đối tác

6.3

url

string

No

Đường dẫn của sản phẩm

6.4

price

double

No

Giá bán của sản phẩm

6.5

discount

double

No

Tổng số tiền giảm giá của sản phẩm

11.8

name

string

No

Tên sản phẩm

11.9

category_name

string

No

Tên nhóm sản phẩm bên phía đối tác

11.10

category_id

string

No

Id nhóm sản phẩm bên phía đối tác

11.11

quantity

int

No

Số lượng sản phẩm

Response

 {
        "status": "success",
        "data": {
            "conversion": {
                "conversion_id": "5d5e65d171a0e157e525173a",
                "click_id": "dfa4872bfc2e43a5893cc62f8cff0a54",
                "campaign_id": "5",
                "order_id": "No.0009",
                "action": "buy",
                "action_time": 1565861331933,
                "total_discount": {
                    "amount": 30000,
                    "currency": "VND"
                },
                "total_sale_amount": {
                    "amount": 369000,
                    "currency": "VND"
                },
                "total_commission": {
                    "amount": 200000,
                    "currency": "VND"
                },
                "client_ip": "123.230.245.220",
                "user_agent": "UA123567",
                "conversion_parts": [
                    {
                        "sku": "SKU002",
                        "name": "Z MODERN PRO",
                        "url": "http://tiki.vn/1122",
                        "quantity": 1,
                        "currency": "VND",
                        "commission": {
                            "amount": 200000.0,
                            "currency": "VND"
                        },
                        "status": "create_new",
                        "reason": null,
                        "id": "1",
                        "price": 399000.0,
                        "discount": 30000.0,
                        "sale_amount": 369000.0,
                        "calculate_by": "FIXED",
                        "calculate_by_id": null,
                        "category_name": "MODERNALPHABET",
                        "category_id": "MODERNALPHABET"
                    }
                ],
                "status": "create_new",
                "reason": null,
                "created_time": "2019-08-27T17:40:27+0700",
                "updated_time": "2019-08-27T17:40:27+0700"
            }
        },
        "message": "Success",
        "code": 0
    }

Edit conversion

Base URL:

http://<host-name>/api/v1/update-conversion

Method: PUT

Header:

X-Network-Id:               1
Content-Type:               application/json
X-At-User:                  {user}
X-At-User-Type:             api
X-At-User-Access-Token :    {access_token}

Example Request

{
        "conversion_id": "5d5e65d171a0e157e525173a",
        "action" :"buy",
        "action_time": 1565861331933,
        "

": {
            "amount": 400000,
            "currency": "VND"
        },
        "total_sale_amount": {
            "amount": 728000,
            "currency": "VND"
        },
        "total_commission": {
            "amount": 200000,
            "currency": "VND"
        },
        "client_ip": "123.230.245.220",
        "user_agent": "UA123567",
        "conversion_parts": [
            {
                "id": "2",
                "sku": "SKU002",
                "url": "http://tiki.vn/1122333",
                "price": 399000,
                "discount": 40000,
                "sale_amount": 359000,
                "currency": "VND",
                "name": "Z MODERN PRO",
                "category_name": "MODERNALPHABET",
                "category_id": "MODERNALPHABET",
                "quantity": 1,
                "commission": {
                    "amount": 0,
                    "currency": "VND"
                },
                "calculate_by" : "FIXED"
            }
        ],
        "reason" : "Khach hang muon mua them hang"
    }

Attribute

Type

Required

Description

1

conversion_id

string

Yes

Id của đơn hàng được sinh ra từ hệ thống scaleF

4

action

string

No

kiểu action (buy/install/...)

5

action_time

microtime

Yes

Thời gian tạo conversion

6

total_discount

(object)

No

Tổng tiền giảm giá của đơn hàng.

Total discount = discount conversion part 1 + discount conversion part 2 + discount conversion part n

7

total_sale_amount

(object)

Yes

Tổng giá trị đơn hàng.

Total sale amount = sale amount conversion part 1 + sale amount conversion part 2 + sale amount conversion part n

8

total_commission

(object)

No

Tổng hoa hồng phải trả của đơn hàng

9

client_ip

string

No

ip của end-user

10

user_agent

string

No

Thiết bị sử dụng của end-user

11

conversion_parts

(object)

Yes

Thông tin từng sản phẩm trong đơn hàng

11.1

id

string

Yes

Id của sản phẩm

11.2

sku

string

No

Mã định danh sản phẩm bên phía đối tác

11.3

url

string

No

Đường dẫn của sản phẩm

11.4

price

double

Yes

Giá bán của sản phẩm

11.5

discount

double

No

Tổng số tiền giảm giá của sản phẩm

11.6

sale_amount

double

Yes

Tổng giá bán của sản phẩm. Sale amount = price * quantity - discount

11.7

currency

string

Yes

Loại đơn vị tiền tệ

11.8

name

string

No

Tên sản phẩm

11.9

category_name

string

No

Tên nhóm sản phẩm bên phía đối tác

11.10

category_id

string

No

Id nhóm sản phẩm bên phía đối tác

11.11

quantity

int

Yes

Số lượng sản phẩm

12

commission

(object)

No

Hoa hồng phải trả của sản phẩm

13

calculate_by

string

No

Hoa hồng được tính theo [ FIXED, CATEGORY_ID, PRODUCT_ID]

Last updated

Was this helpful?