---
title: "Get Affiliate Campaign"
method: GET
path: "/affiliate_campaigns/{id}"
tags: ["Affiliate Campaigns"]
---

# Get Affiliate Campaign

`GET /affiliate_campaigns/{id}`

To get affiliate campaign.<br>獲取推薦活動。

## Path parameters

- `id` string, required

## Response `200`

OK

- AffiliateCampaign
  - `id` string — Affiliate Campaign Unique ID<br>推薦活動ID
  - `name` string — Affiliate Campaign Name<br>推薦活動名稱
  - `type` 'affiliate_referral' | 'product_attribution' — Affiliate Campaign Type<br>推薦活動類型
  - `condition_value` integer — Condition for total order over how much money to get the reward<br>全單超過多少錢可以獲得回饋
  - `reward_type` string — Reward type<br>訂單回饋類型<br>
  - `reward_value` integer — Reward value<br>訂單回饋值
  - `promotion_ids` string[] — Promotion ids<br>套用優惠折扣 ID 列表
  - `code` string — Affiliate code<br>推薦代碼
  - `referral_link` string — Referral link<br>推薦連結
  - `partner_info` object — Partner Info<br>合作夥伴資訊
  - `apply_on` 'order' | 'product' — Apply on order or product<br>套用於訂單或商品
  - `apply_method` 'all' | 'product' — Apply method<br> 套用方式:<br> - all: 全部<br> - item: 逐筆設定
  - `use_count` integer — Use count<br>使用次數
  - `affiliate_percentage` number, float — Affiliate percentage<br>分潤百分比
  - `affiliate_amount` object — Affiliate amount<br>分潤固定金額
    - `cents` integer
    - `currency_symbol` string
    - `currency_iso` string
    - `label` string
    - `dollars` number
  - `condition_min_amount` object — The threshold amount (for order level)<br>門檻金額 (for order level)
    - `cents` integer
    - `currency_symbol` string
    - `currency_iso` string
    - `label` string
    - `dollars` number
  - `campaign_products` object
    - `id` string — Affiliate Campaign Unique ID<br>推薦活動ID
    - `product_id` string — Product ID<br>商品ID
    - `affiliate_percentage` number, float — Affiliate percentage<br>分潤百分比
    - `affiliate_amount` object — Affiliate amount<br>分潤固定金額
      - `cents` integer
      - `currency_symbol` string
      - `currency_iso` string
      - `label` string
      - `dollars` number
  - `start_at` string — Affiliate campaign start time<br>推薦活動開始時間<br>-<br>*UTC Time
  - `end_at` string — Affiliate campaign end time<br>推薦活動結束時間<br>-<br>*UTC Time
  - `remarks_translations` object — Remarks translations<br>顯示於 KOL Hub 的條款說明
    - `en` string — Merchant defined English name<br>店家定義英文名稱
    - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
    - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
    - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
    - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
    - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
    - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
    - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
    - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
    - `fr` string — Merchant defined France name<br>店家定義法文名稱
  - `created_at` string — Affiliate campaign created time<br>推薦活動創建時間<br>-<br>*UTC Time
  - `updated_at` string — Affiliate campaign updated time<br>推薦活動更新時間<br>-<br>*UTC Time
  - `total_reward_value` Money
    - `cents` integer
    - `currency_symbol` string
    - `currency_iso` string
    - `label` string
    - `dollars` number

## Other responses

- `422` — Unprocessable entity error
- `500` — Server error

---

[API](https://skmtc.net/shoplineapp/apis/shopline-open-api.md) · [All operations](https://skmtc.net/shoplineapp/apis/shopline-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shoplineapp/shopline-open-api/revisions/1675ac12cde7/schema)