v1
latestOpenAPI 3.0.02026-07-26318168886.7 KBProducts
Get Products
To get detailed information of couple products sorted by time<br>利用時間範圍選取與排序獲取數筆商品資料
get/products
Query parameters
previous_idstring
The last ID of the products in the previous request.<br>前一筆商品的 ID <br>beta 測試中，僅開放部分店家使用，如無法使用功能請聯絡客服窗口
sort_by'asc' | 'desc'
Setting sort by created time<br>設定創建時間排序
per_pageinteger
Numbers of Products per page<br>每頁顯示 n 筆資料
pageinteger
Page Number<br>頁數
excludes[]string
Could exclude certain parameters in the response<br>結果要排除哪些參數
fields[]string[]
Could only show certain parameters in the response<br>結果只顯示哪些參數
[ "items.status" ]
idstring
Only show specific products based on IDs<br>結果只顯示哪些商品
include_fields[]string[]
Provide additional attributes in the response<br>結果添加哪些參數
with_product_setboolean
Return product_set or not<br>是否回傳組合商品
updated_afterstring
Filter products by specific updated_after time.<br>取得大於等於指定時間的商品<br> *Should use UTC time'
updated_beforestring
Filter products by specific updated_before time.<br>取得小於等於指定時間的商品<br> *Should use UTC time'
sortsstring[]
Specify sorting rules. Supports up to two levels of sorting.<br> Currently only supports sorting by sold_out and create_at.<br> If sold_out & updated_after are queried, the removed items will be excluded.<br> 用於設定資料的排序方式，支援最多兩層排序.<br> 若參數帶入 sold_out& updated_after，將不會回覆已刪除的商品<br>
Response
OK
Example response
{
"items": [
{
"id": "5d3594c276e7ec003b7021c0",
"status": "active",
"retail_status": "active",
"title_translations": {
"en": "testing SL-8049",
"zh-hant": "測試 SL-8049 round 2"
},
"summary_translations": {
"en": "testing SL-8049",
"zh-hant": "測試 SL-8049 round 2"
},
"price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"price_sale": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"lowest_price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"lowest_price_sale": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"same_price": true,
"cost": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"member_price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"retail_price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"flash_price_sets": [
{
"price_set": {
"price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"price_sale": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"price_details": [
{
"price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"price_sale": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
}
}
]
}
}
],
"preorder_limit": 1,
"preorder_note_translations": {
"en": "Shipping starts April 20th, 1971, preorder NOW!",
"zh-hant": "1971/04/20 開始出貨, 立即訂購!"
},
"weight": 123.99,
"quantity": 87,
"total_orderable_quantity": 87,
"medias": [
{
"id": "5f8e5dc08a8bb70a5c9cd93c",
"alt_translations": {
"en": "Image ALT",
"zh-hant": "圖片ALT"
},
"images": {
"original": {
"width": 800,
"height": 800,
"url": "https://img.example.com/media/1234/thumb.jpg"
}
}
}
],
"detail_medias": [
{
"id": "5f8e5dc08a8bb70a5c9cd93c",
"alt_translations": {
"en": "Image ALT",
"zh-hant": "圖片ALT"
},
"images": {
"original": {
"width": 800,
"height": 800,
"url": "https://img.example.com/media/1234/thumb.jpg"
}
}
}
],
"category_ids": [
"5be90603d1270b4032bed8b4"
],
"sku": "sku_123345",
"field_titles": [
{
"key": "color",
"label": "Color",
"name_translations": {
"en": "Color",
"zh-hant": "顏色"
},
"selectorEnabled": false
},
{
"key": "custom",
"label": "Custom",
"name_translations": {
"en": "Custom1",
"zh-hant": "自訂1"
},
"selectorEnabled": false
}
],
"variations": [
{
"id": "5d3594c2e95d2f000642e011",
"price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"price_sale": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"member_price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"retail_price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"cost": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"quantity": 100,
"total_orderable_quantity": 100,
"preorder_limit": 1,
"media": {
"id": "5f8e5dc08a8bb70a5c9cd93c",
"alt_translations": {
"en": "Image ALT",
"zh-hant": "圖片ALT"
},
"images": {
"original": {
"width": 800,
"height": 800,
"url": "https://img.example.com/media/1234/thumb.jpg"
}
}
},
"sku": "green_l1",
"location_id": "LaB123",
"feed_variations": {
"color": {
"zh-hant": "紅色",
"en": "red"
},
"size": {
"zh-hant": "xs",
"en": "xs"
}
},
"variant_option_ids": [
"5d3594c2622a56618082c99f",
"5d3594c2622a56618082c9a0"
],
"locked_inventory_count": 10,
"weight": 1.2
}
],
"variant_options": [
{
"id": "5d3594c2622a56618082c99f",
"name_translations": {
"en": "green",
"zh-hant": "綠"
},
"type": "custom",
"media": {},
"index": 0
},
{
"id": "5d3594c2622a56618082c9a0",
"name_translations": {
"en": "L1",
"zh-hant": "大1"
},
"type": "custom",
"media": {},
"index": 1
},
{
"id": "5d3594c2622a56618082c9a1",
"name_translations": {
"en": "S1",
"zh-hant": "小1"
},
"type": "custom",
"media": {},
"index": 1
},
{
"id": "5d3594c2622a56618082c9a2",
"name_translations": {
"en": "Red",
"zh-hant": "紅"
},
"type": "custom",
"media": {},
"index": 0
}
],
"location_id": "shoplineabc",
"feed_category": {
"google_category_id": "animals_pet_supplies",
"google_option_id": "live_animals",
"google_product_category": "Animals & Pet Supplies > Live Animals"
},
"feed_variations": {
"color": "red",
"size": "small",
"material": "gold"
},
"seo_keywords": "電商, 開店, 創業",
"related_product_ids": [
"5d3593cd5722660032e8fbed",
"5d355b7b0e5da9001741ac2c"
],
"max_order_quantity": 4,
"blacklisted_feed_channels": [
"google"
],
"updated_at": "2020-12-09T07:15:06.813+00:00",
"created_at": "2020-11-23T02:31:32.926+00:00",
"created_by": "openapi",
"is_excluded_promotion": true,
"taxable": true,
"labels": [
{
"en": "ABC",
"zh-hant": "ddd"
}
],
"locked_inventory_count": 10,
"schedule_publish_at": "2020-11-23T02:31:32.926+00:00",
"product_price_tiers": [
{
"_id": "610cdc702c1c120047c3519c",
"created_at": "2021-08-06T06:55:45.471Z",
"updated_at": "2021-08-06T06:55:45.471Z",
"member_price": {
"cents": 999999999,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$999,999,999",
"dollars": 999999999
},
"membership_tier_id": "5de6192b9a8b7900365abb5b",
"product_id": "5d3594c276e7ec003b7021c0",
"status": "active",
"variation_key": "610cdcf19f09bc003a2139a4"
}
],
"metafields": {
"namespace": {
"key1": "value",
"key2": 3,
"key3": {
"json": "object"
}
}
},
"subscription_enabled": true,
"subscription_period_duration": 30,
"subscription_recurring_count_limit": 5,
"filter_tags": [
{
"id": "5d3594c2e95d2f000642e011"
}
],
"bundle_set": {
"price_type": "fixed_amount",
"discount_value": 20,
"bundle_set_products": {
"6200c988dcf97a004b22ec26": {
"min_quantity": 1
}
}
},
"type": "product",
"allow_gift": true,
"is_custom": true,
"sold_out": true,
"cart_tag_id": "63ec73c11ac51b368c74b92b",
"cart_tag": {
"id": "63ec73c11ac51b368c74b92b",
"name_translations": {
"en": "",
"zh-hant": "一車常溫"
},
"priority": 1
}
}
],
"pagination": {
"current_page": 1,
"per_page": 24,
"total_count": 1,
"total_pages": 1
}
}