Home
Guides
Start typing to search…

Search Addon Products

🚧

Breaking Changes

Jul. 30, 2025 拿取商品相關資訊 API 異動公告 Products related API Breaking Change

Function

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

URL

GET <<api_domain>>/v1/addon_products/search

Request Parameters

Parameter

Column Type

Description

Example

id

String

Addon Product ID
加購品ID

page

Interger

Page Number
頁數（第n頁）
(Default: 1)

ruby
page=2

per_page

Integer

Numbers of Add-on
Products Per Page
每頁顯示 n 筆資料
(Default: 24)

ruby
per_page=10

status

String

Status
商品狀態

  • Status：
    • active上架
    • draft 下架
ruby
status=active

sort_by

String

Sort by created_atdesc 降冪asc升冪

ruby
sort_by=desc
sort_by=asc

sku

String

SKU
貨物編號

ruby
sku=fru001

quantity

Integer

Quantity
數量

  • *Support equal or not equal or less than or less than or equal or greater than or greater than or equal
    支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於
ruby
quantity=100
quantity=not:100
quantity=lt:100
quantity=lte:100
quantity=gt:100
quantity=gte:100

updated_at

DateTime

Update Time
更新時間

  • *Support equal or not equal or less than or less than or equal or greater than or greater than or equal
    支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於
ruby
updated_at=2018-11-11 12:30:30
updated_at=not: 2018-11-11 12:30:30
updated_at=lt: 2018-11-11 12:30:30
updated_at=lte: 2018-11-11 12:30:30
updated_at=gt: 2018-11-11 12:30:30
updated_at=gte: 2018-11-11 12:30:30

created_at

DateTime

Created Time
創建時間

  • *Support equal or not equal or less than or less than or equal or greater than or greater than or equal
    支援 等於 或 不等於 或 小於 或 小於等於 或 大於 或 大於等於
ruby
created_at=2018-11-11 12:30:30
created_at=not: 2018-11-11 12:30:30
created_at=lt: 2018-11-11 12:30:30
created_at=lte: 2018-11-11 12:30:30
created_at=gt: 2018-11-11 12:30:30
created_at=gte: 2018-11-11 12:30:30
🚧

Note

Please note the following pagination limitations when using this API:

  • The request will fail if page * per_page exceeds 10,000.
  • Example: If per_page = 50, the maximum value for page should be 200. Exceeding this value will result in an error.

使用此 API 時，請注意以下分頁限制：

  • 當 page * per_page 大於 10,000 時，請求將會失敗。
  • 範例：如果 per_page = 50，page 最大值應為 200，超過此值請求將會失敗。

Response Fields

Field

Column Type

Description

Example

items

Get AddonProducts

Array of addon products
加購品資訊

Please check the link on the left

pagination

Pagination

Pagination Data
頁面資訊

Please check the link on the left

Response Example

