Get Products

get https://open.shopline.io/v1/products

To get detailed information of couple products sorted by time
利用時間範圍選取與排序獲取數筆商品資料

Query Params

sort_by

string

Defaults to desc

Setting sort by created time
設定創建時間排序

per_page

integer

Defaults to 24

Numbers of Products per page
每頁顯示 n 筆資料

page

integer

Defaults to 1

Page Number
頁數

excludes[]

string

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

fields[]

array of strings

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

fields[]

string

Only show specific products based on IDs
結果只顯示哪些商品

previous_id

string

ID of last item in previous page
上一頁最後的item的id

include_fields[]

array of strings

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

include_fields[]

with_product_set

boolean

Defaults to false

Return product_set or not
是否回傳組合商品

Responses

Response body

object

items

array of objects

items

object

string

Product's ID
商品ID

status

string

Product's status
商品狀態
-
true: Published 上架
false: Unpublished 下架
"active": Published 上架
"draft": Unpublished 下架
"hidden": hidden 隱藏

Default: false

active draft removed hidden

retail_status

string

POS product's status
POS商品狀態
-
"active": Published 上架
"draft": Unpublished 下架

Default: active

active draft

title_translations

object

Title translations
商品名稱

summary_translations

object

Summary translations
商品說明

price

object

Price
原價格

price_sale

object

Price on sale
特價

lowest_price

object

The lowest price of product variations if exists
規格商品中的最低價

lowest_price_sale

object

The lowest sale price of product variations if exists
特價規格商品中的最低價

hide_price

boolean

Hide Price to customers
隱藏價格
-
*Default: false

same_price

boolean

Main Product and Variation Product share the same price (Including original price and member price)
規格商品是否皆同主商品價格，包含原價格與會員價
1. If Same price is true, and variation_price is filled
2. If Same price is true, and variation_price is not filled
3. If Same price is false, and variation_price is filled
4. If Same price is false, and variation_price is not filled

cost

object

Cost
成本價

member_price

object

Member Price
會員價

retail_price

object

Retail Price
零售價
Only provided when include_fields contains 'retail_price'
僅於include_fields傳入 'retail_price' 時提供

flash_price_sets

array of objects

price for flash campaign
限時促銷價

flash_price_sets

object

string

start_at

string

end_at

string

price_set

object

created_at

string

updated_at

string

is_preorder

boolean

Pre-ordered or not
是否開放預購

preorder_limit

integer

Pre-ordere Limit
預購上限

preorder_note_translations

object

Title translations
商品名稱

weight

number

Product's Weight (kg)
商品重量 (公斤)

quantity

number

Product's Current quantity
商品目前數量
-
*If unlimited_quantity is true, the product has unlimited quantity
regardless of the quantity showing here

total_orderable_quantity

number

Product's Current total orderable quantity
商品目前可購買總數量
-
*If unlimited_quantity is true or out_of_stock_orderable is true
this field will return -1

unlimited_quantity

boolean

Unlimited product quantity or not.
商品數量是否無限

true

medias

array of objects

Media Data
媒體(照片)資訊

medias

object

string

Media ID

alt_translations

object

Content to display on ALT attribute
在圖片ALT上展示的內容

images

object

Object contains url of image in different dimensions
包含不同大小圖片的連絡

Has additional fields

detail_medias

array of objects

Additional Product Photos
更多商品圖片
Maximum 20 images for a product.
最多 20 張圖片

detail_medias

object

string

Media ID

alt_translations

object

Content to display on ALT attribute
在圖片ALT上展示的內容

images

object

Object contains url of image in different dimensions
包含不同大小圖片的連絡

Has additional fields

category_ids

array of strings

Categories' IDs
商品所屬分類之ID

category_ids

supplier

string

Supplier
供應商

sku

string

Stock Keeping Unit
商品貨號

barcode

string

Product's Barcode
商品條碼編號

quantity_sold

integer

Product's Quantity Sold
商品銷售數量

barcode_type

string

Barcode type
商品條碼編號類別

Code 128 Bookland EAN ISBN

field_titles

array of objects

Field Title Data
規格名稱

field_titles

object

key

string

label

string

name_translations

object

variations

array of objects

Product Variations Data
商品規格資訊

variations

object

string

Product Variation's ID
規格 ID

fields_translations

object

Field Translation
規格名稱

price

object

Price
原價格

price_sale

object

Price on sale
特價

member_price

object

Member Price
會員價

retail_price

object

Retail Price
零售價
Only provided when include_fields contains 'retail_price'
僅於include_fields傳入 'retail_price' 時提供

cost

object

Cost
成本價

quantity

number

Product variation's current quantity
規格現有數量

total_orderable_quantity

number

Product variation's current orderable quantity
規格現有可購買數量

unlimited_quantity

boolean

Whether the variation has unlimited quantity or not.
規格是否有無限數量
*Please check the main product's unlimited_quantity to see whether variation has unlimited quantity or not.

unlimited_quantity of variation will always shows null

preorder_limit

integer

Pre-ordere Limit
預購上限

media

object

Media Data
圖片資料

sku

string

Stock Keeping Unit
貨號

location_id

string

Location ID
儲位編號

feed_variations

object

Default variations for product feed
廣告規格

