v1
latestOpenAPI 3.0.02026-07-26318168886.7 KBAffiliate Campaigns
Get Affiliate Campaigns
To get affiliate campaigns.<br>獲取推薦活動清單。
get/affiliate_campaigns
Query parameters
active_status'expired' | 'ongoing'
The active status of affiliate campaign (expired or ongoing).<br> 推薦活動的狀態 (已過期或進行中)。
partner_emailstring
The partner's email (To encode it with URI encode before sending).
previous_idstring
The last ID of the campaigns in the previous request. (for cursor base; empty is mean first page)<br> 前頁最後一筆編號(僅適用遊標取值，空值表示第一頁)
pageinteger
Page number (Deprecated)<br>頁數(已過時不建議使用)
per_pageinteger
Numbers of channels per page<br>每頁顯示資料筆數
Response
OK
Example response
{
"pagination": {
"current_page": 1,
"per_page": 24,
"total_count": 1,
"total_pages": 1
},
"items": [
{
"id": "5ce0d084e388096bdb229a59",
"name": "Affiliate Campaign Name",
"type": "affiliate_referral",
"condition_value": 100,
"reward_type": "percentage",
"reward_value": 10,
"promotion_ids": [
"5ce0d084e388096bdb229a59"
],
"code": "iris123",
"referral_link": "https://irishsu400.shoplineapp.com?sl-ref=iris123",
"partner_info": {
"name": "",
"email": ""
},
"apply_on": "order",
"apply_method": "all",
"use_count": 1,
"affiliate_percentage": 30,
"affiliate_amount": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"condition_min_amount": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"campaign_products": {
"id": "5ce0d084e388096bdb229a59",
"product_id": "5ce0d084e388096bdb229a59",
"affiliate_percentage": 30,
"affiliate_amount": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
}
},
"start_at": "2018-01-10T06:33:45.231Z",
"end_at": "2018-01-10T06:33:45.231Z",
"remarks_translations": {
"zh-hant": "條款說明"
},
"created_at": "2018-01-10T06:33:45.231Z",
"updated_at": "2018-01-10T06:33:45.231Z",
"total_reward_value": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
}
}
],
"proxy_service_error": {
"message": "Unable to create EventTrackers",
"code": "UnknownError"
},
"last_id": "5ce0d084e388096bdb229a59",
"limit": 24
}