---
title: "Get Categories"
method: GET
path: "/categories"
tags: ["Categories"]
---

# Get Categories

`GET /categories`

To get detailed information of couple categories sorted by time<br>利用時間範圍選取與排序獲取分類資料

## Query parameters

- `previous_id` string
- `updated_after` string
- `updated_before` string
- `page` integer
- `per_page` integer
- `excludes[]` string[]
- `fields[]` string[]
- `created_by_filter` 'admin' | 'pos'
- `with_product_set` boolean
- `include_fields[]` string[]
- `category_ids[]` string[]

## Response `200`

OK

- object
  - `items` Category[]
    - `id` string — Category ID<br>分類ID
    - `name_translations` object — Name<br>分類名稱
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `seo_title_translations` object — SEO Title<br>SEO標題
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `seo_description_translations` object — SEO Description<br>SEO簡介
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `seo_keywords` string — SEO Keyword<br>SEO 關鍵字
    - `key` string — Special category<br>特殊分類鍵
    - `sort_setting` string — sort setting<br>排序設定
    - `status` 'active' | 'removed' — Status<br>狀態
    - `banner_medias` object[] — Banner Medias<br>分類橫圖
      - `image` object
        - `original` object
          - `width` number
          - `height` number
          - `url` string
      - `_id` string
      - `alt_translations` object
      - `link` object
      - `new_tab` object
    - `parent_id` string — Parent Category ID<br>母分類ID
    - `priority` number, float — Weight to control sorting<br>分類權重
    - `created_by` 'admin' | 'pos' — Created By<br>創造來自
    - `children` object[] — Array of Sub Categories Information<br>子分類資訊序列
    - `product_count` integer — Product count, only available for /v1/categories with<br> params include_fields[] have value 'product_count'<br> 商品數目, 只適用於連同參數 include_fields[] 等於 'product_count' 時呼叫 /v1/categories
  - `pagination` Paginatable
    - `current_page` integer — The current page number<br>當前分頁
    - `per_page` integer — Number of result per page<br>每頁顯示 n 筆資料<br>(Default: 24)
    - `total_count` integer — Number of result in total<br>資料總量
    - `total_pages` integer — Number of pages in total<br>總頁數量

## Other responses

- `500` — Server error

---

[API](https://skmtc.dev/shoplineapp/apis/shopline-open-api.md) · [All operations](https://skmtc.dev/shoplineapp/apis/shopline-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/shoplineapp/shopline-open-api/revisions/1675ac12cde7/schema)