---
title: "Get Merchant"
method: GET
path: "/merchants/{merchant_id}"
tags: ["Merchants"]
---

# Get Merchant

`GET /merchants/{merchant_id}`

To get information of merchant by merchant id<br>以商户id獲取商户資料

## Path parameters

- `merchant_id` string, required

## Query parameters

- `include_fields[]` string[]

## Response `200`

OK

- Merchant
  - `id` string — Merchant ID<br>商户ID
  - `base_country_code` string — Country/Region code<br>國家/地區代碼
  - `base_currency_code` string — Currency code<br>貨幣代碼
  - `name` string — Shop Name<br>商店名稱
  - `email` string — Shop Email<br>商店電郵
  - `handle` string — Shop code<br>商店代碼
  - `custom_domain` string — Shop custom domain<br>商店自訂網域
  - `current_plan_key` string — Shop plan key<br>商店計劃代碼
  - `default_language_code` string — Default language code<br>默認語言代碼
  - `staff_id` string — Staff ID<br>管理員ID
  - `rollout_keys` string[] — Supported function keys<br>支援的功能代碼
  - `supported_languages` string[] — Supported languages<br>支援的語言
  - `logo_media` object — Logo Media Data<br>Logo媒體(照片)資訊
    - `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>包含不同大小圖片的連絡
  - `kyc_status` 'not_yet_applied' | 'basic_account_pending' | 'basic_account_verified' | 'basic_account_rejected' | 'basic_account_reviewed' | 'advanced_account_pending' | 'advanced_account_verified' | 'advanced_account_rejected' | 'advanced_account_failed' — KYC status<br>KYC審核狀態
  - `admin_status` 'normal' | 'suspended' — Admin status
  - `sl_payment_merchant_id` string — sl_payment_merchant_id<br>支付中台merchant id
  - `sl_payment_mcc` string — sl_payment_mcc<br>渠道分配的mcc
  - `sl_payment_billing_descriptor_name` string — Store's billing descriptor<br>商店交易名稱
  - `product_lines` object — Product Lines<br>商戶訂閱
  - `tags` string[] — tags<br>標籤
  - `emails` object — emails<br>其他電郵
  - `phones` object — phones<br>電話
  - `pos_payment_id` string — POS payment id
  - `pos_delivery_option_id` string — POS Delivery option id
  - `brand_home_url` string — Storefront url<br>店鋪地址
  - `taxes` MerchantTax[] — Tax Info of Merchant<br>商店稅金設定
    - `id` string — Tax ID<br>稅金設定ID
    - `name` string — Tax Name<br>稅金名稱
    - `merchant_id` string — Merchant ID<br>商户ID
    - `country` string — country code<br>國家代碼
    - `is_default_rates` boolean — is use default rates or not<br>是否是預設稅率
    - `enable_inclusive` boolean — is enable inclusive or not<br>商品是否含稅
    - `allow_inclusive_tax` boolean — is allow to enable inclusive tax or not<br>是否允許商品含稅
    - `service_charge_taxable` boolean — is service charge taxable or not <br>服務稅是否應稅
    - `emoji_flag` string — emoji of country flag<br>國旗emoji
    - `sales` object
      - `general` TaxRegion
        - `id` string — Tax region ID<br>稅務地區ID
        - `region` string — Tax region<br>稅務地區
        - `rate` number — Tax rate<br>稅率
        - `type` string — Tax type<br>稅別
        - `default_rate` number — Default tax rate<br>預設稅率
        - `default_rate_range` number[] — Default tax rate range<br>預設稅率範圍
      - `details` TaxRegion[]
        - `id` string — Tax region ID<br>稅務地區ID
        - `region` string — Tax region<br>稅務地區
        - `rate` number — Tax rate<br>稅率
        - `type` string — Tax type<br>稅別
        - `default_rate` number — Default tax rate<br>預設稅率
        - `default_rate_range` number[] — Default tax rate range<br>預設稅率範圍
    - `delivery` object
      - `general` TaxRegion
        - `id` string — Tax region ID<br>稅務地區ID
        - `region` string — Tax region<br>稅務地區
        - `rate` number — Tax rate<br>稅率
        - `type` string — Tax type<br>稅別
        - `default_rate` number — Default tax rate<br>預設稅率
        - `default_rate_range` number[] — Default tax rate range<br>預設稅率範圍
      - `details` TaxRegion[]
        - `id` string — Tax region ID<br>稅務地區ID
        - `region` string — Tax region<br>稅務地區
        - `rate` number — Tax rate<br>稅率
        - `type` string — Tax type<br>稅別
        - `default_rate` number — Default tax rate<br>預設稅率
        - `default_rate_range` number[] — Default tax rate range<br>預設稅率範圍
    - `service_charge` object
      - `general` TaxRegion
        - `id` string — Tax region ID<br>稅務地區ID
        - `region` string — Tax region<br>稅務地區
        - `rate` number — Tax rate<br>稅率
        - `type` string — Tax type<br>稅別
        - `default_rate` number — Default tax rate<br>預設稅率
        - `default_rate_range` number[] — Default tax rate range<br>預設稅率範圍
      - `details` TaxRegion[]
        - `id` string — Tax region ID<br>稅務地區ID
        - `region` string — Tax region<br>稅務地區
        - `rate` number — Tax rate<br>稅率
        - `type` string — Tax type<br>稅別
        - `default_rate` number — Default tax rate<br>預設稅率
        - `default_rate_range` number[] — Default tax rate range<br>預設稅率範圍
  - `current_theme_key` string — The theme key that the merchant is currently<br>商家當前正在使用的主題 <br>Only provided when include_fields contains 'current_theme_key'<br> 僅於include_fields傳入 'current_theme_key' 時提供
  - `instagram_username` string — The instagram username of the merchant linked currently<br>商家當前正在連結的Instagram用戶名稱 <br>Only provided when include_fields contains 'instagram_username'<br> 僅於include_fields傳入 'instagram_username' 時提供
  - `whitelisted_ip_addresses` object[] — The whitelisted IP addresses<br> 登入 IP 位置白名單<br> Presented in GET /merchants/:merchant_id, but not in GET /merchants<br> 會於 GET /merchants/:merchant_id，但不於 GET /merchants 出現
    - `_id` string
    - `name` string
    - `address` string
    - `updated_at` string
    - `created_at` string

---

[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)