variant_option_ids

array of strings

ID of the corresponding variant options
對應規格類別 ID

variant_option_ids

barcode

string

Barcode
商品條碼編號

mpn

string

Manufacturer Part Number
製造編號

gtin

string

Barcode
商品條碼編號

barcode_type

string

Barcode type
商品條碼編號類別

Code 128 Bookland EAN ISBN

locked_inventory_count

number

weight

number

Weight (kg)
重量 (公斤)

variant_options

array of objects

Product Variations
商品規格
-
Maximum 3 types of variant option for a product, type allow (color, size, custom_1, custom_2, custom_3)
最多支援三種不同的 type, type 支援(color, size, custom_1, custom_2, custom_3)

variant_options

object

string

name_translations

object

type

string

color size custom_1 custom_2 custom_3

media

object

Has additional fields

index

integer

tags

blacklisted_delivery_option_ids

array of strings

Excluded Delivery Options
排除的送貨方式

blacklisted_delivery_option_ids

blacklisted_payment_ids

array of strings

Excluded Payment
Options
排除的付款方式

blacklisted_payment_ids

max_order_quantity

integer

set maximum quantity per purchase for this product
商品單次購買上限
*-1 represents there's no quantity limit for each purchase
-1代表無商品單次購買的上限

gender

string

Mapping Product Category: Gender
產品使用類別：性別
male 男性
female 女性
* unisex 男女通用

age_group

string

Mapping Product Category:Age Group
產品使用類別：年齡層
newborn 新生兒
infant 嬰兒
toddler 幼兒
kids兒童
* Adult 成人

adult

string

Mapping Product Category:Adult
產品使用類別：成人
yes 是
no 否

condition

string

Mapping Product Category:Condition
產品使用類別：狀況
used 二手
refurbished 整新品
* new 新品

brand

string

Brand
商品品牌

mpn

string

Manufacturer Part Number
製造編號

gtin

string

Barcode
商品條碼編號

blacklisted_feed_channels

array of strings

排除這個商品投放管道
Exclude this product to channel

blacklisted_feed_channels

updated_at

string

Last Updated Time
商品最後更新時間

created_at

string

Product Created Time
商品創建時間

available_start_time

string

available_end_time

string

created_by

string

is_excluded_promotion

boolean

product is exclude promotion which is discount on order
不適用全店折扣的優惠是否開啟

taxable

boolean

taxable
是否收稅

labels

array of objects

product labels
標簽的商品促銷標簽文案

labels

object

string

Merchant defined English name
店家定義英文名稱

zh-hant

string

Merchant defined Traditional Chinese name
店家定義繁體中文名稱

zh-cn

string

Merchant defined Simplified Chinese name
店家定義簡體中文名稱

string

Merchant defined Vietnamese name
店家定義越南文名稱

string

Merchant defined Malaysian name
店家定義馬來西亞文名稱

string

Merchant defined Japanese name
店家定義日文名稱

string

Merchant defined Thai name
店家定義泰文名稱

string

Merchant defined Indian name
店家定義印度文名稱

string

Merchant defined Deutsch name
店家定義德文名稱

string

Merchant defined France name
店家定義法文名稱

locked_inventory_count

number

schedule_publish_at

string

product_price_tiers

array of objects

Product's price for member tier.
適用於指定會員分級的產品價格。

product_price_tiers

object

_id

string

Product price tier's ID
產品價格分級的ID

created_at

string

Product price tier's created time
產品價格分級的創建時間

updated_at

string

Product price tier's updated time
產品價格分級的更新時間

member_price

object

The price that is applied to this member tier
適用於這會員分級的價格

membership_tier_id

string

Membership tier's ID
會員等級ID

product_id

string

Product's ID
商品ID

status

string

Product price tier's status
產品價格分級的狀態

active

variation_key

string

Product variation's ID
產品規格的ID

metafields

object

metafields
only show if include_fields[]=metafields

Has additional fields

out_of_stock_orderable

boolean

out_of_stock_orderable
缺貨時是否可接單

subscription_enabled

boolean

subscription_enabled
是否為定期購商品。

subscription_period_duration

integer

subscription_period_duration
定期購天數

subscription_recurring_count_limit

integer

Subscription recurring count limit
定期購期數

filter_tags

array of objects

filter_tags
自訂篩選條件

filter_tags

object

string

Filter Tag's ID
自訂篩選條件 ID

name_translations

object

Name Translation
自訂篩選名稱

bundle_set

object

bundle_set info
組合商品資訊
Only provided when include_fields contains 'bundle_set'
僅於include_fields傳入 'bundle_set' 時提供

type

string

product type
商品型別
Only provided when include_fields contains 'type'
僅於include_fields傳入 'type' 時提供

tax_type

string

Tax type
國內稅項

oversea_tax_type

string

Oversea tax type
海外稅項

pagination

object

current_page

integer

The current page number
當前分頁

per_page

integer

Number of result per page
每頁顯示 n 筆資料
(Default: 24)

total_count

integer

Number of result in total
資料總量

total_pages

integer

Number of pages in total
總頁數量

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://open.shopline.io/v1/products?sort_by=desc&per_page=24&page=1&with_product_set=false' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

422Unprocessable entity error

500Server error