Emporix Digital Commerce Platform API Documentation
Retrieving catalogs containing category
GET {{api-url}}/catalog/{{tenant}}/catalogs/categories/{{categoryId}}
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
X-Total-Count
|
boolean | This flag specifies if the API client should receive a X-Total-Count header with the total number of elements that match the search filter. |
RESPONSES
status OK
| [
{
"id": "63c851dd451cde0ce695f9a9",
"name": {
"en": "Name after update"
},
"description": {
"en": "Description after update"
},
"status": "visible",
"visibility": {
"visible": true,
"from": "2022-01-24T12:12:12.616Z",
"to": "2023-03-24T12:12:12.616Z"
},
"publishedSites": [
"main"
],
"metadata": {
"version": 2,
"updatedAt": "2023-01-18T20:11:53.146Z",
"createdAt": "2023-01-18T20:09:01.684Z"
},
"categoryIds": [
"8bb62907-014b-47a3-a039-20734369bc4e"
]
},
{
"id": "63c852c8451cde0ce695f9aa",
"name": {
"en": "Sample catalog"
},
"description": {
"en": "Catalog description"
},
"status": "visible",
"visibility": {
"visible": false,
"from": "2022-01-24T12:12:12.623Z",
"to": "2025-03-24T12:12:12.616Z"
},
"publishedSites": [
"main"
],
"metadata": {
"version": 2,
"updatedAt": "2023-01-18T20:13:00.942Z",
"createdAt": "2023-01-18T20:12:56.631Z"
},
"categoryIds": [
"8bb62907-014b-47a3-a039-20734369bc4e"
]
},
{
"id": "63c8e527451cde0ce695f9ae",
"name": {
"en": "Sample catalog"
},
"description": {
"en": "Sample catalog description"
},
"status": "visible",
"visibility": {
"visible": true,
"from": "2022-01-24T12:12:12.623Z",
"to": "2025-03-24T12:12:12.616Z"
},
"publishedSites": [
"main"
],
"metadata": {
"version": 1,
"updatedAt": "2023-01-19T06:37:27.441Z",
"createdAt": "2023-01-19T06:37:27.441Z"
},
"categoryIds": [
"8bb62907-014b-47a3-a039-20734369bc4e"
]
},
{
"id": "63c8e663451cde0ce695f9af",
"name": {
"en": "Sample catalog"
},
"description": {
"en": "Basic catalog description"
},
"status": "visible",
"visibility": {
"visible": true,
"from": "2022-01-24T12:12:12.623Z",
"to": "2029-06-24T12:12:12.616Z"
},
"publishedSites": [
"main"
],
"metadata": {
"version": 1,
"updatedAt": "2023-01-19T06:42:43.435Z",
"createdAt": "2023-01-19T06:42:43.435Z"
},
"categoryIds": [
"8bb62907-014b-47a3-a039-20734369bc4e"
]
},
{
"id": "null",
"name": {
"en": "Sample catalog after update"
},
"description": {
"en": "Catalog description"
},
"status": "visible",
"visibility": {
"visible": true,
"from": "2022-01-24T12:12:12.616Z",
"to": "2023-03-24T12:12:12.616Z"
},
"publishedSites": [
"main"
],
"metadata": {
"version": 2,
"updatedAt": "2023-01-19T07:00:10.713Z",
"createdAt": "2023-01-19T06:58:57.819Z"
},
"categoryIds": [
"8bb62907-014b-47a3-a039-20734369bc4e"
]
},
{
"id": "63c8eabb451cde0ce695f9b0",
"name": {
"en": "Sample catalog"
},
"description": {
"en": "Sample catalog description"
},
"status": "visible",
"visibility": {
"visible": false,
"from": "2022-01-24T12:12:12.623Z",
"to": "2025-03-24T12:12:12.616Z"
},
"publishedSites": [
"main"
],
"metadata": {
"version": 2,
"updatedAt": "2023-01-19T07:01:20.685Z",
"createdAt": "2023-01-19T07:01:15.324Z"
},
"categoryIds": [
"8bb62907-014b-47a3-a039-20734369bc4e"
]
}
] |
Curl
curl -X GET 'api-url/catalog/api-url/catalogs/categories/api-url' -H 'X-Total-Count: false'
ENDPOINTS