collections

Returns the additional collections of a customer given its customer key.

Request

HTTP POST
X-Customer-Key: customer-key
/api/v10/storefront.collections

{
  "ids" : [ 11, 20, … ], // collections (id) to return. If the field is missing, it returns all collections - int(1…)
  "fields" : [ "id", "title", … ] // fields to return - string
}

Response

{
  "status" : "ok",
  "collections" : [ {
    "id" : 11, // identifier - int(1…)
    "title" : "Spring/Summer", // title - string(0…60)
    "summary" : "", // summary description - string(0…65535)
    "description" : "", // detailed description - string(0…65535)
    "canonicalURL" : "https://…", // canonical URL - string(10…)
    "templateFile" : "collection-spring-summer.html", // template file used for the site - string(15…255)
    "productsLayout" : { // layout of the products on the department page
      "products" : 12, // number of products per page, can be 0, 12, 24, 36, 48 or 72 - int
      "columns" : 4, // columns, can be 1, 2, 3, 4 or 6 - int
      "sortOrder" : "-Price", // sort order, can be "Position", "Name", "-Name", "Price", "-Price" or "Date" - string
      "imageSize" : "Optimal", // image size, can be "Optimal", Small", "Medium" or "Large" - string
      "showDescription" : false // indicates if the description is displayed - bool
    },
    "seo" : {
      "title" : "", // title for SEO - string(0…255)
      "description" : "" // description for SEO - string(0…255)
    },
    "smallImage" : { // small image (can be null)
      "url" : "https://domain/path", // URL - string(53…255)
      "width" : 150, // width in pixel - int(1…2500)
      "height" : 139 // height in pixel - int(1…2500)
    },
    "largeImage" : { // large image (can be null)
      "url" : "https://domain/path", // URL - string(53…255)
      "width" : 400, // width in pixel - int(1…2500)
      "height" : 200 // height in pixel - int(1…2500)
    }
  }, … ]
}