SmartCollection

A smart collection is a grouping of products defined by simple rules set by shop owners. A shop owner creates a smart collection and then sets the rules that determine which products go in them. haravan automatically changes the contents of smart collections based on their rules.

#

Smart Collections also use collects to connect a product to that smart collection. These collects however, are managed by the rules of the smart collection and therefore cannot be added or removed through the API.

haravan's collections — both smart collections and custom collections — are typically displayed to customers so that customers can select them and then view only the products in the collection they selected. They're typically used to break down the catalog of products into categories and make the shop easier to browse.

In addition to smart collections, there are also custom collections, which are groupings of products defined by the shop owner.

What can you do with SmartCollection?

The haravan API lets you do the following with the SmartCollection resource. More detailed versions of these general actions may be available:

SmartCollection Properties

body_html
{ "body_html" : "<p>The best selling ipod ever</p>" }

The description of the smart collection, complete with HTML markup. Many templates display this on their smart collection pag

handle
{ "handle" : "smart_ipods" }

A human-friendly unique string for the smart collection automatically generated from its title. This is used in shop themes by the Liquid templating language to refer to the smart collection. Limit of 255 characters.

id
{ "id" : "482865238" }

The unique numeric identifier for the smart collection.

image
{ "image" : "{ }" }

The collection image.

published_at
{ "published_at" : "2008-02-01T19:00:00-05:00" }


This can have two different types of values, depending on whether the smart collection has been published (i.e., made visible to customers):

  • If the smart collection is published, this value is the date and time when it was published. The API returns this value in ISO 8601 format.
  • If the smart collection is hidden (i.e., not published), this value is null. Changing a smart collection's status from published to hidden changes its published_at property to null.


published_scope
{ "published_scope" : "global" }

The sales channels in which the smart collection is visible.

rules
{ "column" : "variant_price" }
{ "relation" : "less_than" }
{ "condition" : "20" }


The list of rules that define what products go into the smart collection. Each rule has the following properties:


  • relation:
    The relation between the identifier for the condition and the numeric amount.
  • condition:
    Select products for a collection using a condition.
  • column:
    • title: Product title.
    • type: Product type.
    • vendor: Product vendor.
    • variant_price: Product price.
    • tag: Product tag.
    • variant_compare_at_price: Compare at price.
    • variant_weight: Weight.
    • variant_inventory: Inventory stock.
    • variant_title: Variant's title.


disjunctive
{ "disjunctive" : "false" }

If false, products must match all of the rules to be included in the collection. If true, products can only match one of the rules.

sort_order
{ "sort_order" : "alpha-asc" }


The order in which products in the smart collection appear. Valid values are:

  • alpha-asc: Alphabetically, in ascending order (A - Z).
  • alpha-desc: Alphabetically, in descending order (Z - A).
  • best-selling: By best-selling product.
  • created: By date created, in ascending order (oldest - newest).
  • created-desc: By date created, in descending order (newest - oldest).
  • manual: Ordered by the shop owner.
  • price-asc: By price, in ascending order (lowest - highest).
  • price-desc: By price, in descending order (highest - lowest).


template_suffix
{ "template_suffix" : "null" }

The suffix of the template you are using. By default, the original template is called product.liquid, without any suffix. Any additional templates will be: product.suffix.liquid.

title
{ "title" : "Smart iPods" }

The name of the smart collection. Limit of 255 characters.

updated_at
{ "updated_at" : "2008-02-01T19:00:00-05:00" }

The date and time when the smart collection was last modified. The API returns this value in ISO 8601 format.

Endpoints

GET/admin/smart_collections.json

Get a list of all smart collections that contain a given product

limit

Amount of results

(default: 50) (maximum: 250)
page

Page to show

(default: 1)
since_id

Restrict results to after the specified ID

title

Show smart collections with given title

product_id

Show smart collections that includes given product

handle

Filter by smart collection handle

updated_at_min

Show smart collections last updated after date (format: 2008-12-31 03:00)

updated_at_max

Show smart collections last updated before date (format: 2008-12-31 03:00)

published_at_min

Show smart collections published after date (format: 2008-12-31 03:00)

published_at_max

Show smart collections published before date (format: 2008-12-31 03:00)

published_status
  • published - Show only published smart collections
  • unpublished - Show only unpublished smart collections
  • any - Show all smart collections (default)
fields

comma-separated list of fields to include in the response

List all collections

GET /admin/smart_collections.json
View Response
HTTP/1.1 200 OK
{
  "smart_collections": [
    {
      "body_html": "<p>The best selling ipod ever<\/p>",
      "disjunctive": false,
      "handle": "smart-ipods",
      "id": 482865238,
      "published_at": "2008-02-01T19:00:00-05:00",
      "published_scope": "global",
      "sort_order": "manual",
      "template_suffix": null,
      "title": "Smart iPods",
      "updated_at": "2008-02-01T19:00:00-05:00",
      "rules": [
        {
          "column": "type",
          "relation": "equals",
          "condition": "Cult Products"
        }
      ],
      "image": {
        "created_at": "2015-03-28T13:31:19-04:00",
        "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/collections\/ipod_nano_8gb.jpg?v=1427563879"
      }
    }
  ]
}

List all collections after a specified ID

GET /admin/smart_collections.json?since_id=482865238
View Response
HTTP/1.1 200 OK
{
  "smart_collections": [
    {
      "body_html": null,
      "disjunctive": false,
      "handle": "ipods-1",
      "id": 1063001346,
      "published_at": "2015-03-28T13:33:13-04:00",
      "published_scope": "global",
      "sort_order": "alpha-asc",
      "template_suffix": null,
      "title": "IPods",
      "updated_at": "2015-03-28T13:33:13-04:00",
      "rules": [
        {
          "column": "title",
          "relation": "starts_with",
          "condition": "iPod"
        }
      ]
    }
  ]
}

