CommunitySupport PortalYouTubeFree trialSign Up!

Catalog management

Manage catalogs

Creating a catalog

post

Creates a new catalog based on the provided request payload, for the specified tenant.

Required scopes

catalog.catalog_manage

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Available scopes:
  • : Manage catalog
  • : View catalog
Path parameters
tenantstringRequired

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

Example: saasdev2
Body

Payload for creating a new catalog

idstring · min: 1 · max: 66Optional

Custom catalog identifier. If not provided, it is automatically generated.

Pattern: ^[a-zA-Z0-9_-]$
nameone ofRequired

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.

stringOptional
or
descriptionone ofOptional

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.

stringOptional
or
publishedSitesstring[]Optional

List of site identifiers on which the catalog is published.

categoryIdsstring[]Optional

List of root category identifiers that are assigned to the catalog.

Responses
post
/catalog/{tenant}/catalogs
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"
}

Upserting a catalog

put

Update or create the specified catalog.

Required scopes

catalog.catalog_manage

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Available scopes:
  • : Manage catalog
  • : View catalog
Path parameters
tenantstringRequired

Your Emporix tenant's name. Note: The tenant should always be written in lowercase.

Example: saasdev2
catalogIdstringRequired

The unique id of the catalog.

Example: 787323
Body

Payload for updating a catalog.

nameone ofRequired

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.

stringOptional
or
descriptionone ofOptional

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.

stringOptional
or
publishedSitesstring[]Optional

List of site identifiers on which the catalog is published.

categoryIdsstring[]Optional

List of root category identifiers that are assigned to the catalog.

Responses
put
/catalog/{tenant}/catalogs/{catalogId}
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"
}

Removing catalog

delete

Remove the specified catalog.

Required scopes

catalog.catalog_manage

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Available scopes:
  • : Manage catalog
  • : View catalog
Path parameters
tenantstringRequired

Your Emporix tenant's name. Note: The tenant should always be written in lowercase.

Example: saasdev2
catalogIdstringRequired

The unique id of the catalog.

Example: 787323
Responses
delete
/catalog/{tenant}/catalogs/{catalogId}
DELETE /catalog/{tenant}/catalogs/{catalogId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Partially updating a catalog

patch

Update the specified catalog, even partially.

Required scopes

catalog.catalog_manage

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Available scopes:
  • : Manage catalog
  • : View catalog
Path parameters
tenantstringRequired

Your Emporix tenant's name. Note: The tenant should always be written in lowercase.

Example: saasdev2
catalogIdstringRequired

The unique id of the catalog.

Example: 787323
Body

Payload for partially updating a catalog.

nameone ofOptional

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.

stringOptional
or
descriptionone ofOptional

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.

stringOptional
or
publishedSitesstring[]Optional

List of site identifiers on which the catalog is published.

categoryIdsstring[]Optional

List of root category identifiers that are assigned to the catalog.

Responses
patch
/catalog/{tenant}/catalogs/{catalogId}
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"
}
PreviousList catalogsNextModels

Was this helpful?