Sign in

v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB
Channels

Get Channel

To get detailed information for a specific channel with its ID<br>使用通路ID獲取特定一個通路的詳細資料

get/channels/{id}

Path parameters

idstring required

Channels's ID<br>通路 ID

Query parameters

include_fieldsstring[]

Some fields need to be specified in this parameter. Otherwise, it will not be returned.<br> 有些欄位需要定義在此參數內，否則將不會返回這些欄位的值。

[
  "e_invoice_setting"
]
fieldsstring[]

For mobile logo media, need to add items.mobile_logo_media_url to this field.<br> mobile logo media 必須加入 items.mobile_logo_media_url 到此欄位。

[
  "items.mobile_logo_media_url"
]

Response

OK

idstring
platform'Shopee' | 'shop_crm' | 'online' | 'pos' | 'sc'

Shopee<br> shop_crm<br> online<br> pos<br> sc

merchant_idstring
updated_atstring
created_atstring
currency_codestring
merchant_namestring
default_warehouse_idstring
identifierstring
addressobject
mobile_logo_media_urlstring

Example response

{
  "id": "5ce0d084e388096bdb229a59",
  "updated_at": "2018-07-31T03:57:36.409+00:00",
  "created_at": "2018-07-31T03:57:36.409+00:00",
  "default_warehouse_id": "5ce0d084e388096bdb229a59",
  "identifier": "00222333",
  "phones": {
    "main": "0912345678"
  },
  "address": {
    "address_1": "1/F, Some Building",
    "city": "City",
    "state": "Perak",
    "postcode": "36500",
    "country": "Malaysia",
    "country_code": "MY"
  },
  "pin_codes": [
    {
      "scope": "switch_store"
    }
  ],
  "e_invoice_setting": {
    "invoice_type": "none"
  }
}