List all smart collections for a certain product_id

GET /admin/smart_collections.json?product_id=632910392
View Response
HTTP/1.1 200 OK
{
  "smart_collections": [
  ]
}
GET/admin/smart_collections/count.json

Get a count of all smart collections that contain a given product

title

Show smart collections with given title

product_id

Show smart collections that includes given product

updated_at_min

Show smart collections last updated after date (format: 2008-12-31 03:00)

updated_at_max

Show smart collections last updated before date (format: 2008-12-31 03:00)

published_at_min

Show smart collections published after date (format: 2008-12-31 03:00)

published_at_max

Show smart collections published before date (format: 2008-12-31 03:00)

published_status
  • published - Show only published smart collections
  • unpublished - Show only unpublished smart collections
  • any - Show all smart collections (default)

Count all collections

GET /admin/smart_collections/count.json
View Response
HTTP/1.1 200 OK
{
  "count": 1
}

Count all smart collections for a certain product_id

GET /admin/smart_collections/count.json?product_id=632910392
View Response
HTTP/1.1 200 OK
{
  "count": 0
}
GET/admin/smart_collections/482865238.json

Get a single smart collection

fields

comma-separated list of fields to include in the response

Get a specific collection by ID

GET /admin/smart_collections/#{id}.json
View Response
HTTP/1.1 200 OK
{
  "smart_collection": {
    "body_html": "<p>The best selling ipod ever<\/p>",
    "disjunctive": false,
    "handle": "smart-ipods",
    "id": 482865238,
    "products_count": 0,
    "published_at": "2008-02-01T19:00:00-05:00",
    "published_scope": "global",
    "sort_order": "manual",
    "template_suffix": null,
    "title": "Smart iPods",
    "updated_at": "2008-02-01T19:00:00-05:00",
    "rules": [
      {
        "column": "type",
        "relation": "equals",
        "condition": "Cult Products"
      }
    ],
    "image": {
      "created_at": "2015-03-28T13:31:19-04:00",
      "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/collections\/ipod_nano_8gb.jpg?v=1427563879"
    }
  }
}
POST/admin/smart_collections.json

Create a new smart collection.
Valid values for Rule fields:

  • column - title, type, vendor, variant_price, variant_compare_at_price, variant_weight, variant_inventory, variant_title
  • relation - equals, greater_than, less_than, starts_with, ends_with, contains
  • condition - any string

Create a new collection with an image which will be downloaded by haravan

POST /admin/smart_collections.json
{
  "smart_collection": {
    "title": "Macbooks",
    "image": {
      "src": "http:\/\/example.com\/rails_logo.gif"
    }
  }
}
View Response
HTTP/1.1 201 Created
{
  "smart_collection": {
    "body_html": null,
    "disjunctive": false,
    "handle": "macbooks",
    "id": 1063001341,
    "published_at": "2015-03-28T13:33:11-04:00",
    "published_scope": "global",
    "sort_order": "alpha-asc",
    "template_suffix": null,
    "title": "Macbooks",
    "updated_at": "2015-03-28T13:33:11-04:00",
    "rules": [
    ],
    "image": {
      "created_at": "2015-03-28T13:33:11-04:00",
      "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/collections\/rails_logo.gif?v=1427563991"
    }
  }
}

Trying to create a smart collection without a title will return an error

POST /admin/smart_collections.json
{
  "smart_collection": {
    "body": "foobar"
  }
}
View Response
HTTP/1.1 422 Unprocessable Entity
{
  "errors": {
    "title": [
      "can't be blank"
    ]
  }
}

Create a collection of all products starting with the term IPod

POST /admin/smart_collections.json
{
  "smart_collection": {
    "title": "IPods",
    "rules": [
      {
        "column": "title",
        "relation": "starts_with",
        "condition": "iPod"
      }
    ]
  }
}
View Response
HTTP/1.1 201 Created
{
  "smart_collection": {
    "body_html": null,
    "disjunctive": false,
    "handle": "ipods-1",
    "id": 1063001342,
    "published_at": "2015-03-28T13:33:12-04:00",
    "published_scope": "global",
    "sort_order": "alpha-asc",
    "template_suffix": null,
    "title": "IPods",
    "updated_at": "2015-03-28T13:33:12-04:00",
    "rules": [
      {
        "column": "title",
        "relation": "starts_with",
        "condition": "iPod"
      }
    ]
  }
}

Create a collection with title Macbooks

POST /admin/smart_collections.json
{
  "smart_collection": {
    "title": "Macbooks"
  }
}
View Response
HTTP/1.1 201 Created
{
  "smart_collection": {
    "body_html": null,
    "disjunctive": false,
    "handle": "macbooks",
    "id": 1063001343,
    "published_at": "2015-03-28T13:33:12-04:00",
    "published_scope": "global",
    "sort_order": "alpha-asc",
    "template_suffix": null,
    "title": "Macbooks",
    "updated_at": "2015-03-28T13:33:12-04:00",
    "rules": [
    ]
  }
}

Create a new, but unpublished collection

POST /admin/smart_collections.json
{
  "smart_collection": {
    "title": "Macbooks",
    "published": false
  }
}
View Response
HTTP/1.1 201 Created
{
  "smart_collection": {
    "body_html": null,
    "disjunctive": false,
    "handle": "macbooks",
    "id": 1063001344,
    "published_at": null,
    "published_scope": "global",
    "sort_order": "alpha-asc",
    "template_suffix": null,
    "title": "Macbooks",
    "updated_at": "2015-03-28T13:33:12-04:00",
    "rules": [
    ]
  }
}

Create a new collection with a base64 encoded image

