v1
latestOpenAPI 3.0.02026-07-26318168886.7 KBGifts
Search Gifts
To search gifts with specific conditions.<br>利用特殊條件搜尋贈品列表。
get/gifts/search
Query parameters
previous_idstring
The last ID of the gifts in the previous request.<br>前一筆贈品的 ID <br>beta 測試中，僅開放部分店家使用，如無法使用功能請聯絡客服窗口
idstring
Gift's ID<br>贈品 ID
pageinteger
Page Number<br>頁數（第n頁）
per_pageinteger
Numbers of Gifts per page<br>每頁顯示 n 筆資料
status'active' | 'draft'
Status<br>商品狀態
sort_by'desc' | 'asc'
Sort by created_at
skustring
SKU<br>貨物編號
quantitystring
Quantity<br>數量<br> Support equal or not equal or less than or less than or equal or greater than or greater than or equal<br> 支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於
updated_atstring
Updated Time<br>更新時間<br> Support equal or not equal or less than or less than or equal or greater than or greater than or equal<br> 支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於
created_atstring
Created Time<br>創建時間
Response
OK
Example response
{
"items": [
{
"id": "5b3d860559d52419850001bc",
"status": "active",
"sku": "gift_a",
"quantity": 20,
"weight": 1,
"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"
}
}
},
"unlimited_quantity": true,
"updated_at": "2018-07-05T02:44:59.596+00:00",
"created_at": "2018-07-05T02:44:21.073+00:00",
"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
}
],
"field_titles": [
{
"key": "color",
"label": "Color",
"name_translations": {
"en": "Color",
"zh-hant": "顏色"
}
},
{
"key": "custom",
"label": "Custom",
"name_translations": {
"en": "Custom1",
"zh-hant": "自訂1"
}
}
],
"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
}
]
}
],
"pagination": {
"current_page": 1,
"per_page": 24,
"total_count": 1,
"total_pages": 1
}
}