v1

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

Get channel catalog product information list

post/v2/user/channelCatalogs/{channelCatalogId}/products

Path parameters

channelCatalogIdstring guid required

The channel catalog identifier

Request body

pageNumberinteger required
pageSizeinteger required
overriddenboolean

Search overridden products. If null the filter will not be taken in account.

Example request

{
  "productFilters": {
    "title": "Refrigérateur"
  },
  "catalogCategoryFilter": {
    "categoryPath": [
      "Maison",
      "Chambre"
    ]
  },
  "channelCategoryFilter": {
    "categoryPath": [
      "Home",
      "Bedroom"
    ]
  }
}

Response

Channel catalog product information

Example response

{
  "paginationResult": {
    "entryCount": "25",
    "pageCount": "38",
    "totalEntryCount": "943",
    "links": {
      "first": {
        "href": "/v2/user/marketplaces/orders/list/full",
        "method": "POST",
        "parameters": [
          {
            "name": "request",
            "in": "body",
            "type": "object",
            "schema": "orderListRequest",
            "value": {
              "beginPeriodUtcDate": "2014-08-25T07:32:31.584Z",
              "endPeriodUtcDate": "2014-09-24T07:32:31.584Z",
              "pageSize": "25",
              "pageNumber": "1"
            }
          }
        ]
      },
      "last": {
        "href": "/v2/user/marketplaces/orders/list/full",
        "method": "POST",
        "parameters": [
          {
            "name": "request",
            "in": "body",
            "type": "object",
            "schema": "orderListRequest",
            "value": {
              "beginPeriodUtcDate": "2014-08-25T07:32:31.584Z",
              "endPeriodUtcDate": "2014-09-24T07:32:31.584Z",
              "pageSize": "25",
              "pageNumber": "38"
            }
          }
        ]
      },
      "next": {
        "href": "/v2/user/marketplaces/orders/list/full",
        "method": "POST",
        "parameters": [
          {
            "name": "request",
            "in": "body",
            "type": "object",
            "schema": "orderListRequest",
            "value": {
              "beginPeriodUtcDate": "2014-08-25T07:32:31.584Z",
              "endPeriodUtcDate": "2014-09-24T07:32:31.584Z",
              "pageSize": "25",
              "pageNumber": "2"
            }
          }
        ]
      }
    }
  },
  "links": {
    "self": {
      "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/products",
      "method": "POST"
    },
    "export": {
      "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/products/export",
      "method": "POST",
      "parameters": {
        "format": {
          "in": "query",
          "required": true,
          "type": "string",
          "value": "csv"
        }
      }
    }
  },
  "productInfos": [
    {
      "productId": "00000000-0000-0000-0000-000000000000",
      "productSku": "SKU1234",
      "productTitle": "My supert product",
      "productImageUrl": "http://i2.cdscdn.com/pdt2/3/9/0/1/550x550/hai6901018043390/rw/haier-b20fwrss-refrigerateur-americain.jpg",
      "overrides": {
        "8a76f06a-fefc-4c0d-bcfe-b210f1482977": {
          "catalogValue": "x235",
          "override": "3563"
        },
        "B7B79A0B-A8DE-54DA-964C-E2704DF3738A": {
          "catalogValue": "x_ezlSHBELNL56",
          "override": "SHBELNL56"
        },
        "57F70E81-E4F2-5034-BC65-E1D5C48EBEDA": {
          "catalogValue": "Sony",
          "override": "Sony bravia"
        },
        "2A77749D-0AAB-5245-89B5-6A1A4E06DACA": {
          "catalogValue": "http://www.toto.com/thing/images/cache/dldldl.jpg",
          "override": "http://www.blalbla.nl/images/cache/dldldl.jpg"
        },
        "54B3B3CB-5CA5-5471-9DAE-5310C032059A": {
          "catalogValue": "http://www.toto.com/thing/cache/dlmdl.jpg",
          "override": "http://www.blalbla.nl/images/cache/dlmdl.jpg"
        },
        "0EA21509-1141-57BD-B679-371BC98B2ADA": {
          "catalogValue": "http://www.toto.com/thing/images/cache/ldldld.jpg",
          "override": "http://www.blalbla.nl/images/cache/ldldld.jpg"
        }
      },
      "excludedBy": [
        "Exclude sony products"
      ],
      "links": {
        "self": {
          "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/products/578419df-1bbf-41a6-96fa-862e42182b67",
          "method": "GET"
        },
        "override": {
          "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/products/578419df-1bbf-41a6-96fa-862e42182b67/overrides",
          "method": "POST"
        },
        "disable": {
          "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/products/578419df-1bbf-41a6-96fa-862e42182b67/disable",
          "method": "POST"
        },
        "reenable": {
          "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0/products/578419df-1bbf-41a6-96fa-862e42182b67/reenable",
          "method": "POST"
        }
      }
    }
  ]
}