Get Subcollection by Collection ID

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 all Subcollections given a Collection ID. A Subcollection is a within a Collection.

Response body example

json

[
    {
        "Id": 12,
        "CollectionId": 149,
        "Name": "Subcollection",
        "Type": "Inclusive",
        "PreSale": false,
        "Release": true
    },
    {
        "Id": 13,
        "CollectionId": 149,
        "Name": "Test",
        "Type": "Exclusive",
        "PreSale": true,
        "Release": false
    },
    {
        "Id": 14,
        "CollectionId": 149,
        "Name": "asdfghj",
        "Type": "Inclusive",
        "PreSale": false,
        "Release": false
    }
]

Input

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

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "CollectionId": {
        "type": "integer",
        "description": "Collection ID."
      },
      "Id": {
        "type": "integer",
        "description": "Subcollection ID."
      },
      "Name": {
        "type": "string",
        "description": "Subcollection Name."
      },
      "PreSale": {
        "type": "boolean",
        "description": "Defines if the collection is on PreSale."
      },
      "Release": {
        "type": "boolean",
        "description": "Defines if the collection is a new released one."
      },
      "Type": {
        "type": "string",
        "description": "Either `“Exclusive”` (all the products contained in it will not be used) or `“Inclusive”` (all the products contained in it will be used)."
      }
    }
  }
}