Home
API Reference

Search Products

post
https://open.shopline.io/v1/products/search

To search products with specific conditions.
利用特殊條件搜尋商品列表。

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Parameters for searching products

integer

Page Number
頁數（第n頁）

integer

每頁顯示 n 筆資料，建議最多 50 筆
If there're many products, set per_page to 50

string

支援 product_name、sku、barcode 的模糊查詢

string

商品 ID，支援等於、不等於、in 多筆查詢

string

商品分類 ID，支援以逗號分隔多筆

string
enum

商品狀態

Allowed:
string
enum

排序類型，預設為 created_at

Allowed:
string
enum

排序方向，預設為 desc。當 sort_type 為 quantity_sold 時只能為 desc。

Allowed:
string

商品貨號，支援等於、不等於、in 多筆查詢

string

條碼，支援等於、不等於、in 多筆查詢

boolean

是否為預購商品

string

規格數量，支援 lt/lte/gt/gte/not 等查詢

string

Variation 數量查詢條件，語法同 quantity

boolean

是否為無限數量

string

建立時間，支援比較運算子（gt/gte/lt/lte）

string

更新時間，支援比較運算子

string

標題關鍵字（多語系）

string

摘要關鍵字（多語系）

string

標籤關鍵字

excludes
array of strings

要排除的欄位

excludes
fields
array of strings

僅顯示的欄位

fields
include_fields
array of strings

要額外包含的欄位

include_fields
string
enum

POS 商品上架狀態

Allowed:
boolean

是否包含組合商品

boolean

是否可購買

boolean

是否為 Root Product 查詢模式（僅看 supplier_id 和 pos_category_id）

string

供應商 ID（root_product 為 true 時使用）

string

POS 分類 ID（root_product 為 true 時使用）

string

商品類型（如 product_set）

string

上一頁最後一筆的 ID（用於 cursor-based 分頁）

boolean

是否允許作為贈品

Responses

Updated about 1 month ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago