Sign in

v1

latestSwagger 2.0BeezUP2026-07-13254876845.8 KB
Catalogs - Catalog

Get product list

post/v2/user/catalogs/{storeId}/products/list

Path parameters

storeIdstring guid required

Your store identifier

Request body

pageNumberinteger required

Indicates the page number

pageSizeinteger required

Indicate the item count per page

columnIdListBeezUPCommonCatalogColumnId[]
existsboolean

Search for existing products or not. If null you will received both.

productIdListBeezUPCommonProductId[]

Filter with a list of product identifier

skustring

Search for product by sku

eanstring

Search for product by ean

mpnstring

Search for product by mpn

titlestring

Search for products containing this title

categoryPathstring[]

The catalog category path

orderByCatalogColumnIdstring guid

The catalog column identifier (catalog or custom column)

withoutSubCategoriesboolean

Do not retrieve sub categories. By default, this value is set to false

Example request

{
  "columnIdList": [
    "bea7c21e-948b-4ac3-9ffd-4396e62c4163"
  ],
  "productIdList": [
    "578419df-1bbf-41a6-96fa-862e42182b67"
  ],
  "sku": "MySku123",
  "ean": "MySku123",
  "mpn": "MySku123",
  "title": "Frigo",
  "categoryPath": [
    "Vêtements",
    "Femmes",
    "Chaussures"
  ],
  "orderByCatalogColumnId": "bea7c21e-948b-4ac3-9ffd-4396e62c4163"
}

Response

Product list

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"
            }
          }
        ]
      }
    }
  },
  "products": [
    {
      "productId": "578419df-1bbf-41a6-96fa-862e42182b67",
      "categoryId": "81a058a6-0451-4b79-84ef-94c58d0ed4ac",
      "values": {
        "68082b11-4ffd-4bec-964a-465a471c7d37": "SKU1234",
        "b6d74510-41ce-42ec-947a-0bdf62e9beee": "Refrigerateur",
        "012929c0-e78b-462a-a96e-25c061575385": "http://media.conforama.fr/Medias/500000/80000/5000/500/10/G_585511_A.jpg",
        "ba270fa0-8482-46be-905a-cae4ca746b92": "http://www.conforama.fr/gros-electromenager/encastrable/refrigerateur-encastrable/refrigerateur-combine-161-litres-far-r5115s/p/585511",
        "46602e10-bc45-4944-a440-63d5f7ece1f8": "42"
      }
    }
  ]
}