Get Collection

v1.0.0

⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with .

Retrieves general information of a Collection.

Response body example

json

{
    "Id": 159,
    "Name": "Winter",
    "Description": null,
    "Searchable": false,
    "Highlight": false,
    "DateFrom": "2021-09-27T10:47:00",
    "DateTo": "2027-09-27T10:47:00",
    "TotalProducts": 0,
    "Type": "Manual"
}

Input

{
  "type": "object",
  "properties": {
    "Accept": {
      "type": "string"
    },
    "Content-Type": {
      "type": "string"
    },
    "collectionId": {
      "type": "integer"
    }
  },
  "required": [
    "Accept",
    "Content-Type",
    "collectionId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "DateFrom": {
      "type": "string",
      "description": "Initial value date for the Collection."
    },
    "DateTo": {
      "type": "string",
      "description": "Final value date for the Collection."
    },
    "Description": {
      "type": "string",
      "description": "Collection description."
    },
    "Highlight": {
      "type": "boolean",
      "description": "Defines if the Collection is highlighted or not."
    },
    "Id": {
      "type": "integer",
      "description": "Collection ID."
    },
    "Name": {
      "type": "string",
      "description": "Collection Name."
    },
    "Searchable": {
      "type": "boolean",
      "description": "Defines if the Collection is searchable or not."
    },
    "TotalProducts": {
      "type": "integer",
      "description": "Total quantity of products in the collection."
    },
    "Type": {
      "type": "string",
      "description": "Type of collection."
    }
  }
}