{
    "items": [
        {
            "id": "5892d8679f9a4fc07b008295",
            "status": "draft",
            "title_translations": {
                "en": "Addon Products",
                "zh-hant": "加購品"
            },
            "price": null,
            "quantity": 10,
            "unlimited_quantity": false,
            "tax_type": null,
            "oversea_tax_type": 1,
            "medias": [
                {
                    "images": {
                        "original": {
                            "width": 740,
                            "height": 416,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d84259d5241718001040/original.jpg?1486018626"
                        },
                        "landscape": {
                            "width": 740,
                            "height": 416,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d84259d5241718001040/original.jpg?1486018626"
                        },
                        "source": {
                            "width": 740,
                            "height": 416,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d84259d5241718001040/source.jpg?1486018626"
                        },
                        "thumb": {
                            "width": 200,
                            "height": 200,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d84259d5241718001040/thumb.jpg?1486018626"
                        },
                        "medium": {
                            "width": 250,
                            "height": 141,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d84259d5241718001040/medium.jpg?1486018626"
                        },
                        "large": {
                            "width": 500,
                            "height": 281,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d84259d5241718001040/large.jpg?1486018626"
                        },
                        "xlarge": {
                            "width": 740,
                            "height": 416,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d84259d5241718001040/xlarge.jpg?1486018626"
                        },
                        "favicon_small": {
                            "width": 200,
                            "height": 200,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d84259d5241718001040/thumb.jpg?1486018626"
                        },
                        "favicon": {
                            "width": 200,
                            "height": 200,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d84259d5241718001040/thumb.jpg?1486018626"
                        },
                        "favicon_large": {
                            "width": 200,
                            "height": 200,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d84259d5241718001040/thumb.jpg?1486018626"
                        },
                        "transparent_thumb": {
                            "width": 200,
                            "height": 200,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d84259d5241718001040/thumb.jpg?1486018626"
                        },
                        "transparent_medium": {
                            "width": 250,
                            "height": 141,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d84259d5241718001040/medium.jpg?1486018626"
                        },
                        "transparent_large": {
                            "width": 500,
                            "height": 281,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d84259d5241718001040/large.jpg?1486018626"
                        },
                        "transparent_xlarge": {
                            "width": 740,
                            "height": 416,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d84259d5241718001040/xlarge.jpg?1486018626"
                        }
                    },
                    "_id": "5892d84259d5241718001040",
                    "alt_translations": {}
                }
            ],
            "sku": "addon_product_sku"
        },
        {
            "id": "5892d83c9f9a4fd05f01c23e",
            "status": "draft",
            "title_translations": {
                "zh-hant": "add watch"
            },
            "price": null,
            "quantity": 1,
            "unlimited_quantity": false,
            "tax_type": null,
            "oversea_tax_type": 1,
            "medias": [
                {
                    "images": {
                        "original": {
                            "width": 225,
                            "height": 225,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d8019f9a4fd24c01beff/original.jpeg?1486018560"
                        },
                        "landscape": {
                            "width": 225,
                            "height": 225,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d8019f9a4fd24c01beff/original.jpeg?1486018560"
                        },
                        "source": {
                            "width": 225,
                            "height": 225,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d8019f9a4fd24c01beff/source.jpg?1486018560"
                        },
                        "thumb": {
                            "width": 200,
                            "height": 200,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d8019f9a4fd24c01beff/thumb.jpg?1486018560"
                        },
                        "medium": {
                            "width": 225,
                            "height": 225,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d8019f9a4fd24c01beff/medium.jpg?1486018560"
                        },
                        "large": {
                            "width": 225,
                            "height": 225,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d8019f9a4fd24c01beff/large.jpg?1486018560"
                        },
                        "xlarge": {
                            "width": 225,
                            "height": 225,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d8019f9a4fd24c01beff/xlarge.jpg?1486018560"
                        },
                        "favicon_small": {
                            "width": 200,
                            "height": 200,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d8019f9a4fd24c01beff/thumb.jpg?1486018560"
                        },
                        "favicon": {
                            "width": 200,
                            "height": 200,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d8019f9a4fd24c01beff/thumb.jpg?1486018560"
                        },
                        "favicon_large": {
                            "width": 200,
                            "height": 200,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d8019f9a4fd24c01beff/thumb.jpg?1486018560"
                        },
                        "transparent_thumb": {
                            "width": 200,
                            "height": 200,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d8019f9a4fd24c01beff/thumb.jpg?1486018560"
                        },
                        "transparent_medium": {
                            "width": 225,
                            "height": 225,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d8019f9a4fd24c01beff/medium.jpg?1486018560"
                        },
                        "transparent_large": {
                            "width": 225,
                            "height": 225,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d8019f9a4fd24c01beff/large.jpg?1486018560"
                        },
                        "transparent_xlarge": {
                            "width": 225,
                            "height": 225,
                            "url": "https://img.shoplineapp.com/media/image_clips/5892d8019f9a4fd24c01beff/xlarge.jpg?1486018560"
                        }
                    },
                    "_id": "5892d8019f9a4fd24c01beff",
                    "alt_translations": {}
                }
            ],
            "sku": null
        }
    ],
    "pagination": {
        "current_page": 1,
        "per_page": 10,
        "total_pages": 1,
        "total_count": 2
    }
}

Updated 13 days ago