POST /admin/smart_collections.json
{
  "smart_collection": {
    "title": "Macbooks",
    "image": {
      "attachment": "R0lGODlhAQABAIAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==\n"
    }
  }
}
View Response
HTTP/1.1 201 Created
{
  "smart_collection": {
    "body_html": null,
    "disjunctive": false,
    "handle": "macbooks",
    "id": 1063001345,
    "published_at": "2015-03-28T13:33:12-04:00",
    "published_scope": "global",
    "sort_order": "alpha-asc",
    "template_suffix": null,
    "title": "Macbooks",
    "updated_at": "2015-03-28T13:33:12-04:00",
    "rules": [
    ],
    "image": {
      "created_at": "2015-03-28T13:33:12-04:00",
      "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/collections\/df3e567d6f16d040326c7a0ea29a4f41.gif?v=1427563992"
    }
  }
}
PUT/admin/smart_collections/482865238.json

Update an existing smart collection


Change the description of the Smart iPods collection

PUT /admin/smart_collections/#{id}.json
{
  "smart_collection": {
    "id": 482865238,
    "body_html": "<p>5000 songs in your pocket<\/p>"
  }
}
View Response
HTTP/1.1 200 OK
{
  "smart_collection": {
    "body_html": "<p>5000 songs in your pocket<\/p>",
    "disjunctive": false,
    "handle": "smart-ipods",
    "id": 482865238,
    "published_at": "2008-02-01T19:00:00-05:00",
    "published_scope": "global",
    "sort_order": "manual",
    "template_suffix": null,
    "title": "Smart iPods",
    "updated_at": "2015-03-28T13:33:15-04:00",
    "rules": [
      {
        "column": "type",
        "relation": "equals",
        "condition": "Cult Products"
      }
    ],
    "image": {
      "created_at": "2015-03-28T13:31:19-04:00",
      "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/collections\/ipod_nano_8gb.jpg?v=1427563879"
    }
  }
}

Show a hidden collection by changing the published attribute to true

PUT /admin/smart_collections/#{id}.json
{
  "smart_collection": {
    "id": 482865238,
    "published": true
  }
}
View Response
HTTP/1.1 200 OK
{
  "smart_collection": {
    "body_html": "<p>The best selling ipod ever<\/p>",
    "disjunctive": false,
    "handle": "smart-ipods",
    "id": 482865238,
    "published_at": "2015-03-28T13:33:15-04:00",
    "published_scope": "global",
    "sort_order": "manual",
    "template_suffix": null,
    "title": "Smart iPods",
    "updated_at": "2015-03-28T13:33:15-04:00",
    "rules": [
      {
        "column": "type",
        "relation": "equals",
        "condition": "Cult Products"
      }
    ],
    "image": {
      "created_at": "2015-03-28T13:31:19-04:00",
      "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/collections\/ipod_nano_8gb.jpg?v=1427563879"
    }
  }
}

Hide a published collection by changing the published attribute to false

PUT /admin/smart_collections/#{id}.json
{
  "smart_collection": {
    "id": 482865238,
    "published": false
  }
}
View Response
HTTP/1.1 200 OK
{
  "smart_collection": {
    "body_html": "<p>The best selling ipod ever<\/p>",
    "disjunctive": false,
    "handle": "smart-ipods",
    "id": 482865238,
    "published_at": null,
    "published_scope": "global",
    "sort_order": "manual",
    "template_suffix": null,
    "title": "Smart iPods",
    "updated_at": "2015-03-28T13:33:15-04:00",
    "rules": [
      {
        "column": "type",
        "relation": "equals",
        "condition": "Cult Products"
      }
    ],
    "image": {
      "created_at": "2015-03-28T13:31:19-04:00",
      "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/collections\/ipod_nano_8gb.jpg?v=1427563879"
    }
  }
}

Update a collection, setting a new collection image

