/collections
Loads a list of customers or information on a single customer.
URL parameters
Parameters that you can append to the URL, for example: ?parameter=value
Title | Type | Description | Required? |
---|---|---|---|
id | int | ID of a single collection to load. Can be used after the slash. | No |
page | int | Number of the page to load. Defaults to 1 | No |
sort | string | One or more attributes to sort the items by. Defaults to id descending. | No |
size | int | Number of items per page. Defaults to 20 | No |
expand | string | Relations that should be extended. | No |
Response attributes
Attributes that you will receive in response from the endpoint in JSON format, for example:
{"email": "[email protected]","first_name": "James"}
Title | Type | Description | Required? |
---|---|---|---|
title | string | Title | Yes |
is_draft | bool | Defines whether collection is draft or published | No |
description | string | Collection description | No |
images | array of integers | Array of uploaded images | No |
type | integer | Type of collection: | Yes |
seo_title | string | SEO title | Yes |
seo_url | string | SEO url (e.g. collections/<:value>) | Yes |
seo_meta | string | SEO meta description | No |
match_products | array of integers | Array of products that were manually added to this collection | Yes, when collection is manual, otherwise NO |
rules_match_condition | integer | Defines the way of matching product rules: | Yes, when collection is rules-based, otherwise NO |
rules | array of objects | Contains array of object defining rules | Yes, when collection is rules-based, otherwise NO |
rules.type | integer | Field name | Yes, when collection is rules-based, otherwise NO |
rules.condition | integer | Condition | Yes, when collection is rules-based, otherwise NO |
rules.value | string|integer | Value | Yes, when collection is rules-based, otherwise NO |
{
"id": 10,
"type": 1,
"seo_url": "rules-based",
"seo_title": "rules based",
"title": "rules based",
"description": "whatever",
"rules_match_condition": 0,
"rules": [
{
"type": 0,
"condition": 3,
"value": "cat"
}
],
"is_draft": false
}