Sign in

v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB
Channels

Get Channels

Get Channels<br>獲取 Channel 列表

get/channels

Query parameters

belongs_to'staff' | 'merchant'

Channels belongs to staff or merchant. Default is staff<br>網店通路或是 Staff 的通路，預設為 staff

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

Filter channels by platform. It can only filter channel by sc or shop_crm if belogs_to is staff.<br> 過濾通路屬於哪個平台，如果 belongs_to 為 staff 則只能過濾 sc 或是 shop_crm 通路。

platformsstring[]

Filter multiple channels by platforms. It can only filter channel by sc or shop_crm if belogs_to is staff.<br> 過濾通路屬於哪些平台，如果 belongs_to 為 staff 則只能過濾 sc 或是 shop_crm 通路。

[
  "shop_crm",
  "online"
]
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"
]
pageinteger

Page number<br>頁數

per_pageinteger

Numbers of channels per page<br>每頁顯示資料筆數

Response

OK

Example response

{
  "pagination": {
    "current_page": 1,
    "per_page": 24,
    "total_count": 1,
    "total_pages": 1
  },
  "items": [
    {
      "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"
      }
    }
  ]
}