Get Merchant

Function

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

URL

GET <<api_domain>>/v1/merchants/:merchant_id

Request Parameters

Parameter	Type	Description	Example
merchant_id	`String`	Merchant ID 商户ID	`5e8c5b7a2c389a006ad21050`

Response Fields

Field	Type	Description	Example
id	`String`	Merchant ID 商户ID	5e8c5b7a2c389a006ad21050
base_country_code	`String`	Country/Region code 國家/地區代碼	TW
base_currency_code	`String`	Currency code 貨幣代碼	TWD
name	`String`	Shop Name 商店名稱	vicky's store 志龍
email	`String`	Shop Email 商店電郵	[email protected]
handle	`String`	Shop code 商店代碼	example
brand_home_url	`String`	Shop code 商店鏈結	`https://example.shoplineapp.com`
custom_domain	`String`	Shop custom domain 商店自訂網域	`www.example.com`
current_plan_key	`String`	Shop plan key 商店計劃代碼	premium_3year
default_language_code	`String`	Default language code 默認語言代碼	en
staff_id	`String`	Staff ID 店長 ID (只會有一個，也就是建立這個 merchant 的帳號)	5b55ae85b818790005cc40c1
rollout_keys	`String[]`	Supported function keys 支援的功能代碼	[ "admin_v2", "studio_livestream", "channel_customer_authentication" ]
supported_languages	`String[]`	Supported languages 支援的語言	[ "en", "zh-hant", "ja", "id", "ms", "zh-cn", "fr", "de", "th", "vi" ]
logo_media	`Hash`	Shop's logo 店鋪logo	{ "_id": "608a2a68c8adfb002083eee8", "images": { "original": { "width": 900, "height": 662, "url": "https://img.shoplineapp.com/media/image_clips/608a2a68c8adfb002083eee8/original.png?1619667560" } }, "alt_translations": {} }
brand_home_url	`String`	Storefront url 店鋪地址	https://sampleshop.shoplineapp.com/
tags	`String[]`	tags 標籤	["life"]
emails	`Hash`	Other emails 其他電郵	{ "order": "", "message": "", "comment": ", "low_inventory": "", "billing": [ "" ], "shopline_payment": "" }
product_lines	`Hash`	Merchant subscription 商戶訂閱	_{ "preorder": [], "paid": [ { "name": "ec", "payment_gateway": "shopline_payment", "start_at": "2021-09-16T07:55:44.000Z", "end_at": "2022-09-16T07:55:44.000Z", "status": "active" } ], "trial": [] }_
kyc_status	`String`	KYC status KYC審核狀態 one in 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	`not_yet_applied`
sl_payment_merchant_id	`String`	sl_payment_merchant_id 支付中台merchant id	`1450485732895493326`
sl_payment_mcc	`String`	sl_payment_mcc 渠道分配的mcc	`123`
sl_payment_billing_descriptor_name	`String`	Store's billing descriptor 商店交易名稱	`SL*BCHK`

Response Example

{
  "id": "58e4736a9a76f0174c000278",
  "_id": "58e4736a9a76f0174c000278",
  "base_country_code": "TW",
  "base_currency_code": "TWD",
  "name": "vicky's store 志龍",
  "email": "[email protected]",
  "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",
    "zh-cn",
    "vi",
    "ms",
    "ja",
    "th"
  ],
  "logo_media": {
    "_id": "608a2a68c8adfb002083eee8",
    "images": {
      "original": {
        "width": 900,
        "height": 662,
        "url": "https://img.shoplineapp.com/media/image_clips/608a2a68c8adfb002083eee8/original.png?1619667560"
      }
    },
    "alt_translations": {}
  }
}