PUT /admin/smart_collections/#{id}.json
{
  "smart_collection": {
    "id": 482865238,
    "image": {
      "attachment": "R0lGODlhbgCMAPf\/APbr48VySrxTO7IgKt2qmKQdJeK8lsFjROG5p\/nz7Zg3\nMNmnd7Q1MLNVS9GId71hSJMZIuzTu4UtKbeEeakhKMl8U8WYjfr18YQaIbAf\nKKwhKdKzqpQtLebFortOOejKrOjZ1Mt7aMNpVbAqLLV7bsNqR+3WwMqEWenN\nsZYxL\/Ddy\/Pm2e7ZxLlUQrIjNPXp3bU5MbhENbEtLtqhj5ZQTfHh0bMxL7Ip\nNsNyUYkZIrZJPcqGdYIUHb5aPKkeJnoUHd2yiJkiLKYiKLRFOsyJXKVDO8up\nosFaS+TBnK4kKti5sNaYg\/z49aqYl5kqLrljUtORfMOlo\/36+H4ZH8yDYq0f\nKKFYTaU9MrY8MrZBNXwXHpgaIdGVYu\/byLZNP9SaZLIyOuXCtHkpJst+Wpcm\nLMyCa8BfP9GMb9KQdPDd1PPk1sd5VP79\/L5dQZ0bI9+ymqssK9WcfIoXHdzG\nxdWWfteib79lSr1YP86MYurQxKdcUKdMQr5ZSfPs6YEZH8uhl4oWIenMuurQ\nttmejaqoqsqBVaAcJLlJN5kvMLlZRMNsSL5fRak0LbdQQMVvSPjw6cJnRpkf\nKtmjhvfu5cJtT7IuOMVvWLY\/M\/37+o0YH9ibhtSYdObErc6HarM9NnYSGNGR\navLi09unje3WyeO8rsVrT7tdRtK3uffu6NWeaL9pTJIjJrM4NPbx8cdyX7M7\nPYYVHu7j4KgoNJAYIKtkV5o9MsOcldicis+RYNutfrhFOZ0hJbqinZ8bI8h5\nUObFuOfItJsfJrJfUOfIqc+PXqQtK8RnSbA4Mcd3Tm0SGbpXQ8aqp7RLNs+s\novHfzpVhV9iggMd1TLtbRKUdKXEQFsd4XrZRPLIgMZUeJ+jKvrAlK6AhJ65A\nMpMpKuC3j5obIsRwS7hAN8l\/YtvDvnYXHbAoLI47SIUsOMenorF4gO\/m4+fH\npo4vLZ8oKMukqp0cJbhVSMV2UuPR0bAfMLIrLrg\/OcJwT8h+Vt+wn8eurLlh\nQrIfKHQOHHQOHf\/\/\/\/\/\/\/yH5BAEAAP8ALAAAAABuAIwAAAj\/AP8JHDhQXjpz\n\/PopXNiPn0OHDRMmbKhQIsOJFS1SxAhxI8SHFzVeDBnx48iNBAeeOkcxokeX\nFRdOnAlSokaaLXNujJkxo8iYHRkKtWkzZSsaOXkAWsoUECynsHgoqEW1qtVa\nU7Mq2Mq1K9cUW8GKTUG2rNkUHNByWMuWLdWva7t1W7UKG4S7eO\/ycEhQHgaK\nsL4VGGyocGE3br5929KuxQFFkEtIlgypsuUDmDMfWGRmUZvPoEHfGU36jgDT\nLQSoVt3IQ2sPsL0IUNZGlZ0H0lo00jEkCytWMspdGzBgn\/F9EBIWnKIQlqHB\nhA0bQpx48Z7UAkoEcMTdUeTJJSxf\/4akOTNnzqHb3GkjrUdp0gKwq77jWdod\nO7dNKWvhRUcWT6zYQI82xB03AAQNCdTKX\/xAAB10hfVCnRtbVIhIAy14oJoZ\nAXS4XXfdQaYIeOGJRx555Z1nRnrqqUeaMtIYY8dmn7Vg2yK57TYEgAzIQGBx\nxyXHj0A0OOTggxFKSN1iWwTTAIYanpYdMtFE4+GVIHrn3XeUmVhZeWiIMoOY\nnVQDGiTgKALJjIssIsADt0mjjI6+AXcDgQYi2M8\/7ijEwzRIFmBIL9NVV+EW\nVzyZ4Wqj9RBABchQWeWkV3aY5ZYjjgieeKL446mnjxwAiZVpliAjZqblt19\/\n\/7HCwIAFGv+X3J4s9fMckoYhphiTQTwJ5Wqn9dDDAWuMUUEFviTrS6STVlmp\npVmKqCkOn34aB6TIBAAOJeHZAYl6ptixSCL8edGbq8HFeqBDcygEyIOCGqYk\nkxUW4euiq7knbA\/gUDHGv\/\/ec2wFayQbaQWinOCslVhmSUq1\/gCDLJXacgtJ\nCYu4J66cjbAKoA3CxapnOgm9g+ughdK7xYX3Rinlvj2YYcYanVBBhTg2Axzw\nG4\/4k4bBzDZbKRUQP1LIsRSX6sgBZtwhzQP68ccbj7AWty4\/5igEoaC9dK3r\noVtgs4evvzKqb8wyQ0JFJzXXbDMVcQBQLTDGVmCssstKGs09oPT\/jQcRoBw9\nMamKgEOeeg\/gqBtvdVZSDnHFIQgRD4RxXWhiYEOQKNn4zncHzDIzHc0ZpHdy\nRicIQOypKDf7q3Pd96ABzSab+E1EIYIvS2o0ijA92gPZiCB1qwL+iJxL78Z7\n2NeHQrAK2YrCZva+bcgcujFUQIEG6WigonoCdLT9tr9UbIIAMMCEkkYacvvT\nxSgsBPKGJKBEAw4yjhx+hyn+PAJFfztyVdWOt5B3RehyimneFuwFvQxFyTSf\n25f1zCAqSFACDXTQ3gwSoDoElI5tZyBAINqnuhJ+Kg9vOIOaVnSHT5ECHucK\n0OMiBxJAPCdXmGseBLoBvei5rFEStB5m\/yBhjFJUIw50oIMoLvCpFRAADduj\nwxvUYMIqmvARCBiDeiwRBk+lQQTEq5qQ3CWdJSkGAlu4y9h66EBgAbF6QhSV\nMUpQilKcQRNLwIenfpFEJebBioC0ohrQQJ8QhMIfSwhgj2YouYTYUEmGqhBe\nFNBDH5otgmgLnRyLWMdq0GEGCMCHJjSBjzQE8pSChMLTCJBI4pXDBeuiiA1T\nprK7PK+SUPphsIQ1wSEag5OUKIUlyiAmAowClci0YizKILUAFi+WDQEEJOmF\nxlnMYnOVbOP0gkjBTdZRmDiwhCuywcRkmtOEpHjC1DzBABto4xqN5AcgdEXN\nNO4Ql0+CB2xctv9LM2SSgpXhZB0t0QlT+iMUkzinQquFihD452P0gGdGAPGN\nHKYxjbOAwBpxqU9+ApGXQgyoQDWRgASwoAMGMMAHDrnQhc5AkQPSU0NgYVF7\nQmAWKcBnPvc5HwGcbUVxJCInEfACQXQACUhFQkqRwAIOttScv9ABO21wA8k1\np5Z3mYXYdNqAjvLzbHDUpFCNIQoUdGAdHUhrUg2gVAOg4AXmvEAaOPEGaCCA\nAASQxBtIYYIq5kEHAaKHVfsRGB3eNBPYxKdXGVWGUnAzdOSxgyg+MIxhoDWt\nal3rUlXABEBeYBQIiMMm0AAKPBBAE1A4nTjWEIAzvGEFqsvDEHqEjZj\/wMKw\n1rwlVxerGkv4AxVoAOkEmXGMOKDgA8i1LFrRioSjKrWtKRVEQlXHBBSKQhLQ\nEG3tCHCLJaSWClD0zgHO8LBqDeIYNsDGTG4ryZtak4G7lZ6G2sBSfyCAaTK7\nAzfgQIEzoOC\/yKVsZS+bWeim1BsdqEG10oCANxDgDZwIRHa3O4hbaA91nlKB\nKA7QBhHo0VPwCFBtAdNea86CZVztKk8FUN5PjQIHxKWABihQBkHY+L\/HTa5l\nMetcAxvAG94wQAQAkA1SIIAUBvUHdkVLgBkMwrvkPSEkVtSCJ\/yCAJ5gZ20l\nwgObziITGk3xTqUHhWoxYQVdAIYINMBmO0TA\/8aCwHGOBbwOAvc4pXj2RieY\nIY69ttgfpJBEHOLQ5ArTAQ2SaPAb4lAC33XsoaxYhUx4kFVrZoKSYlYxbOzg\nPX8kAM1d6AILOuEDDQzBBCaIwJvhjOMAU7bOmE0qdMUhhFozQhVxiMWnuiAJ\nQTfZyahFQydWGwA1cbiZAJL0Qiht6UzoVsxetUQaJhEKZzhDBdh+A5s9AQxU\nq3rVN241ne0sa1rXWgjbqLUd3uqPUYhCFNDAxwzm3d3vjgF\/vTvAHegUaYbw\nwMSZyAR8oX0I2BwiC2eoQQ2srYJA6IDNb2ABqr39bVYDWMfkRgIVzs1xdEOD\nCjhQ4nXlPe9BaOLQNf+rRjQc0eg2DM8TyvZTs3mY6Xwy4xI2YLMGdIAAhTvD\nFWzuhKhZIHGKq9riF381rDtQho53\/Bjpboc1OiEJktMbtaplrbHboCOYT9rS\nOdhopocwgiRowOw6L0MNCKCBKjwA26IW9cRTXfE4i1vAlpUEHJze8XTXehvc\n2AQ05k3vDHaiDGNYeaPNoAzGxbwf\/86EHDCd4kbsyBMySII2NH92nevg4TbI\nA7ZVEGqiF93ocLb7nIdhgGMIoROW4Dvft2GHOqQiDoM3+YWJnT8O7yYL3fgI\nDwK+CrFX0lwBctUxtLH55qNd5xkYxMKvDffSn\/7b4L47JYQgjnW0XvZOv0L\/\nKmz\/BS5sIg5QvtkavDPlO\/Am+FzOBCBqgU8veEJA9LCBDRjQznIw3\/lJEIBs\n5gqhUIALN3rWR3QTh31IFwcUkAiV1QEOCH4ddw8LkAqpUH5cgAtnIGzikHgs\nxzSW1w3+Jgc0Bz32Rw8DoA3lQA8yIAP6xwoj4H\/\/B4BJYAOjoAZqYIDWRn0J\nuIB1Z3fHQAGdgHeJQIEcxwwLQH5csIHEQARE4C9aRx49oAPw5ydyIHaANUPE\nwXwtmH\/6Vw5iKIb\/F4DaoAGisAIroIM7WG0MR3pDd3qoJwjVQAEUAAdvEGAG\nsHcUgITFgAtLmIFNiAtQeAInMAa+UGwiyAEW8QMc\/\/AkgKUNx7EPkLOCLOiC\nNiADIzCDY0iDm2cHLxCKbNiGPueDcVh02McJ\/GWHjfABxyUJdigEfUiB+pAL\ndVAHX1B+uPCERHAChSAw8QAOHMaIE6EF3MAKkjiJxlGJljgC+UcPm7iJnch8\nDJAHoRiKaqiDBRgK01d9LDB0QFiHdmiH1YACSDCE4ziLsscIdRCIGriLhfiL\naxAPOKAKtbARPFAFQKKMywg5XuiC9ACN0TiNOwAAAHCNL5CN2siN3QiHcYhq\nwCAD6WiHomAJEzmO4LcGueCOG4gLf2OIAjOPOHCPEEFT\/KiMzKgNLigDABmN\nnKgL02aQB3mNCkmKB+iNCv+IBjI2Y+O4ihcZi063DcywkReYi04Yj\/ewBmuA\nAyRYEbAAAVVwkv3oj9rwgizJks4okCMwCI+ACqgwCQaJkGq4hm3IjW8YakPn\nCWxmhzz5kxfJd3iwkUx4lL0ojw\/QlAnxlG4glQYCOStplS8YkJuoCwnwCIY5\nCYgZljRJlqTYg9WnbTq3lm3plrGojrVWixuJgRpIDB95AgLTCCRYkjeVAXw5\nlfqXiVa5ks64QSVlmF8JljO5mAtplj4IdJE5YzpHmenYcXCwAHKJi7rIi74Y\nD7oQms1xU71QmpQ4AOVwmvoHmAH5ABcwna3pmompmAnJmDzIcGp5m2upmxMp\ni+f\/Zg9AIJeCeJSG+ACHAH8OwWyzoJyUCIOnCYOAKQP4wATTeQElVZio8AiI\nCZtiSZbbuHAIUAXemZu5CZ4YyQ250KAXeJ6c2YsCYIUYwWyZUADK6QoEwAfO\nOZ8yoANSwAT4SZ37eZjXGZtjOZshoAFQ8HAHOo6TCZ5CgAfluYS4OIhPGA8C\n4AXBtxBP+WXvWZrZ4ClhYAkdmokzgAkhKqIjqp+GaaIyGaAL+XDOEAEueqC4\nGaNuKQTWAAQ1OpceCQktcAgcYFuHJQc+wJfhADFpsAPhcJpewAZKKgVL2qTV\n2ZUnKptqMApJ8ADVZqVYKpkKaodwEAflaYvAuYFE4HIe\/8CIEWGhchCkJ7kE\nJQQAHGoDZcYGckqnTGqnhWmiALqYS5AEdGCAVmqgBvqiMqagquANX3qe8cCo\njpqX1iQHsAALaWogx5FkEBMO7URCmjqnTJqfJQql2LkClpAEwNCGahABapmq\nqqqgjAAE3uCgTFgC6tEIZVoRzCYHckBpJ+kBJoQA+xcCqrOpdeqpT\/qf2JkF\nSQAPOdiGLoqq0QqeVOCqDUp+RMBh+7atDgELX+atPJCPKOkAJmQJ7fRH54oJ\nc7qk+amfn+qfsAkAKqB5SeAFo7CGwBCo3smWlMkMQPaqyAAJi2AaKTBpECB5\nUdFlKJk6qoMK\/McHVsSwdFqnxP9aUv3JrgRghhcbCCswqp0XmdAamTtJmXHg\nqjWaCmqCIwJwsg\/RrSvLA6R5HDIAAyJAAJ3mKQQAAwxwC4Akp8Iqog9bna+5\nA2V4g+kUgM\/HZlUwtB2rparwYzWKB\/nzAG3QtBVaq1HxA5+wl8cBA1iABTCg\nCyGgsK7Af1lrReiariTKn6ggAmTIfDfIAJuntt7pth2bjnAABHKbC74ADi13\nByfLrQG7sp\/AA8dBD4EruIILAy0ABboAA66ATMHKqcMKsZ\/aCNMouWrbu2vb\nthw7kdUgt3VgP41WsinwEPzwb7NgqzzwA3xrCMYBuKu7ujBwvTBAAOYEtrbr\nqQkwg5z\/GLmVa7GWy7EJmo7ccGB4gAxp8i3SMLoNEXnOywOf8AmwsA\/aUL3V\ni726QELJtLi3W1ICWQ7SGLm+67tCi6UeSwGb8GOFkC1L+74uAbAq+7z1Sw0F\nwACXcAmBy8H6O7sLxb22O52k4IwD2Yk0SL69a763KWOJgAQLACnFBgl267Qy\nV8H0+wnUgAEb3MMbrL\/a+1SaWrNMSgpYqZUEPIY1qMICyMJtCQSB4wv2czjw\nC3mla8E6nAzcEA4+jAU\/HLiJG8IAbMRW6ZLgq8S8e8BOPGM4cDtSDLqboQD4\neMV8m8VXkAV47MMeDMJP9SmLiw82oAOpicThm8IHXL6BSgEn\/4AHhbAsaRLH\nMSG\/e3vBjojHWRADeowFg9DHEMO9DmADDjAK1ZCaLknAhZzGaoyl3IALXHAC\nMry0cjwR8juwz0sN1OBs3HDJlpwFl8DLvMrJnqKpUADKIUoKD1DGpVzAZ3vI\nWKoIxNDKr0yysRy\/dKzDP3BTChADunzJlxAOygDMJkQANlAGmMCk+CDI0KiV\nBYzGh9zEOmcDRPCEjEwlI3IACtARkmzB1JBRs9AN3KDN2mzJZQDOJRQGNmAH\nDSuiyhCYL2jGKIzKCMxmdwCFRMDIb9xo07y8V1y\/14wXVxADIA3QWRDEBF0t\nBi0CAOwKgDkCmmjGpzy+anwPvbjIJ\/\/gyBitvLNswRmVVewQ0iL9yyVt0PVA\nAIsLBfVJytK4zuXQzknADIZoiIVABNEsx8vWvN\/6vJRmU6vw0T4tsyWtOvxn\nA+EABQCgpID8gqh5lQ6dxGR4yIrgi78o01MdyVY9sJ+QCd+ARlmVzT490F8N\nMTEQ1gwQDiGwPh260i2dzJ3Yu8eAO\/fw2BVwD408w7UAEv9mqyubQBe1Q\/98\nCCA9A38NMSLAf4JtAyFw2Gnd0Il9wmKotm0Q10o5j41svFQtc\/M7CwmU1\/ZU\nC559CLrwC6FdLSFA2sR9pB5anw4dvlUZDyE5j\/SINKBb2RRx2ZldHUxyFxwQ\nA70d3NUCBa7\/QtyljdrIvdZj6AFKGQ\/oTY84YA8PnCb3ON11PQv0dN0QgA1X\noAuH4Fvc7SkIwABcC97hfdiIvdrgSwnOrd72QAkGDsHSnRDD57wS0g4NcAVb\ncN1bkAKHcAh+vd95cL3+DeABPp+pjcybeAnojQMobg8JTgmqQAlSrAjSHb8q\nOwvT0QDocOMTQAJ6UARk4M+HANr77SnY6+Egrn\/tdKTjHY2LkOIqruCq8OR2\n8MYk6ScqSyiGQAI3fuNRsOVRMAEKcAjAHeT+cARD\/t8g3k5HLuJHLQMMYA\/r\nreAsbhv48QCUYD8NDnmSR+MF0At\/YARGoOXoEAW8QAscMARhHNwh\/1DmHm7m\nxZ3mxw2Y1rDicY4ft\/EAlp4tlS3LkndD3ODnfp7lW14EW7AHYu4pg9C6Zc5\/\njE7a+4fkad3iTy7nlW4KtC4N9hAAU47nR1IAwtAMno4Of77labQHrVDqYWC9\nis61qx7i83kIsU7plk7rppAI1G4K0UCSDp4JbgAdJNAMvv7pOL4YViAPpe4P\n+pvsy87qrT6ftQHtiUPr1K4M+9EC9nDnlOYDg+EDf+Dt3\/7n6EALi0EL+VDu\nD4DsqI69ql7kjo4F7r4IpiAN8T7vjdAIdmDv74DvPsAN\/O7tv14EiUECUQAC\npV4G+ovsqf7hAH6a1jDr8E7tLaAbE+8FMv\/\/3n6S79MwBDuw7xzv6e2gGBMQ\nBadQ6gSABQ5AAA4gAodg8kOe8GduCu8O8S7\/8jHfH5\/HDiWRDH6QA9hwK4PB\nDfbyBLRAAtPxDbaw5X0g5mlwCXzsMwgABUdw8Aif7ocg7fEu9VP\/eUPwCmDw\nAzPxA+TgBxgQ+BBgMpUjKNQR6FEwB6WuDJdw6AAQuMnO9KQNI3UP8x0DQHoP\nBmBABnuxEH4f+KAP+LitPNNRDFq+DCN\/CSQt3Psb+fyXBZU\/8ZevA5mv+Zqf\nAz\/AED+gBeQA+r4f+DkAAShTBKAu8kFOAOFQDQV97oqu6o0g8TFP+7Vv+5Ug\nC9+q+1PQ+7\/\/+1n\/DwFF4O\/osAFiDgB4DNT+UPDWC\/lljgV23zF5b\/vwXwny\njw3f+hE\/kP1TsP36\/wxNABBNeEVBp87fQYQJFS5k2NBOjGoEwvxKSOASFowZ\nscDgyHFIo0ZehrwCU9JkyUopK8nKlIkHP379+P2YMoUcBpw5deZ8RohQE6Cn\nGg4lOnRGDKRZsoS7pMPSA6YXNWLsKJLkSZOVwKhMGSTTrJf9ZNKcomXKTrQY\nevr02cSIvKJxi6aJkaVuXaZMs1ziO5UqPawnuXK9AWEW2Jhja9pMuzMd27YW\nLNga10fuZYUPkdZdqpTv575YbJQbkCHw1sEpb9wQMstwWLFkbfppjJPc\/wTI\nhHhJ5r0BBGbMRzfb7ez5MwwbpTMsx5pa9eob2CBM5yETpmzGtTE8hrybN29b\nc1oBn6trc9K7nhmUy6BcOUrn0KHLcr0FQvWYMxdnb3w7t\/fvwFMiFvKG0uw8\n4kRLYjkGG0RtMPlWc+GGdyCwbwtYrOsHu7K0a+K\/AEO04K0CF8InBvPOg2GE\nKpZTrsHSUotwwgnnmW4LHGGBKbb9bMqhsSly082CW0QMkDLLSvQHFQFiOESX\nLGzQpkUY22swA8Lko9EFLqfBEcdvMhRrwx610OLHtJ5Rc01ahHnCzTeFkXNO\nOfWQkwQ6NNFzTz2X0GQJQAMVdJEYsBhBAyrbK\/9tgBcbrCTCG7bkkstvvvwm\nzPzI7JEcNLXDCYICQhXVkAIMMdWQd0x1Y9VdiuHGA1hjhfWQQzyg9dZDYmBg\nyioSVfRKFwfYZ8ZIJ3XhGhe83OLSSwEZU78ea+pUO2wK8MFaUUMl9dReDOll\n1VXbuYIZWWOl1dZDLpGhV3YZXLTR9vZhUMJijUX2mmveYRZcQDLlsCZOp21s\nCx+uLTjbbE\/11ttv3diFkSHKRReGcthtN1hgrdxH2Awk5fJefK+ZZ9lvVvXW\n2cT+ZSwHgdHCpmCYDb4WYVNL7baXbsN9FdYYbKDA4otddBdYeffZx9iPjw35\nmmlKNtnUfmXSNNqAW9b\/6eWYY8YWYW0V7tYQhxWAwwege61y6OXkbdDoSUFe\nWuR3wP3akKhjUtlHlqklG+YqsjaY620VNgQDMcQQouwrX3zR6KKFZfttyKtw\n+utQnRUL2mjLYjnvtLDpu9e9\/ZYZ8FK3maLwwn8OmlF3lWNc7df3gfzteaZZ\n+NTKx5y6RxJ69\/333mvBwHOLQ\/fhiR2SV34HS47hmnAafJ9gh3AaDMcB7LE\/\nIoPY441dhOzDz94VN3DPNmoeM5drAyfK7lWH34baYetVCidBIT6C5UMhB4r2\nn3FheSANRVGCwhBmObtlbgqXyYYNyuYFAMQFCtPwQf3spxAraGBRR+Af91wX\n\/zsPoCIuCCAV13yAMsWo7zIOaJHFSHEZHZABdWK4X0JoIAENLIeDCXFA2rgX\nuwG8MC6kKGGoZuaDTEhtd\/vBTBoyYLYqeAEzFpihGCagEBqIQQJVGMAOEdLD\n2L0uHJdBAMIOhsTELHExwLnS\/i6zAQlIQItWxKIccejGL\/4wjPvw4kHSQApA\nBhKQUDCiEWE2C93dTSEW2EMjaWABhbgnA3g8SAj4cElK+kMJWoyjBK6YECtw\nUgKZ7N8ejdZHfzjgGgNY5SpnZsisJXFHikwICTLBskzUECFtxJ\/FFKKETmrx\nkwixQiclYAX+mfKUCpnBEZzpzHpkS2Yxm0ViMNcjhf+QABs5uKUuD9KoTOaP\nQb80picxaExk8lCZfIxLNuBhrWnurZpjoiVCbAkBbnrTH2pbTjgZVAVyGnOY\nBylmJ9P5xXWOUS6WEB3ZqgmTazLxMk40WntQub3lbIOc7OjkQP1RUI4e9CCl\nfJ3jjCbEogDAE6KrAiKlVs+4gJF7GUDlDLLnUWCyg6Ps8GgxdyrSVK5zH\/WI\noARjZjFEQhSmRCEFg9SGSqIoQadT7alOJcAOoJJUmeFA6VBIETqk+ssPKizK\nDorxwx9CdShSvapOqzpVoO7ApMocgAdcIb74HeSroEOqEn8w1mgVRR0KyEEw\nKqoctTZEquzggFsVooepskP\/DwqZAAfmakpGvc4HXSXF54CWVLthALASRYhB\nFpmDd4QxsQxRQmNd61HITnWyCVHC9MTnCsY9U7dH4AM8spGQvVrsiRB4Fg\/8\ncFxsJmQDHvUHLQyhWsy01rXs2MFj2ZGC6862KKRgHGY6K9zlEPdyP8AJcteo\n3ClsQCHq0AF0QdkN+HbjlxygL31hO13tMrW7lwkB0BiUoR3x4EfmrYlCNjAF\nCRAoIWmwQexQqQcyxHe+9eXAfVOQAg7k16v7jQsAHGi2Bv0gUzyQQ05Ga+Cy\n0MBEDsZgN8gQ4QnXt7oJ0QOGOZACDTeEu0aTCwC80EKhDcAHMDGHWATMsuMC\nFsVl\/9GnP0Jg0kw24MUv\/qUTOGDlCj8WETfGsVx2vI+UzsATIFZUaTIRk3QY\n+ZYlFq0Ce5QJHBXgdU+MRCSwEYlVBCHPQZhyn7vhhD9fWdAc2DKhKXxhRCc6\n0Yi4LOPcl6hGVUFqc4gJLGaxufKO1s2VkrOj63znOkciCKMedZ+n7ARUp1rQ\niLAyIlyNYURcONaInrWs9ci4JyJOaFYawDzP8Q+ZwAICLckbgd08i290eh9V\nCIadQw3qO5Oa1H1GNRlSjeorO2HLruZ2rLudAm+Dm9Gxcx\/GXmSIMbnjH5W2\nzy2RbOzM+cENBRAWs0N9b3zXWdp8pra1r61tbXdb4N\/2Nv8i5gzeIJd5Gjui\nwT+AzQ9YVGrYnNO0Agm27GBkvNnNzje+921qf\/+b1QEfuMDFPe5lk\/lspUG3\nWKbQCofLBBBuwNEs3C3aikcrB2TTeM81HgmOd3zf\/PZ3yFPNaqSXfODF0EDK\nE9e6liZmCvJwOLD7AQhU2efSbG6zm7VgiG1ofBc+\/\/nGgZ7vbYw67aVux4v\/\nfXSSK53by\/HVrzIwDZTBBANUrzpMeAAIWASeB4P\/AQ9+cHjEJx7xWgDE5nLQ\neMdHXvKbg\/zkMZ23H\/1oFRjYPOc9v3nQ58Aw0xn9LACvO7HQAOZVf\/jl0ii1\nHcXe9bPX3euftaPL5R71tIf97nsy7\/o0WlP2r4\/JOU7B+r5nqva7jz1EdZ97\n4qNe+bonfvCfVXvly1762beOOdLBd+Q7PCAAOw==\n"
    }
  }
}
View Response
HTTP/1.1 200 OK
{
  "smart_collection": {
    "body_html": "<p>The best selling ipod ever<\/p>",
    "disjunctive": false,
    "handle": "smart-ipods",
    "id": 482865238,
    "published_at": "2008-02-01T19:00:00-05:00",
    "published_scope": "global",
    "sort_order": "manual",
    "template_suffix": null,
    "title": "Smart iPods",
    "updated_at": "2015-03-28T13:33:15-04:00",
    "rules": [
      {
        "column": "type",
        "relation": "equals",
        "condition": "Cult Products"
      }
    ],
    "image": {
      "created_at": "2015-03-28T13:33:15-04:00",
      "src": "https:\/\/cdn.haravan.com\/s\/files\/1\/0006\/9093\/3842\/collections\/fd43f2c8883f6e9b680e3295fd990d2c.gif?v=1427563995"
    }
  }
}

