Sign in

v1

latestSwagger 2.0BeezUP2026-07-13254876845.8 KB
Channel Catalogs - Global

Get the channel catalog information

get/v2/user/channelCatalogs/{channelCatalogId}

Path parameters

channelCatalogIdstring guid required

The channel catalog identifier

Response

Channel catalog

channelIdstring guid required

The channel identifier

channelNamestring required

The channel name

channelImageUrlstring required

The URL <a href="https://en.wikipedia.org/wiki/URL">https://en.wikipedia.org/wiki/URL</a>

enabledboolean required

Indicates if the channel catalog is enable

isMarketplaceboolean required

Indicates if this channel catalog is related to a marketplace

channelCatalogIdstring guid required

The channel catalog identifier

storeIdstring guid required

The store identifier

exportUrlstring

The URL <a href="https://en.wikipedia.org/wiki/URL">https://en.wikipedia.org/wiki/URL</a>

typesstring[] required

The channel type list related to the channel

Example response

{
  "channelId": "2dc136a7-0d3d-4cc9-a825-a28a42c53e28",
  "channelName": "Amazon FRA",
  "channelImageUrl": "http://www.mydomain.com",
  "channelCatalogId": "6d6b04de-406b-4539-8e7e-bf3e8da5dfb0",
  "storeId": "64f43358-63a1-47f7-97ec-0301fc39956b",
  "channelCostSettings": {
    "costType": "Fixed_Global"
  },
  "costSettings": {
    "costType": "Fixed_Global"
  },
  "columnMappings": [
    {
      "channelColumnId": "8a76f06a-fefc-4c0d-bcfe-b210f1482977",
      "channelCategoryPath": [
        "Clothing",
        "Women",
        "Shoes"
      ],
      "catalogColumnId": "bea7c21e-948b-4ac3-9ffd-4396e62c4163",
      "channelColumnName": "NAME",
      "channelBeezUPColumnName": "CategoryFirstLevel",
      "catalogColumnName": "My title",
      "catalogBeezUPColumnName": "CategoryFirstLevel"
    }
  ],
  "exclusionFilters": [
    {
      "name": "Exclude sony products",
      "groupId": "d9833f4b-718a-436f-bab5-89da3d21bf60",
      "channelColumnId": "8a76f06a-fefc-4c0d-bcfe-b210f1482977",
      "operatorName": "Contains",
      "value": "sony"
    }
  ],
  "exportUrl": "http://www.mydomain.com",
  "state": {
    "columnMappingStatus": "success",
    "categoryMappingState": {
      "status": "success"
    },
    "apiSettingsStatus": "success"
  },
  "types": [
    "Marketplace"
  ],
  "links": {
    "self": {
      "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0",
      "method": "GET"
    },
    "delete": {
      "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0",
      "method": "DELETE"
    },
    "enable": {
      "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/enable",
      "method": "POST"
    },
    "disable": {
      "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/disable",
      "method": "POST"
    },
    "configureGeneralSettings": {
      "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/settings/general",
      "method": "POST"
    },
    "configureCostSettings": {
      "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/settings/cost",
      "method": "POST"
    },
    "configureColumnMappings": {
      "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/columnMappings",
      "method": "PUT"
    },
    "reenableCategoryMappings": {
      "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/categories/reenableMapping",
      "method": "POST"
    },
    "disableCategoryMappings": {
      "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/categories/disableMapping",
      "method": "POST"
    },
    "categoryMappings": {
      "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/categories",
      "method": "GET"
    },
    "exclusionFilters": {
      "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/exclusionFilters",
      "method": "GET"
    },
    "products": {
      "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/products",
      "method": "POST"
    },
    "exportationCacheInfo": {
      "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/exportations/cache",
      "method": "GET"
    },
    "marketplaceSettings": {
      "href": "/v2/user/marketplaces/channelcatatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/settings",
      "method": "GET"
    },
    "channelInfo": {
      "href": "/v2/user/channels/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0",
      "method": "GET"
    }
  }
}