Get Affiliate Campaign
Function
To get detailed information for an affiliate campaign with its ID
使用推薦活動 ID 獲取特定一個推薦活動的詳細資料
URL
GET <<api_domain>>/v1/affiliate_campaigns/:id
Request Parameters
Parameter | Type | Description | Example |
|---|---|---|---|
id *Required | String | Affiliate campaign ID | 6049d431709478001d7c496b |
Request Example
Response Fields
Field | Type | Description | Example |
|---|---|---|---|
id | String | Affiliate campaign ID | 6049d431709478001d7c496b |
name | String | Affiliate campaign name | Affiliate Campaign Name |
condition_value | Integer | Condition for total order over how much money to get the reward | 100 |
reward_type | String | Reward type -null : 沒有回饋 | amount |
reward_value | Integer | Reward value -搭配訂單回饋類型使用 if reward_type=percentage, reward_value=10 代表回饋訂單金額 10 %。 if reward_type=null, reward_value=null (default) 代表沒有回饋 | 10 |
promotion_id | String | Promotion id | 5ce0d084e388096bdb229a59 |
code | String | Affiliate code | code123 |
referral_link | String | Referral link | |
partner_info | Object | Partner Info
| { |
apply_on | String | Apply on order or product
| order |
apply_method | String | Apply method
| all |
use_count | Integer | Use count | 0 |
affiliate_percentage | Float | Affiliate percentage | 30 |
affiliate_amount | Affiliate amount | { | |
condition_min_amount | The threshold amount (for order level) | { | |
campaign_products | Array[Object] | 指定分潤商品 | [{ |
start_at | DateTime | Affiliate campaign start time | 2018-01-10T06:33:45.231+00:00 |
end_at | DateTime | Affiliate campaign end time -null = no end date 永不過期 | 2018-01-10T06:33:45.231+00:00 |
remarks_translations | Remarks translations | {} | |
created_at | DateTime | Affiliate campaign created time | 2018-01-10T06:33:45.231+00:00 |
updated_at | DateTime | Affiliate campaign updated time | 2018-01-10T06:33:45.231+00:00 |
Sample Response
Updated 11 days ago