Smart Collections
Access smart collection data for advanced product grouping and promotion targeting. Requires READ_SMART_COLLECTIONS permission.
Base URL: /api/v3/partner/loyalty
Endpoints Overview
| Method | Endpoint | Description |
|---|---|---|
| GET | /smartcollections | Get Smart Collections. Required Smart Collections permission. |
| GET | /smartcollections/{smartCollectionId} | Get Smart Collections. Required Smart Collections permission. |
Get Smart Collections. Required Smart Collections permission.
GET /api/v3/partner/loyalty/smartcollections
Retrieve a paginated list of smart collections for advanced product grouping and promotion targeting. Each collection contains a set of rules that define which products are included or excluded based on criteria like brand, category, vendor, or tags. Results are capped at 200 per page. Requires the READ_SMART_COLLECTIONS partner permission.
Required Permission
READ_SMART_COLLECTIONS
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
start | integer | No | Number of records to skip |
limit | integer | No | Maximum records to return |
Response
Returns a paginated SearchResult of SmartCollectionRes objects.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Name |
description | string | No | Description |
rules | SmartCollectionRule[] | No | Rules |
{
"name": "string",
"description": "string",
"rules": [
{
"rangeBased": false
}
]
}
Get Smart Collections. Required Smart Collections permission.
GET /api/v3/partner/loyalty/smartcollections/{smartCollectionId}
Retrieve a single smart collection by its ID. Returns the collection details including all filtering rules. Requires the READ_SMART_COLLECTIONS partner permission.
Required Permission
READ_SMART_COLLECTIONS
Path Parameters
| Parameter | Type | Description |
|---|---|---|
smartCollectionId | string | The smart collection i d |
Response
Returns a SmartCollectionRes object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Name |
description | string | No | Description |
rules | SmartCollectionRule[] | No | Rules |
{
"name": "string",
"description": "string",
"rules": [
{
"rangeBased": false
}
]
}