Catalog management
Manage catalogs
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
saasdev2
Payload for creating a new catalog
Custom catalog identifier. If not provided, it is automatically generated.
^[a-zA-Z0-9_-]$
Name of the catalog must be a string if the Content-Language header is set or a map of translations if the header is missing.
Name of the catalog must be a string if the Content-Language header is set or a map of translations if the header is missing.
Name of the catalog must be a string if the Content-Language header is set or a map of translations if the header is missing.
Description of the catalog must be a string if the Content-Language header is set or a map of translations if the header is missing.
List of site identifiers on which the catalog is published.
List of root category identifiers that are assigned to the catalog.
The catalog has been successfully created.
Request was syntactically incorrect. Details will be provided in the response payload.
Permission denied due to insufficient rights.
Given resource already exists.
An unexpected error prevented the server from fulfilling the request.
POST /catalog/{tenant}/catalogs HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 241
{
"name": {
"en": "This is a catalog"
},
"description": {
"en": "This catalog is used as an example"
},
"visibility": {
"visible": true,
"from": "2022-02-24T20:44:43.169Z",
"to": "2023-07-24T20:44:43.169Z"
},
"publishedSites": [
"Main"
],
"categoryIds": [
"3249485"
]
}
{
"id": "text"
}
Your Emporix tenant's name. Note: The tenant should always be written in lowercase.
saasdev2
The unique id of the catalog.
787323
Payload for updating a catalog.
Name of the catalog must be a string if the Content-Language header is set or a map of translations if the header is missing.
Name of the catalog must be a string if the Content-Language header is set or a map of translations if the header is missing.
Name of the catalog must be a string if the Content-Language header is set or a map of translations if the header is missing.
Description of the catalog must be a string if the Content-Language header is set or a map of translations if the header is missing.
List of site identifiers on which the catalog is published.
List of root category identifiers that are assigned to the catalog.
The catalog has been successfully created.
The catalog has been successfully updated.
Request was syntactically incorrect. Details will be provided in the response payload.
Permission denied due to insufficient rights.
Resource cannot be found
Resource conflict
An unexpected error prevented the server from fulfilling the request.
PUT /catalog/{tenant}/catalogs/{catalogId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 268
{
"name": {
"en": "This is the same catalog"
},
"description": {
"en": "This catalog has been updated"
},
"visibility": {
"visible": true,
"from": "2022-02-24T20:44:43.169Z",
"to": "2023-07-24T20:44:43.169Z"
},
"publishedSites": [
"Main"
],
"categoryIds": [
"3249485"
],
"metadata": {
"version": 1
}
}
{
"id": "4239475"
}
Your Emporix tenant's name. Note: The tenant should always be written in lowercase.
saasdev2
The unique id of the catalog.
787323
The catalog has been successfully removed.
Request was syntactically incorrect. Details will be provided in the response payload.
Permission denied due to insufficient rights.
Resource cannot be found
An unexpected error prevented the server from fulfilling the request.
DELETE /catalog/{tenant}/catalogs/{catalogId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Your Emporix tenant's name. Note: The tenant should always be written in lowercase.
saasdev2
The unique id of the catalog.
787323
Payload for partially updating a catalog.
Name of the catalog must be a string if the Content-Language header is set or a map of translations if the header is missing.
Name of the catalog must be a string if the Content-Language header is set or a map of translations if the header is missing.
Name of the catalog must be a string if the Content-Language header is set or a map of translations if the header is missing.
Description of the catalog must be a string if the Content-Language header is set or a map of translations if the header is missing.
List of site identifiers on which the catalog is published.
List of root category identifiers that are assigned to the catalog.
The catalog has been successfully updated.
Name of the catalog must be a string if the Content-Language header is set or a map of translations if the header is missing.
Request was syntactically incorrect. Details will be provided in the response payload.
Permission denied due to insufficient rights.
An unexpected error prevented the server from fulfilling the request.
PATCH /catalog/{tenant}/catalogs/{catalogId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 268
{
"name": {
"en": "This is the same catalog"
},
"description": {
"en": "This catalog has been updated"
},
"visibility": {
"visible": true,
"from": "2022-02-24T20:44:43.169Z",
"to": "2023-07-24T20:44:43.169Z"
},
"publishedSites": [
"Main"
],
"categoryIds": [
"3249485"
],
"metadata": {
"version": 1
}
}
{
"0": "t",
"1": "e",
"2": "x",
"3": "t"
}
Was this helpful?