--- title: "Get the channel catalog information" method: GET path: "/v2/user/channelCatalogs/{channelCatalogId}" tags: ["Channel Catalogs - Global"] --- # Get the channel catalog information `GET /v2/user/channelCatalogs/{channelCatalogId}` ## Path parameters - `channelCatalogId` string, guid, required ## Response `200` Channel catalog - ChannelCatalog — The channel catalog - `channelId` string, guid, required — The channel identifier - `channelName` string, required — The channel name - `channelImageUrl` string, required — The URL https://en.wikipedia.org/wiki/URL - `enabled` boolean, required — Indicates if the channel catalog is enable - `isMarketplace` boolean, required — Indicates if this channel catalog is related to a marketplace - `channelCatalogId` string, guid, required — The channel catalog identifier - `storeId` string, guid, required — The store identifier - `generalSettings` GeneralSettings, required — Represents the general settings of your channel catalog - `acceptToPublishInfo` boolean, required — If true then you authorize disclosure of my statistics generated from clicks and sales - `doNotExportOutOfStockProducts` boolean, required — Do not export "out of stock" products. Note: this option is not taken into account by the counter. - `activeBeezUPTracking` boolean, required — Activate BeezUP tracking for my statistics (checked by default) - `channelCostSettings` ChannelCostSettings, required — Indicate the default configuration of the cost on this channel. - `costType` 'CPC_Global' | 'CPA_Global' | 'CPC_ByCategory' | 'CPA_ByCategory' | 'Fixed_Global', required — CPC means cost per click. CPA means cost per action. You can have CPC/CPA with a global cost value. You can have CPC/CPA by category the cost value MUST be null You can have global fixed price. - `globalCostValue` number — In case of global cost type, you have to indicate the cost value. - `channelCategorySettings` ChannelCategorySettings, required - `mappingRequired` boolean — Indicates if the category mapping is required, otherwise you can map the categories but it will not block the publication of your catalog - `mappingLeafRequired` boolean — Indicates if the category mapping is required on category path leaf or not - `costSettings` CostSettings — If this property is not indicated please force the user to configure the cost settings. Defines the cost type you have on this channel with the cost value. - `costType` 'CPC_Global' | 'CPA_Global' | 'CPC_ByCategory' | 'CPA_ByCategory' | 'Fixed_Global', required — CPC means cost per click. CPA means cost per action. You can have CPC/CPA with a global cost value. You can have CPC/CPA by category the cost value MUST be null You can have global fixed price. - `globalCostValue` number — In case of global cost type, you have to indicate the cost value. - `categoryMappingSettings` ChannelCatalogCategoryMappingSettings - `categoryMappingDisabledByMerchant` boolean — Optional parameter. Indicates that you have decided to do not map your categories with the channel's categories. - `columnMappings` ChannelCatalogColumnMappingWithName[] — The column mapping list between a channel and a catalog - `channelColumnId` string, guid, required — The channel column identifier - `channelCategoryPath` string[] — The channel category path - `catalogColumnId` string, guid — The catalog column identifier (catalog or custom column) - `channelColumnName` string, required — The channel column name - `channelBeezUPColumnName` string — The BeezUP column name - `catalogColumnName` string — The catalog column named by the user (catalog or custom column) - `catalogBeezUPColumnName` string — The BeezUP column name - `exclusionFilters` ExclusionFilter[] — The exclusion filter list - `name` string, required — The exclusion filter name - `position` integer, required — The position of the exclusion filter - `groupId` string, guid, required — Indicate the filter's group. All filters in the same group means an "AND" operation in the filter group - `positionInGroup` integer, required — Indicate the filter group position. This information is used for the UI purpose and must be unique in the filter group. - `channelColumnId` string, guid, required — The channel column identifier - `operatorName` string, required — The exclusion filter operator name - `value` string — The value indicate by the user when the filter operation requires it. - `enabled` boolean, required — indicates if the filter is currently enable. - `exportUrl` string — The URL https://en.wikipedia.org/wiki/URL - `state` ChannelCatalogState, required — Channel Catalog State - `exportedProductCount` integer, required - `columnMappingStatus` 'warning' | 'success' | 'failed', required - `categoryMappingState` CategoryMappingState, required — The category mapping state of the channel catalog - `status` 'warning' | 'success' | 'failed' - `uncategorizedProductCount` integer — Indicates the uncategorized product count - `withoutCategoryCostProductCount` integer — Indicates the count of products without cost defined - `apiSettingsStatus` 'warning' | 'success' | 'failed' - `types` string[], required — The channel type list related to the channel - `links` ChannelCatalogLinks, required — Indicates the actions you can do on a channel catalog - `self` LinksGetChannelCatalogLink, required - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `delete` LinksDeleteChannelCatalogLink - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `enable` LinksEnableChannelCatalogLink - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `disable` LinksDisableChannelCatalogLink - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `configureGeneralSettings` LinksConfigureChannelCatalogGeneralSettingsLink - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `configureCostSettings` LinksConfigureChannelCatalogCostSettingsLink - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `configureColumnMappings` LinksConfigureChannelCatalogColumnMappingsLink - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `reenableCategoryMappings` LinksReenableChannelCatalogCategoryMappingLink - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `disableCategoryMappings` LinksDisableChannelCatalogCategoryMappingLink - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `categoryMappings` LinksGetChannelCatalogCategoriesLink — If you did not configure the cost settings this link will not be displayed. - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `exclusionFilters` LinksGetChannelCatalogExclusionFiltersLink - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `products` LinksGetChannelCatalogProductInfoListLink - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `exportationCacheInfo` LinksGetChannelCatalogExportationCacheInfoLink - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `marketplaceSettings` ExternalLinksGetChannelCatalogMarketplaceSettingsLink - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `channelInfo` ExternalLinksGetChannelInfoLink - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string ## Other responses - `404` — ChannelCatalogId not found or not authorized - `default` — Occurs when something goes wrong --- [API](https://skmtc.net/beezup/apis/beezup-merchant-api.md) · [All operations](https://skmtc.net/beezup/apis/beezup-merchant-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/beezup/beezup-merchant-api/versions/557b7feddf8a/schema)