{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/PatchCatalogCategoryResponse",
"title": "PatchCatalogCategoryResponse",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CatalogCategoryEnum"
},
"id": {
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"type": "string",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
},
"attributes": {
"type": "object",
"properties": {
"external_id": {
"description": "The ID of the catalog category in an external system.",
"type": "string",
"example": "SAMPLE-DATA-CATEGORY-APPAREL",
"nullable": true
},
"name": {
"description": "The name of the catalog category.",
"type": "string",
"example": "Sample Data Category Apparel",
"nullable": true
},
"updated": {
"description": "Date and time when the catalog category was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00",
"nullable": true
}
}
},
"relationships": {
"type": "object",
"properties": {
"items": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
},
"id": {
"type": "string"
}
}
}
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
}
}
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"id",
"attributes",
"links"
]
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
]
}