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

ParameterColumn TypeDescriptionExample
idStringAddon Product ID
ๅŠ ่ณผๅ“ID
pageIntergerPage Number
้ ๆ•ธ๏ผˆ็ฌฌn้ ๏ผ‰
(Default: 1)
ruby page=2
per_pageIntegerNumbers of Add-on
Products Per Page
ๆฏ้ ้กฏ็คบ n ็ญ†่ณ‡ๆ–™
(Default: 24)
ruby per_page=10
statusStringStatus
ๅ•†ๅ“็‹€ๆ…‹

- Status๏ผš
activeไธŠๆžถ
draft ไธ‹ๆžถ
ruby status=active
sort_byString## Sort by created_atdesc ้™ๅ†ชascๅ‡ๅ†ชruby sort_by=desc sort_by=asc
skuStringSKU
่ฒจ็‰ฉ็ทจ่™Ÿ
ruby sku=fru001
quantityIntegerQuantity
ๆ•ธ้‡

- *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_atDateTimeUpdate 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_atDateTimeCreated 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

FieldColumn TypeDescriptionExample
itemsGet AddonProductsArray of addon products
ๅŠ ่ณผๅ“่ณ‡่จŠ
Please check the link on the left
paginationPaginationPagination 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
    }
}