v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB

Merchants

Get Merchant

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

get/merchants/{merchant_id}

Path parameters

merchant_idstring required

Merchant ID 商户ID

Query parameters

include_fields[]string[]

Provide additional attributes in the response 結果添加哪些參數

Response

idstring

Merchant ID 商户ID

base_country_codestring

Country/Region code 國家/地區代碼

base_currency_codestring

Currency code 貨幣代碼

namestring

Shop Name 商店名稱

emailstring

Shop Email 商店電郵

handlestring

Shop code 商店代碼

custom_domainstring

Shop custom domain 商店自訂網域

current_plan_keystring

Shop plan key 商店計劃代碼

default_language_codestring

Default language code 默認語言代碼

staff_idstring

Staff ID 管理員ID

rollout_keysstring[]

Supported function keys 支援的功能代碼

supported_languagesstring[]

Supported languages 支援的語言

KYC status KYC審核狀態

admin_status'normal' | 'suspended'

Admin status

sl_payment_merchant_idstring

sl_payment_merchant_id 支付中台merchant id

sl_payment_mccstring

sl_payment_mcc 渠道分配的mcc

sl_payment_billing_descriptor_namestring

Store's billing descriptor 商店交易名稱

product_linesobject

Product Lines 商戶訂閱

tagsstring[]

tags 標籤

emailsobject

emails 其他電郵

phonesobject

phones 電話

pos_payment_idstring

POS payment id

pos_delivery_option_idstring

POS Delivery option id

brand_home_urlstring

Storefront url 店鋪地址

current_theme_keystring

The theme key that the merchant is currently 商家當前正在使用的主題 Only provided when include_fields contains 'current_theme_key' 僅於include_fields傳入 'current_theme_key' 時提供

instagram_usernamestring

The instagram username of the merchant linked currently 商家當前正在連結的Instagram用戶名稱 Only provided when include_fields contains 'instagram_username' 僅於include_fields傳入 'instagram_username' 時提供

Example response

{
  "id": "5e8c5b7a2c389a006ad21050",
  "base_country_code": "TW",
  "base_currency_code": "TWD",
  "name": "vicky's store 志龍",
  "email": "vicky@shopline.com",
  "handle": "vickyvickyvicky",
  "custom_domain": "www.vickyvickyvicky.com",
  "current_plan_key": "premium_3year",
  "default_language_code": "en",
  "staff_id": "5b55ae85b818790005cc40c1",
  "rollout_keys": [
    "admin_v2",
    "studio_livestream",
    "channel_customer_authentication"
  ],
  "supported_languages": [
    "en",
    "zh-hant",
    "ja",
    "id",
    "ms",
    "zh-cn",
    "fr",
    "de",
    "th",
    "vi"
  ],
  "logo_media": {
    "id": "5f8e5dc08a8bb70a5c9cd93c",
    "alt_translations": {
      "en": "Image ALT",
      "zh-hant": "圖片ALT"
    },
    "images": {
      "original": {
        "width": 800,
        "height": 800,
        "url": "https://img.example.com/media/1234/thumb.jpg"
      }
    }
  },
  "kyc_status": "not_yet_applied",
  "admin_status": "normal",
  "brand_home_url": "https://handle.shoplineapp.com",
  "taxes": [
    {
      "id": "610c21d5496ffa004ee65b73",
      "name": "消費稅",
      "merchant_id": "5e8c5b7a2c389a006ad21050",
      "country": "US",
      "is_default_rates": true,
      "enable_inclusive": true,
      "allow_inclusive_tax": true,
      "service_charge_taxable": true,
      "emoji_flag": "🇺🇸",
      "sales": {
        "general": {
          "id": "610c21d5496ffa004ee65b74",
          "region": "IA",
          "rate": 0.04,
          "type": "sales",
          "default_rate": 0.0736
        },
        "details": [
          {
            "id": "610c21d5496ffa004ee65b74",
            "region": "IA",
            "rate": 0.04,
            "type": "sales",
            "default_rate": 0.0736
          }
        ]
      },
      "delivery": {
        "general": {
          "id": "610c21d5496ffa004ee65b74",
          "region": "IA",
          "rate": 0.04,
          "type": "sales",
          "default_rate": 0.0736
        },
        "details": [
          {
            "id": "610c21d5496ffa004ee65b74",
            "region": "IA",
            "rate": 0.04,
            "type": "sales",
            "default_rate": 0.0736
          }
        ]
      },
      "service_charge": {
        "general": {
          "id": "610c21d5496ffa004ee65b74",
          "region": "IA",
          "rate": 0.04,
          "type": "sales",
          "default_rate": 0.0736
        },
        "details": [
          {
            "id": "610c21d5496ffa004ee65b74",
            "region": "IA",
            "rate": 0.04,
            "type": "sales",
            "default_rate": 0.0736
          }
        ]
      }
    }
  ],
  "current_theme_key": "ultra_chic",
  "instagram_username": "freecodecamp",
  "whitelisted_ip_addresses": [
    {
      "_id": "6360953220b56c0034befa35",
      "name": "my IP",
      "address": "127.0.0.1",
      "updated_at": "2022-11-01T03:40:34.382Z",
      "created_at": "2022-11-01T03:40:34.382Z"
    }
  ]
}