---
title: "Get Addon Products"
method: GET
path: "/addon_products"
tags: ["Addon Products"]
---

# Get Addon Products

`GET /addon_products`

To get detailed information of addon products.<br>撈取加購品的詳細資訊

## Query parameters

- `previous_id` string
- `page` integer
- `per_page` integer
- `include_fields[]` string[]
- `main_product_id` string

## Response `200`

OK

- object
  - `items` AddonProduct[]
    - `id` string — Add-on Product‘s ID<br>加購品ID
    - `status` 'active' | 'draft' — Add-on Product's Status<br>加購品狀態<br>-<br>Status:<br>active上架<br>draft 下架
    - `title_translations` object — Title Translations<br>加購品名稱
      - `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>店家定義法文名稱
    - `price` number — Addon Product Price<br>加購品價格
    - `weight` number — Addon Product's Weight (kg)<br>加購品重量 (公斤)
    - `quantity` number — Current Quantity<br>加購品目前庫存
    - `unlimited_quantity` boolean — Unlimited quantity or not.<br>加購品數量是否無限<br> -<br> true: unlimited quantity<br> false: limited quantity
    - `medias` object — Media Data<br>媒體(照片)資訊
      - `id` string — Media ID
      - `alt_translations` object — Content to display on ALT attribute<br>在圖片ALT上展示的內容
        - `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>店家定義法文名稱
      - `images` object — Object contains url of image in different dimensions<br>包含不同大小圖片的連絡
    - `sku` string — Stock Keeping Unit<br>加購品貨號
    - `tax_type` string — Tax Type<br>國內稅項
    - `oversea_tax_type` string — Oversea Tax Type<br>海外稅項
    - `created_at` string — Created Time<br>加購品創造時間
    - `promotions` object[] — Promotions<br>加購活動<br> Only provided when include_fields contains 'promotions'<br> 僅於include_fields傳入 'promotions' 時提供
      - `id` string — Promotion ID<br>優惠活動ID
      - `discounted_price` object — Discounted price<br>優惠價格
        - `cents` integer
        - `currency_symbol` string
        - `currency_iso` string
        - `label` string
        - `dollars` number
      - `start_at` string — Promotion start time<br>活動開始時間
      - `end_at` string — Promotion end time<br>活動結束時間<br>-<br>null = no end date 永不過期
      - `conditions` object[] — 本階層活動生效條件
        - `id` string
        - `whitelisted_product_ids` string[]
  - `pagination` Paginatable
    - `current_page` integer — The current page number<br>當前分頁
    - `per_page` integer — Number of result per page<br>每頁顯示 n 筆資料<br>(Default: 24)
    - `total_count` integer — Number of result in total<br>資料總量
    - `total_pages` integer — Number of pages in total<br>總頁數量

## Other responses

- `500` — Server error

---

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