Sign in

v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB
Addon Products

Search Addon Products

To search add-on products with specific conditions.<br>利用特殊條件搜尋加購品列表

get/addon_products/search

Query parameters

previous_idstring

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

idstring

Addon Product ID<br>加購品ID

pageinteger

Page<br>頁數<br>(Default: 1)

per_pageinteger

Numbers of Orders per page<br>每頁顯示 n 筆資料<br>(Default: 24, Max: 999)

status'active' | 'draft'

Status<br>商品狀態

sort_by'desc' | 'asc'

Sort by created_at

skustring

SKU<br>貨物編號

quantitystring

Quantity<br>數量<br>-<br>*Support equal or not equal or less than or less than or equal or greater than or greater than or equal<br>支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於<br> quantity=100<br> quantity=not:100<br> quantity=lt:100<br> quantity=lte:100<br> quantity=gt:100<br> quantity=gte:100<br>

updated_atstring

Update Time<br>更新時間<br>-<br>*Support equal or not equal or less than or less than or equal or greater than or greater than or equal<br>支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於<br> Example: "gt:2018-11-11 12:30:30"

created_atstring

Created Time<br>創建時間<br>-<br>*Support equal or not equal or less than or less than or equal or greater than or greater than or equal<br>支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於<br><br>Please fill in to the second level. Default value is 00:00:00 if only fill in dates.<br>請輸入至秒數，若只輸入日期，則會自動帶入當天00:00:00

include_fields[]string[]

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

Response

OK

Example response

{
  "items": [
    {
      "id": "5892d8679f9a4fc07b008295",
      "status": "draft",
      "title_translations": {
        "en": "Addon Products",
        "zh-hant": "加購品"
      },
      "weight": 10.2,
      "quantity": 10,
      "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"
          }
        }
      },
      "sku": "addon_product_sku",
      "created_at": "2019-12-30T09:16:46.142+00:00",
      "promotions": [
        {
          "discounted_price": {
            "cents": 999999999,
            "currency_symbol": "NT$",
            "currency_iso": "TWD",
            "label": "NT$999,999,999",
            "dollars": 999999999
          },
          "start_at": "2020-07-09T04:00:00.000+00:00",
          "end_at": "2020-07-09T04:00:00.000+00:00"
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 24,
    "total_count": 1,
    "total_pages": 1
  }
}