Home
API Reference

Search Products

get
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…
Query Params
string

The last ID of the products in the previous request.
前一筆商品的 ID
beta 測試中，僅開放部分店家使用，如無法使用功能請聯絡客服窗口

integer
Defaults to 1

Page Number
頁數（第n頁）

integer
Defaults to 24

Numbers of Products per page
每頁顯示 n 筆資料
*If there're many products, it's suggested to set per_page number to 50
如果商品眾多，建議per_page至多設定50

string

Support query order fields
支援搜尋以下欄位
product_name
sku
barcode

string

Product's ID
商品ID
Support equal, not equal and multiple search.
支援 等於，不等於及多重搜尋

string

Categories
分類
*Accept category ids spilt by ","
接受同時數個分類id，以","隔開

string
enum

Status
商品狀態

Allowed:
string
enum

Sort type. Default value is created_at.

Allowed:
string
enum

Sort order by sort_type. Default value is desc.
When sort_type is 'quantity_sold', only 'desc' is allowed.

Allowed:
string

sku
商品貨號
Support equal, not equal and multiple search.
支援 等於，不等於及多重搜尋

string

gtin
商品條碼編號
Support equal, not equal and multiple search.
支援 等於，不等於及多重搜尋

boolean

Is Preorder Product or not
是否為預購商品

string

Quantity of Variation
規格數量
Support equal or not equal or less than or less than or equal or greater than or greater than or equal
支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於

string

Quantity of Variation
規格數量
Support equal or not equal or less than or less than or equal or greater than or greater than or equal
支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於

boolean

Is Unlimited Quantity or not
是否為無限數量

string

Support equal or not equal or less than or less than or equal or greater than or greater than or equal
支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於

string

Support equal or not equal or less than or less than or equal or greater than or greater than or equal
支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於

string

Could search any match for all languages that merchant supported,
可以搜出店家支援語系中的任何語系關鍵字

string

Could search any match for all languages that merchant supported,
可以搜出店家支援語系中的任何語系關鍵字

string

Product Tag
產品標籤

string

Could exclude certain parameters in the response
結果要排除哪些參數

string

Could only show certain parameters in the response
結果只顯示哪些參數

include_fields[]
array of strings

Provide additional attributes in the response
結果添加哪些參數

include_fields[]
string
enum

POS Status
POS商品上架狀態

Allowed:
boolean

Search with Product Set
是否包含組合商品

boolean

Is Purchasable Set
是否可購買

boolean

Specifies whether the item can be set as a gift.
是否可以設為贈品
true: the product can be set as a gift.
false: the product cannot be set as a gift.

sorts
array of strings

Specify sorting rules. Supports up to two levels of sorting.
When sort by, order by, and sorts are requested, sorts takes priority.
用於設定資料的排序方式，支援最多兩層排序。sold_out 僅能是第一順位的排序依據
當同時傳入 sort by、order by、sorts 時，系統會優先使用 sorts 的設定

sorts
Responses

Updated 3 months 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 3 months ago