Get Products

Description

取得商品。

Resource

GET /v1/products

Authorization

採用 OAuth 2.0 Bearer Token，詳細使用流程請參考 Auth Login。

Query Parameters

Name	Type	Description
store_id	string	門市代碼
category_id	integer	商品類別編號 (optional)
keyword	string	關鍵字 (optional)
id	string	商品代碼 (optional)
pickup_time	string	取貨時間 (optional) EXAMPLE "15:30"
has_coupon	string	是否取得票券商品 (optional) EXAMPLE TRUE=取得，FALSE=不取得
model	string (enum)	模式 ALLOWED VALUES: ALL BY_CATEGORY：僅回傳類別/點單區內的商品 (optional)

Request Example

GET /v1/products?store_id=A106&category_id=12&keyword=低熱量&id=UC00000011&pickup_time=15:30&has_coupon=TRUE

Response

{
  "products": [
    {
      "id": "UC00000011",
      "title": "椒鹽雞塊(單點)",
      "second_title": "",
      "abbreviated_title": "雞塊",
      "categories": [
        {
          "id": "281",
          "title": "單品類(炸)"
        }
      ],
      "memo": "",
      "spec": "300G",
      "unit": "PCS",
      "barcode": "",
      "tax": 0.05,
      "tax_sign": "",
      "price": 80,
      "enable": true,
      "is_combo": false,
      "is_package": false,
      "is_combo_item": false,
      "is_float": false,
      "is_stop_sale": false,
      "can_get_points": false,
      "can_redeemed": false,
      "spend_points": 0,
      "combo_price": 0,
      "package_price": null,
      "origin": "台灣",
      "element": "",
      "caloric": "",
      "img": "http://40.83.96.208:8080/kiosk/app/public/product00/5839-1-1550816490_s.png",
      "description": null,
      "description_url": null,
      "special_price": null,
      "spec_html": null,
      "spec_url": null,
      "promotion_content": "2入1500",
      "EC_url": "https://www.leezen.com.tw/",
      "tags": "熱門商品, 本日熱賣",
      "brand": "梁社漢排骨",
      "is_hidden ": false,
      "introduction": null,
      "app_product_name": null,
      "sale_start": "08:00",
      "sale_end": "12:00",
      "gencods": [
        "1234520211123",
        "1234620211123"
      ],
      "member_discount_rate": 50,
      "position": 1,
      "limitations": {
        "quantity": 16,
        "start_time": "2023-08-30 12:00:00",
        "end_time": "2023-08-30 15:00:00"
      },
      "single_price": 80.0,
      "default_data_price": 0
    }
  ]
}

Response Body Parameters

Name	Type	Description
products	Product	商品列表

Response Body Parameters - Product

Name	Type	Description
id	string	商品編號
title	string	商品第一名稱
second_title	string	商品第二名稱
abbreviated_title	string	商品簡稱
categories	Category	商品類別
memo	string	商品備註
spec	string	規格
unit	string	單位
barcode	string	條碼
tax	integer	稅額
tax_sign	string	稅別
price	integer	價格
enable	Boolean	啟用
is_combo	Boolean	是否為套餐
is_package	Boolean	是否為系列組合
is_combo_item	Boolean	是否為套餐子項目
is_float	Boolean	是否為浮動價
is_coupon	Boolean	是否為票券商品
is_stop_sale	Boolean	是否為停售商品
can_get_points	Boolean	是否可累積點數
can_redeemed	Boolean	是否可用點數兌換
spend_points	integer	兌換所需點數
combo_price	integer	組合餐價格
package_price	integer	系列組合價格
origin	string	產地
element	string	成份
caloric	string	熱量
img	string	圖檔URL
description	string	描述
description_url	string	描述URL
special_price	string	特價
spec_html	string	規格(HTML格式)
spec_url	string	規格URL
promotion_content	string	促銷內容
EC_url	string	EC官網URL
tags	string	標籤
brand	string	品牌
is_hidden	Boolean	是否隱藏
introduction	string	簡介
app_product_name	string	APP商品名稱
sale_start	string EXAMPLE "12:00"	開始銷售時間
sale_end	string EXAMPLE "12:00"	結束銷售時間
gencods	List[string]	國際條碼
member_discount_rate	integer	會員折扣率
size_child_products	Product	尺寸子商品列表 (optional)
default_size_child_product_id	string	預設尺寸子商品編號 (optional)
type	string (enum)	商品類型 ALLOWED VALUES: GENERAL_PRODUCT SIZE_MAIN_PRODUCT SIZE_CHILD_PRODUCT
position	integer	位置
limitations	string	限量商品資訊
single_price	float	單品金額(單品原價金額+預選加值金額) (optional)
default_data_price	float	預設資料金額(預選品項金額+預選加值金額) (optional)

Response Body Parameters - Category

Name	Type	Description
id	string	分類編號
title	string	分類名稱