Update a collection, clearing the collection image

PUT /admin/custom_collections/#{id}.json
{
  "custom_collection": {
    "id": 841564295,
    "image": "",
    "body_html": "<p>The best selling ipod ever<\/p>",
    "handle": "ipods",
    "published_at": "2008-02-01T19:00:00-05:00",
    "published_scope": "global",
    "sort_order": "manual",
    "template_suffix": null,
    "title": "IPods",
    "updated_at": "2015-03-28T13:33:16-04:00"
  }
}
View Response
HTTP/1.1 200 OK
{
  "custom_collection": {
    "body_html": "<p>The best selling ipod ever<\/p>",
    "handle": "ipods",
    "id": 841564295,
    "published_at": "2008-02-01T19:00:00-05:00",
    "published_scope": "global",
    "sort_order": "manual",
    "template_suffix": null,
    "title": "IPods",
    "updated_at": "2015-03-28T13:33:16-04:00"
  }
}
PUT/admin/smart_collections/482865238/order.json
products

Array of product ids in the order you want them arranged. (Applies only when sort_order is set to "manual")

sort_order

The type of sorting to apply. Valid values are listed in the Properties section above.

(default: (current value))

Change the manual ordering of products in the SmartCollection

PUT /admin/smart_collections/#{id}/order.json?products[]=921728736&products[]=632910392
{}
View Response
HTTP/1.1 200 OK
{}

Change the type of sorting applied to the SmartCollection

PUT /admin/smart_collections/#{id}/order.json?sort_order=alpha-desc
{}
View Response
HTTP/1.1 200 OK
{}
DELETE/admin/smart_collections/482865238.json

Remove Smart iPods smart collection

DELETE /admin/smart_collections/#{id}.json
View Response
HTTP/1.1 200 OK
{}