---
updatedAt: 2026-05-27T07:01:03.000Z
agentTools:
projectIndex: https://open-api.docs.shoplineapp.com/llms.txt
---
# Get Channels
Get Channels
獲取 Channel 列表
# OpenAPI definition
```json
{
"info": {
"title": "SHOPLINE Open API",
"version": "2.348.2",
"description": "Welcome to the shopline open-api developer hub. You'll find comprehensive guides and documentation to help you start working with shopline open-api as quickly as possible, as well as support if you get stuck. Let's jump right in!"
},
"servers": [
{
"url": "https://open.shopline.io/v1",
"description": "Production"
}
],
"openapi": "3.0.0",
"security": [
{
"bearerAuth": []
}
],
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
},
"schemas": {
"Translatable": {
"type": "object",
"properties": {
"en": {
"type": "string",
"description": "Merchant defined English name
店家定義英文名稱"
},
"zh-hant": {
"type": "string",
"description": "Merchant defined Traditional Chinese name
店家定義繁體中文名稱"
},
"zh-cn": {
"type": "string",
"description": "Merchant defined Simplified Chinese name
店家定義簡體中文名稱"
},
"vi": {
"type": "string",
"description": "Merchant defined Vietnamese name
店家定義越南文名稱"
},
"ms": {
"type": "string",
"description": "Merchant defined Malaysian name
店家定義馬來西亞文名稱"
},
"ja": {
"type": "string",
"description": "Merchant defined Japanese name
店家定義日文名稱"
},
"th": {
"type": "string",
"description": "Merchant defined Thai name
店家定義泰文名稱"
},
"id": {
"type": "string",
"description": "Merchant defined Indian name
店家定義印度文名稱"
},
"de": {
"type": "string",
"description": "Merchant defined Deutsch name
店家定義德文名稱"
},
"fr": {
"type": "string",
"description": "Merchant defined France name
店家定義法文名稱"
}
}
},
"Channel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "5ce0d084e388096bdb229a59"
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/Translatable"
},
{
"description": "Name Translations
名稱"
}
]
},
"platform": {
"description": "Shopee
\nshop_crm
\nonline
\npos
\nsc",
"type": "string",
"enum": [
"Shopee",
"shop_crm",
"online",
"pos",
"sc"
]
},
"merchant_id": {
"type": "string"
},
"updated_at": {
"type": "string",
"example": "2018-07-31T03:57:36.409+00:00"
},
"created_at": {
"type": "string",
"example": "2018-07-31T03:57:36.409+00:00"
},
"currency_code": {
"type": "string"
},
"merchant_name": {
"type": "string"
},
"default_warehouse_id": {
"type": "string",
"example": "5ce0d084e388096bdb229a59"
},
"identifier": {
"type": "string",
"example": "00222333"
},
"phones": {
"type": "object",
"properties": {
"main": {
"type": "string",
"example": "0912345678"
}
}
},
"address": {
"type": "object",
"example": {
"address_1": "1/F, Some Building",
"city": "City",
"state": "Perak",
"postcode": "36500",
"country": "Malaysia",
"country_code": "MY"
}
},
"pin_codes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": ""
},
"scope": {
"type": "string",
"example": "switch_store"
}
}
}
},
"mobile_logo_media_url": {
"type": "string"
},
"e_invoice_setting": {
"type": "object",
"description": "only expose this object when the request_params include_fields contains e_invoice_setting value and the merchant of the channel has sl_pos_one_einvoice_setting rollout_key",
"properties": {
"invoice_type": {
"type": "string",
"description": "invoice setting type",
"enum": [
"none",
"tradevan",
"cetustek"
],
"example": "none"
},
"invoice": {
"type": "object",
"description": "only show this object when invoice_type is cetustek",
"properties": {
"tax_id": {
"type": "string",
"description": "發票統一編號"
},
"source": {
"type": "object",
"description": "merchant invoice information",
"properties": {
"business_entity": {
"type": "string",
"description": "營業人名稱"
}
}
}
}
},
"invoice_tradevan": {
"type": "object",
"description": "only show this object when invoice_type is tradevan",
"properties": {
"tax_id": {
"type": "string",
"description": "發票統一編號"
},
"source": {
"type": "object",
"description": "merchant invoice information",
"properties": {
"business_entity": {
"type": "string",
"description": "營業人名稱"
},
"business_type_code": {
"type": "string",
"description": "事業別代號"
}
}
}
}
}
}
}
}
},
"Channels": {
"type": "object",
"properties": {
"pagination": {
"$ref": "#/components/schemas/Paginatable"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Channel"
}
}
}
},
"Paginatable": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"description": "The current page number
當前分頁",
"example": 1
},
"per_page": {
"type": "integer",
"description": "Number of result per page
每頁顯示 n 筆資料
(Default: 24)",
"example": 24
},
"total_count": {
"type": "integer",
"description": "Number of result in total
資料總量",
"example": 1
},
"total_pages": {
"type": "integer",
"description": "Number of pages in total
總頁數量",
"example": 1
}
}
},
"ServerError": {
"type": "object",
"properties": {
"message": {
"description": "A detailed message of the reason of failure",
"example": "Unable to create EventTrackers",
"type": "string"
},
"code": {
"description": "An error code",
"example": "UnknownError",
"type": "string"
}
}
}
}
},
"paths": {
"/channels": {
"get": {
"summary": "Get Channels",
"description": "Get Channels
獲取 Channel 列表",
"parameters": [
{
"name": "belongs_to",
"description": "Channels belongs to staff or merchant. Default is staff
網店通路或是 Staff 的通路，預設為 staff",
"in": "query",
"schema": {
"type": "string",
"enum": [
"staff",
"merchant"
]
},
"example": "staff"
},
{
"name": "platform",
"description": "Filter channels by platform. It can only filter channel by sc or shop_crm if belogs_to is staff.
過濾通路屬於哪個平台，如果 belongs_to 為 staff 則只能過濾 sc 或是 shop_crm 通路。",
"in": "query",
"schema": {
"type": "string",
"enum": [
"Shopee",
"shop_crm",
"online",
"pos",
"sc"
]
},
"example": "shop_crm"
},
{
"name": "platforms",
"description": "Filter multiple channels by platforms. It can only filter channel by sc or shop_crm if belogs_to is staff.
過濾通路屬於哪些平台，如果 belongs_to 為 staff 則只能過濾 sc 或是 shop_crm 通路。",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Shopee",
"shop_crm",
"online",
"pos",
"sc"
]
},
"example": [
"shop_crm",
"online"
]
}
},
{
"name": "include_fields",
"description": "Some fields need to be specified in this parameter. Otherwise, it will not be returned.
有些欄位需要定義在此參數內，否則將不會返回這些欄位的值。",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"e_invoice_setting",
"pin_codes"
]
},
"example": [
"e_invoice_setting"
]
}
},
{
"name": "fields",
"description": "For mobile logo media, need to add items.mobile_logo_media_url to this field.
mobile logo media 必須加入 items.mobile_logo_media_url 到此欄位。",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"items.mobile_logo_media_url"
]
},
"example": [
"items.mobile_logo_media_url"
]
}
},
{
"name": "page",
"description": "Page number
頁數",
"in": "query",
"required": false,
"schema": {
"type": "integer"
},
"example": 1
},
{
"name": "per_page",
"description": "Numbers of channels per page
每頁顯示資料筆數",
"in": "query",
"required": false,
"schema": {
"type": "integer"
},
"example": 24
}
],
"tags": [
"Channels"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Channels"
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Unable to process the changes [\"platform\" is required]"
}
}
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerError"
},
"examples": {
"1": {
"summary": "Unknown error",
"value": {
"message": "Unable to get index",
"code": "UNKNOWN"
}
}
}
}
}
}
}
}
}
}
}
```