{
  "openapi": "3.0.1",
  "info": {
    "title": "Catalogs",
    "version": "9.1.20.0",
    "description": "Create and administer a collection of catalogs in a store.",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Catalogs",
      "description": "Provide RESTful services to manage catalogs."
    }
  ],
  "paths": {
    "/catalogs": {
      "get": {
        "tags": [
          "Catalogs"
        ],
        "summary": "Get a collection of catalogs in a store.",
        "operationId": "getCatalogs",
        "parameters": [
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          },
          {
            "name": "dataLanguageIds",
            "in": "query",
            "description": "The integer(s) for identifying the language of the catalog description. For a list of the integers that map to the supported default languages, refer to the Knowledge Center. Multiple identifiers should be specified as a comma-separated list.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "masterCatalog",
            "in": "query",
            "description": "A boolean value selecting the master catalog.",
            "required": true,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is '5', the records that returned begin with the sixth record that matches the query parameters. If the offset is '0', the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/recordSetStartNumber"
            },
            "x-entity-path": "dataArea/get/recordSetStartNumber"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/maxItems"
            },
            "x-entity-path": "dataArea/get/maxItems"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CatalogCollection"
                }
              }
            },
            "x-entity-path": "dataArea/catalog"
          }
        },
        "x-expression-template": "{_wcf.ap='{accessProfile}';_wcf.dataLanguageIds='{dataLanguageIds}'}/Catalog[@primary='{masterCatalog}']",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "getCatalog",
        "x-parameters": {
          "accessProfile": "IBM_Admin_Details"
        },
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.GetCatalogType"
      },
      "post": {
        "tags": [
          "Catalogs"
        ],
        "summary": "Create a catalog.",
        "operationId": "createCatalog",
        "parameters": [
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId",
              "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/externalIdentifier/storeIdentifier/uniqueID"
            },
            "x-context-data": "storeId",
            "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/externalIdentifier/storeIdentifier/uniqueID"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Catalog"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation is successful.",
            "headers": {
              "Location": {
                "description": "The URI of the catalog.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetCatalogById": {
                "operationRef": "#/paths/~1catalogs~1{id}/get",
                "parameters": {
                  "id": "$response.header.Location",
                  "storeId": "$request.query.storeId",
                  "dataLanguageIds": "$response.header.Location"
                },
                "description": "The `id`,`storeId`,`dataLanguageIds` value used in the request body can be used as the `id`,`storeId`,`dataLanguageIds` parameter in `GET /catalogs/{id}`.\n"
              },
              "DeleteCatalog": {
                "operationRef": "#/paths/~1catalogs~1{id}/delete",
                "parameters": {
                  "id": "$response.header.Location",
                  "storeId": "$request.query.storeId"
                },
                "description": "The `id`,`storeId`,value used in the request body can be used as the `id`,`storeId` parameter in `DELETE /catalogs/{id}`.\n"
              },
              "UpdateCatalog": {
                "operationRef": "#/paths/~1catalogs~1{id}/patch",
                "parameters": {
                  "id": "$response.header.Location",
                  "storeId": "$request.query.storeId"
                },
                "description": "The `id`,`storeId` value used in the request body can be used as the `id`,`storeId` parameter  in PATCH /catalogs/{id}`.\n"
              },
              "CreateDescriptions": {
                "operationRef": "#/paths/~1catalogs~1{id}~1descriptions/post",
                "parameters": {
                  "id": "$response.header.Location",
                  "storeId": "$request.query.storeId"
                },
                "description": "The `id`,`storeId` value used in the request body can be used as the `id`,`storeId` parameter  in POST /catalogs/{id}/descriptions`.\n"
              }
            }
          }
        },
        "x-action-code": "Create",
        "x-expression-template": "/Catalog[1]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "processCatalog",
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ProcessCatalogType",
        "x-codegen-request-body-name": "body"
      }
    },
    "/catalogs/by-attachment-id": {
      "get": {
        "tags": [
          "Catalogs"
        ],
        "summary": "Get the catalogs and attachment references for an attachment.",
        "operationId": "getCatalogByAttachmentId",
        "parameters": [
          {
            "name": "attachmentId",
            "in": "query",
            "description": "The unique numeric ID for identifying the attachment.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          },
          {
            "name": "dataLanguageIds",
            "in": "query",
            "description": "The integer(s) for identifying the language of the catalog description. For a list of the integers that map to the supported default languages, refer to the Knowledge Center. Multiple identifiers should be specified as a comma-separated list.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is '5', the records that returned begin with the sixth record that matches the query parameters. If the offset is '0', the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/recordSetStartNumber"
            },
            "x-entity-path": "dataArea/get/recordSetStartNumber"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/maxItems"
            },
            "x-entity-path": "dataArea/get/maxItems"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CatalogCollection"
                }
              }
            },
            "x-entity-path": "dataArea/catalog"
          }
        },
        "x-expression-template": "{_wcf.ap='{accessProfile}';_wcf.dataLanguageIds='{dataLanguageIds}'}/Catalog[AttachmentReference[AttachmentIdentifier[(UniqueID='{attachmentId}')]]]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "getCatalog",
        "x-parameters": {
          "accessProfile": "IBM_Admin_CatalogAttachmentReference"
        },
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.GetCatalogType"
      }
    },
    "/catalogs/by-identifier-or-name": {
      "get": {
        "tags": [
          "Catalogs"
        ],
        "summary": "Get the catalogs by the identifier or the description name.",
        "operationId": "getCatalogByIdentifierOrName",
        "parameters": [
          {
            "name": "searchText",
            "in": "query",
            "description": "The identifier or the description name of the catalog.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          },
          {
            "name": "dataLanguageIds",
            "in": "query",
            "description": "The integer(s) for identifying the language of the catalog description. For a list of the integers that map to the supported default languages, refer to the Knowledge Center. Multiple identifiers should be specified as a comma-separated list.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is '5', the records that returned begin with the sixth record that matches the query parameters. If the offset is '0', the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/recordSetStartNumber"
            },
            "x-entity-path": "dataArea/get/recordSetStartNumber"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/get/maxItems"
            },
            "x-entity-path": "dataArea/get/maxItems"
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CatalogCollection"
                }
              }
            },
            "x-entity-path": "dataArea/catalog"
          }
        },
        "x-expression-template": "{_wcf.ap='{accessProfile}';_wcf.dataLanguageIds='{dataLanguageIds}'}/Catalog[search(CatalogIdentifier/ExternalIdentifier/Identifier='{searchText}' or Description/Name='{searchText}')]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "getCatalog",
        "x-parameters": {
          "accessProfile": "IBM_Admin_Details"
        },
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.GetCatalogType"
      }
    },
    "/catalogs/{catalogId}/descriptions/{id}": {
      "patch": {
        "tags": [
          "Catalogs"
        ],
        "summary": "Update descriptions for a catalog.",
        "operationId": "updateCatalogDescription",
        "parameters": [
          {
            "name": "catalogId",
            "in": "path",
            "description": "The unique numeric ID for identifying the catalog.",
            "required": true,
            "schema": {
              "type": "string",
              "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/uniqueID"
          },
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the language.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-entity-path": "dataArea/catalog[1]/description[1]/language"
            },
            "x-entity-path": "dataArea/catalog[1]/description[1]/language"
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId",
              "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/externalIdentifier/storeIdentifier/uniqueID"
            },
            "x-context-data": "storeId",
            "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/externalIdentifier/storeIdentifier/uniqueID"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CatalogDescription"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Change",
        "x-expression-template": "/Catalog[1]/Description[1]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "changeCatalog",
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogType",
        "x-codegen-request-body-name": "body"
      }
    },
    "/catalogs/{id}": {
      "get": {
        "tags": [
          "Catalogs"
        ],
        "summary": "Get a catalog.",
        "operationId": "getCatalogById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the catalog.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          },
          {
            "name": "dataLanguageIds",
            "in": "query",
            "description": "The integer(s) for identifying the language of the catalog description. For a list of the integers that map to the supported default languages, refer to the Knowledge Center. Multiple identifiers should be specified as a comma-separated list.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Catalog"
                }
              }
            },
            "x-entity-path": "dataArea/catalog[1]"
          }
        },
        "x-expression-template": "{_wcf.ap='{accessProfile}';_wcf.dataLanguageIds='{dataLanguageIds}'}/Catalog[CatalogIdentifier[(UniqueID='{id}')]]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "getCatalog",
        "x-parameters": {
          "accessProfile": "IBM_Admin_Details"
        },
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.GetCatalogType"
      },
      "delete": {
        "tags": [
          "Catalogs"
        ],
        "summary": "Delete a catalog.",
        "operationId": "deleteCatalog",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the catalog.",
            "required": true,
            "schema": {
              "type": "string",
              "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/uniqueID"
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId",
              "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/externalIdentifier/storeIdentifier/uniqueID"
            },
            "x-context-data": "storeId",
            "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/externalIdentifier/storeIdentifier/uniqueID"
          }
        ],
        "responses": {
          "204": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Delete",
        "x-expression-template": "/Catalog[1]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "processCatalog",
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ProcessCatalogType"
      },
      "patch": {
        "tags": [
          "Catalogs"
        ],
        "summary": "Update a catalog.",
        "operationId": "updateCatalog",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the catalog.",
            "required": true,
            "schema": {
              "type": "string",
              "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/uniqueID"
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId",
              "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/externalIdentifier/storeIdentifier/uniqueID"
            },
            "x-context-data": "storeId",
            "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/externalIdentifier/storeIdentifier/uniqueID"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Catalog"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {}
          }
        },
        "x-action-code": "Change",
        "x-expression-template": "/Catalog[1]/CatalogIdentifier",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "changeCatalog",
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogType",
        "x-codegen-request-body-name": "body"
      }
    },
    "/catalogs/{id}/descriptions": {
      "get": {
        "tags": [
          "Catalogs"
        ],
        "summary": "Get the descriptions of a catalog.",
        "operationId": "getCatalogDescriptions",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the catalog.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId"
            },
            "x-context-data": "storeId"
          },
          {
            "name": "dataLanguageIds",
            "in": "query",
            "description": "The integer(s) for identifying the language of the catalog description. For a list of the integers that map to the supported default languages, refer to the Knowledge Center. Multiple identifiers should be specified as a comma-separated list.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CatalogDescriptionCollection"
                }
              }
            },
            "x-entity-path": "dataArea/catalog[1]/description"
          }
        },
        "x-expression-template": "{_wcf.ap='{accessProfile}';_wcf.dataLanguageIds='{dataLanguageIds}'}/Catalog[CatalogIdentifier[(UniqueID='{id}')]]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "getCatalog",
        "x-parameters": {
          "accessProfile": "IBM_Admin_Details"
        },
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.GetCatalogType"
      },
      "post": {
        "tags": [
          "Catalogs"
        ],
        "summary": "Add descriptions to a catalog.",
        "operationId": "createCatalogDescription",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the catalog.",
            "required": true,
            "schema": {
              "type": "string",
              "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/uniqueID"
            },
            "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/uniqueID"
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The unique numeric ID for identifying the store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "x-context-data": "storeId",
              "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/externalIdentifier/storeIdentifier/uniqueID"
            },
            "x-context-data": "storeId",
            "x-entity-path": "dataArea/catalog[1]/catalogIdentifier/externalIdentifier/storeIdentifier/uniqueID"
          }
        ],
        "requestBody": {
          "description": "The request body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CatalogDescription"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation is successful.",
            "headers": {
              "Location": {
                "description": "The URI of the catalog description.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetCatalogDescriptions": {
                "operationRef": "#/paths/~1catalogs~1{id}~1descriptions/get",
                "parameters": {
                  "id": "$request.path#/id",
                  "storeId": "$request.query.storeId",
                  "dataLanguageIds": "$request.body#/languageId"
                },
                "description": "The `id`,`storeId`value used in the request body can be used as the `id`,'storeId`' parameter in `GET /catalogs/{id}/descriptions`.\n"
              },
              "UpdateCatalogDescription": {
                "operationRef": "#/paths/~1catalogs~1{catalogId}~1descriptions/{id}/patch",
                "parameters": {
                  "catalogId": "$request.path.id",
                  "id": "$request.body#/languageId",
                  "storeId": "$request.query.storeId"
                },
                "description": "The `catalogId`,`languageId`,`storeId` value used in the request body can be used as the `catalogId`,`languageId`,`storeId` parameter  in PATCH /catalogs/{catalogId}/descriptions/{id}`.\n"
              }
            }
          }
        },
        "x-action-code": "Change",
        "x-expression-template": "/Catalog[1]/Description[1]",
        "x-facade-client-class": "com.ibm.commerce.catalog.facade.client.CatalogFacadeClient",
        "x-facade-client-method": "changeCatalog",
        "x-request-bod-class": "com.ibm.commerce.catalog.facade.datatypes.ChangeCatalogType",
        "x-request-verb": "change",
        "x-codegen-request-body-name": "body"
      }
    }
  },
  "components": {
    "schemas": {
      "Catalog": {
        "type": "object",
        "properties": {
          "attributes": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "The attributes.",
            "readOnly": true,
            "x-entity-path": "attributes"
          },
          "default": {
            "type": "boolean",
            "description": "The default value.",
            "readOnly": true,
            "x-entity-path": "default"
          },
          "descriptions": {
            "type": "array",
            "readOnly": true,
            "items": {
              "$ref": "#/components/schemas/CatalogDescription"
            },
            "x-entity-path": "description"
          },
          "id": {
            "type": "string",
            "description": "The unique numeric ID for identifying the catalog.",
            "readOnly": true,
            "x-entity-path": "catalogIdentifier/uniqueID"
          },
          "identifier": {
            "type": "string",
            "description": "The catalog identifier.",
            "x-entity-path": "catalogIdentifier/externalIdentifier/identifier"
          },
          "organizationId": {
            "type": "string",
            "description": "The numeric ID of the organization that owns the catalog.",
            "readOnly": true,
            "x-entity-path": "catalogIdentifier/externalIdentifier/ownerID"
          },
          "masterCatalog": {
            "type": "boolean",
            "description": "Indicates that this is the master catalog.",
            "readOnly": true,
            "x-entity-path": "primary"
          },
          "storeId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the store.",
            "format": "int32",
            "readOnly": true,
            "x-entity-path": "catalogIdentifier/externalIdentifier/storeIdentifier/uniqueID"
          }
        },
        "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.CatalogType"
      },
      "CatalogCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "format": "int64",
            "x-entity-path": "show/recordSetTotal"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Catalog"
            },
            "x-entity-path": "catalog"
          }
        },
        "description": "A collection of catalogs."
      },
      "CatalogDescription": {
        "type": "object",
        "properties": {
          "available": {
            "type": "integer",
            "description": "Indicates the length of time of availability of this catalog entry. This field is for your internal business use and information only. Do not use this column to indicate inventory levels. The default value is 1.",
            "format": "int32",
            "default": 1,
            "x-entity-path": "attributes/available"
          },
          "breadcrumbs": {
            "type": "array",
            "description": "The breadcrumbs of this catalog.",
            "items": {
              "type": "string"
            },
            "x-entity-path": "breadcrumb"
          },
          "fullImage": {
            "type": "string",
            "description": "The full image path of this catalog.",
            "x-entity-path": "fullImage"
          },
          "keyword": {
            "type": "string",
            "description": "Language-specific keywords that are used for searching.",
            "x-entity-path": "keyword"
          },
          "languageId": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the language.",
            "format": "int32",
            "x-entity-path": "language"
          },
          "longDescription": {
            "type": "string",
            "description": "The long description.",
            "x-entity-path": "longDescription"
          },
          "name": {
            "type": "string",
            "description": "The name.",
            "x-entity-path": "name"
          },
          "override": {
            "type": "array",
            "description": "The override property of this catalog.",
            "items": {
              "$ref": "#/components/schemas/CatalogDescriptionOverride"
            },
            "x-entity-path": "override"
          },
          "published": {
            "type": "integer",
            "description": "Indicates whether to display this catalog entry on the storefront:\n* 0 - Do not display this catalog entry.\n* 1 - Display this catalog entry.\n",
            "format": "int32",
            "enum": [
              0,
              1
            ],
            "x-entity-path": "attributes/published"
          },
          "shortDescription": {
            "type": "string",
            "description": "The short description.",
            "x-entity-path": "shortDescription"
          },
          "thumbnail": {
            "type": "string",
            "description": "The thumbnail image path of this catalog.",
            "x-entity-path": "thumbnail"
          }
        },
        "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.CatalogDescriptionType"
      },
      "CatalogDescriptionCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "format": "int64",
            "readOnly": true
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CatalogDescription"
            }
          }
        },
        "description": "A collection of catalog descriptions."
      },
      "CatalogDescriptionOverride": {
        "type": "object",
        "properties": {
          "fullImage": {
            "type": "string",
            "description": "The full image path of this catalog.",
            "x-entity-path": "fullImage"
          },
          "id": {
            "type": "string",
            "description": "The unique numeric ID for identifying the catalog description override.",
            "readOnly": true,
            "x-entity-path": "descriptionOverrideIdentifier/uniqueID"
          },
          "keyword": {
            "type": "string",
            "description": "Language-specific keywords that are used for searching.",
            "x-entity-path": "keyword"
          },
          "longDescription": {
            "type": "string",
            "description": "The language-specific long description of this catalog.",
            "x-entity-path": "longDescription"
          },
          "name": {
            "type": "string",
            "description": "The language-specific display name of this catalog.",
            "x-entity-path": "name"
          },
          "shortDescription": {
            "type": "string",
            "description": "The language-specific short description of this catalog.",
            "x-entity-path": "shortDescription"
          },
          "thumbnail": {
            "type": "string",
            "description": "The thumbnail image path of this catalog.",
            "x-entity-path": "thumbnail"
          }
        },
        "x-entity-class": "com.ibm.commerce.catalog.facade.datatypes.CatalogDescriptionOverrideType"
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}