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_pageexceeds 10,000.- Example: If
per_page= 50, the maximum value forpageshould 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 about 2 months ago