Create Affiliate Campaign

Function

To create detailed information of an affiliate campaign
建立單個推薦活動

URL

POST API_DOMAIN/v1/affiliate_campaigns

Request Parameters

ParameterTypeDescriptionExample
name
*Required
StringAffiliate campaign name
推薦活動名稱
Affiliate Campaign Name
reward_typeString

Reward type
訂單回饋類型

-null : 沒有回饋
amount : 固定金額
percentage : 訂單百分比(%)

(default = null)

amount
promotion_idString

Promotion id
套用優惠折扣 ID

-null : 不套用折扣
promotion_id : 只能填入設定 "僅適用於推薦活動的" 優惠

(default = null)

5ce0d084e388096bdb229a59
code
*Required
StringAffiliate code
推薦代碼
code123
start_atDateTime

Affiliate campaign start time
推薦活動開始時間

(default = now)

2018-01-10T06:33:45.231+00:00
end_atDateTimeAffiliate campaign end time
推薦活動結束時間
  • null = no end date 永不過期(default = null)
2018-01-10T06:33:45.231+00:00
apply_onStringApply on order or product
套用於訂單或商品
  • order
  • product
order
apply_methodStringApply method
套用方式:
  • all: 全部
  • item: 逐筆設定
all
affiliate_percentageFloatAffiliate percentage
分潤百分比
30
affiliate_amountObjectAffiliate amount
分潤固定金額
{"dollars": 20}
condition_min_amountObjectThe threshold amount (for order level)
門檻金額 (for order level)
  • 整筆訂單分潤,全單購買滿 xx 元
    Commission for the entire order for the total order over $__
{"dollars": 100}
campaign_productsArray[Object]Campaign Products
指定分潤商品
[
{
"product_id": "5ce0d084e388096bdb229a59",
"affiliate_amount": {
"dollars": 12
}
}
]
remarks_translationsTranslationRemarks translations
顯示於KOL Hub 的條款說明
feature key: affiliate_kol_report
{}

Request Example

Response Field

Same as Get Affiliate Campaign


Did this page help you?