Запросы отправляются методом GET или POST, сервер выдает ответ в формате json

При использовании метода POST, token необходимо отправлять в Headers через "Api-Key: ваш токен".

Для работы с API необходим token, который находиться в разделе "Пользователи"

Адрес API: https://api.waffeex.com/v1/


Список методов:

  • Список доступных ритейлеров
  • Список доступных городов
  • Получение цены на товар
  • Получение цены на товар в маркетплейсах
  • Получение цены Repricing
  • Получение цен продавцов с kaspi.kz (Real time)
  • Обновление остатков
  • Каспи аналитика



  • Список доступных ритейлеров:

    Параметры запроса:

    Параметр Описание По-умолчанию
    token Ваш личный авторизационный ключ
    retailer_id Доступные значения:
    me - выводит список ритейлеров доступных вашей группе.
    all_me - выводит весь список доступных рителейров.

    Пример запроса:

    https://api.waffeex.com/v1/?token={your_token}&retailer_id=me

    Параметры ответа:

    Параметр Описание
    id ID ритейлера
    name Наименование ритейлера

    Пример ответа:

    [
        {
          "id": "1",
          "retailer_name": "Chocomart"
        },
        {
          "id": "4",
          "retailer_name": "Белый ветер (Караганда)"
        }
    ]
    


    Список доступных городов:

    Параметры запроса:

    Параметр Описание По-умолчанию
    token Ваш личный авторизационный ключ
    city Доступные значения:
    all - выводит весь список доступных городов.

    Пример запроса:

    https://api.waffeex.com/v1/?token={your_token}&city=all

    Параметры ответа:

    Параметр Описание
    id ID города
    name Наименование города

    Пример ответа:

    [
        {
          "id": "1",
          "city_name": "Алматы"
        },
        {
          "id": "2",
          "city_name": "Нур-Султан (Астана)"
        }
    ]
    


    Получение цены на товар

    Параметры запроса:

    Параметр Описание По-умолчанию
    token Ваш личный авторизационный ключ
    retailer_id ID ритейлера. Возможно указать несколько ритейлеров, через запятую.
    code Код товара из вашей учетной системы (1c, SAP и т.д.). Возможно указать несколько кодов товара, через запятую или указать значение all, в этом случае, система получить все ID товаров, которые есть сейчас в наличие.

    Пример запроса:

    https://api.waffeex.com/v1/?token={your_token}&retailer_id=5,6,7,8,9,10,11,12,13,14,39,223,246&code=УТ-00115267,12341245

    Параметры ответа:

    Параметр Описание
    name Наименование товара
    category Название категории
    code Ваш код товара
    prices Массив с ценами
    retailer_name Название ритейлера
    retailer_id ID ритейлера
    price Цена на товар
    update_at Дата и время последнего обновления цены в timestamp

    Пример ответа:

    {
     "offers": [
        {
            "name": "Колонки Mi Bluetooth Speaker Square Box Чёрный",
            "category": "Колонки",
            "code": "УТ-00115267",
            "prices": [
               {
                 "retailer_name": "Сулпак (Алматы)",
                 "retailer_id": "7",
                 "price": "53980",
                 "update_at": "1629436807"
               },
               {
                 "retailer_name": "Технодом (Алматы)",
                 "retailer_id": "10",
                 "price": "54990",
                 "update_at": "1629436807"
              }
            ]
        },
        {
            "name": "Холодильник Midea MDRB521MGE05T",
            "category": "Холодильники",
            "code": "12341245",
            "prices": [
               {
                 "retailer_name": "Сулпак (Алматы)",
                 "retailer_id": "7",
                 "price": "399900",
                 "update_at": "1629436807"
               },
               {
                 "retailer_name": "Алсер (Алматы)",
                 "retailer_id": "10",
                 "price": "389990",
                 "update_at": "1629436807"
              }
            ]
         }
      ]
    }
    


    Получение цены на товар в маркетплейсах

    Параметры запроса:

    Параметр Описание По-умолчанию
    token Ваш личный авторизационный ключ
    code Код товара из вашей учетной системы (1c, SAP и т.д.). Возможно указать несколько кодов товара, через запятую или указать значение all, в этом случае, система получить все ID товаров, которые есть сейчас в наличие.
    kaspi_position Получение цены продавца на товар, который продает на определенной позиции в карточке товара
    При указании значения all вместе с параметром dumping, то будет выводиться весь товар со всеми партнерами, которые его продают.
    dumping Применимо только вместе в параметром kaspi_position=all
    1 - будет выводит список товаров и всех партнеров, которые ниже ваших текущих цен по данной позиции
    0 - будет выводиться весь список товаров и партнеров, которые продают данный товар.
    city ID города, по которму надо получить цену

    Пример запроса:

    https://api.waffeex.com/v1/?token={your_token}&code=all&kaspi_position=5&city=1

    Параметры ответа:

    Параметр Описание
    name Наименование товара
    category Название категории
    code Ваш код товара
    price Ваша текущая цена
    prices Массив с ценами
    retailer_name Название ритейлера
    retailer_id ID ритейлера
    price Цена на товар
    update_at Дата и время последнего обновления цены в timestamp

    Пример ответа:

    {
     "offers": [
        {
            "name": "Колонки Mi Bluetooth Speaker Square Box Чёрный",
            "category": "Колонки",
            "code": "УТ-00115267",
            "price": "54990",
            "prices": [
               {
                 "retailer_name": "Сулпак (Алматы)",
                 "retailer_id": "7",
                 "price": "53980",
                 "update_at": "1629436807"
               }
            ]
        },
        {
            "name": "Холодильник Midea MDRB521MGE05T",
            "category": "Холодильники",
            "code": "12341245",
            "price": "399900",
            "prices": [
               {
                 "retailer_name": "Сулпак (Алматы)",
                 "retailer_id": "7",
                 "price": "399900",
                 "update_at": "1629436807"
               }
            ]
         }
      ]
    }
    

    Получение цены Repricing

    Параметры запроса:

    Параметр Описание По-умолчанию
    token Ваш личный авторизационный ключ
    repricing 1

    Пример запроса:

    https://api.waffeex.com/v1/?token={your_token}&repricing=1

    Параметры ответа:

    Параметр Описание
    name Наименование товара
    category Категория товара
    product_id Внутрений код Waffeex
    code Код товара Партнера
    price Цена рассчитана при помощи Repricing

    Пример ответа:

    {
     "offers": [
        {
            "name": "Монитор Philips 193V5LSB2",
            "category": "Мониторы",
            "product_id": "907",
            "code": "УТ-00115267",
            "price": "45954"
        },
        {
            "name": "Принтер Epson L1300 (C11CD81402)",
            "category": "Принтеры",
            "product_id": "1148",
            "code": "123545523",
            "price": "154201"
        }
      ]
    }
    

    Парсинг цен с сайтов в реальном времени

    Параметры запроса (Только POST-запросы):

    Параметр Описание По-умолчанию
    token Ваш личный авторизационный ключ.
    Лимит на группу - 50 запросов одновременно
    parsing_url Ссылка на товар с сайта конкурента.
    Формат ссылки: https://kaspi.kz/shop/p/xiaomi-redmi-note-10s-6-128gb-seryi-101501192/?c=750000000
    Обязательно URL должен быть json_encode.
    Timeout ответа 60 секунд

    Поддерживамые сайты:
    kaspi.kz

    Пример запроса на PHP:

    $urls = 'https://kaspi.kz/shop/p/xiaomi-redmi-note-10s-6-128gb-seryi-101501192/?c=750000000';
    
    $curl = curl_init();
    curl_setopt_array($curl, array(
      CURLOPT_URL => "https://api.waffeex.com/v1/",
      CURLOPT_HTTPHEADER =>
        array(
          "Content-Type: application/x-www-form-urlencoded"
        ),
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_SSL_VERIFYPEER => 0,
      CURLOPT_SSL_VERIFYHOST => 0,
      CURLOPT_CUSTOMREQUEST => "POST",
      CURLOPT_POSTFIELDS => http_build_query(
        array(
          "token" => "{your token here}",
    	  "parsing_url" => json_encode($urls)
        )
      ),
    ));
    
    $result = curl_exec($curl);
    $err = curl_error($curl);
    
    curl_close($curl);
    

    Пример ответа:

    Пример массив с данными по kaspi.kz
    


    Обновление остатков

    Параметры запроса:

    POST https://api.waffeex.com/v1/?update_stocks
    Параметр Описание По-умолчанию
    token Ваш личный авторизационный ключ.
    Через headers - "Api-Key: your_token"
    Body request Массив с двуми параметрами:
    warecode - код товара из учетной системы
    stock - кол-во товара (при передачи stock = 0, товар будет переходить в статус нет в наличии)

    Пример запроса:

    https://api.waffeex.com/v1/?update_stocks
    body request: 
    [{"warecode": "D00000000519", "stock":"100"}, {"warecode":"14171", "stock":"2" }]

    Параметры ответа:

    Параметр Описание
    warecode Возвращается код товара со статусом:
    update - данные обновлись.
    not found - данные не обновились (возможно данного кода товар нет в базе или код товара не правильный)

    Пример ответа:

    {
        "data": [
            {
                "D00000000519": "update"
            },
            {
                "14171": "not found"
            }
        ]
    }
    

    Каспи аналитика

    Метод позволяет получать аналитику по продавцам, категориям и брендам.

    URL

    https://api.waffeex.com/v1/kaspiAnalytics

    Метод

    POST / GET

    Параметры запроса

    Параметр Обязательный Тип Описание
    token Ваш личный авторизационный ключ.
    Через headers - "Api-Key: your_token"
    Да string
    analyticsReport Да string Тип отчета:
    category - получение данных по всем категориям
    product - получение данных по товарам
    analog - получение аналогов по sku, только вместе с filterName
    brand - получение данных по брендам
    merchant - получение данных по мерчанту
    dateFrom Да string Начальная дата периода в формате YYYY-MM-DD
    dateTo Да string Конечная дата периода в формате YYYY-MM-DD
    filterName Нет string Получение детальных данных:
    Для category — название категории (можно несколько через запятую)
    Для product — код товара каспи (можно несколько через запятую)
    Для analog — код каспи (один код в запросе)
    Для brand — название бренда (можно несколько через запятую)

    Особенности

    Примеры запроса (POST)

    [
      {
        "analyticsReport": "category",
        "dateFrom": "2025-08-01",
        "dateTo": "2025-08-14",
        "filterName": "Смартфоны,Телевизоры"
      }
    ]

    Примеры запроса (GET)

    https://api.waffeex.com/v1/kaspiAnalytics?
    analyticsReport=category&
    dateFrom=2025-08-01&
    dateTo=2025-08-14&
    filterName=Смартфоны,Телевизоры

    Пример успешного ответа для category

    {
      "data": [
        {
          "categoryName": "Красота и здоровье",
          "categoryName2": "Декоративная косметика",
          "categoryName3": "",
          "categoryName4": "Румяна, бронзеры, скульптурирующие средства",
          "categoryProductsCount": 2695,
          "categoryProductsPercent": 6.1,
          "medianPrice": 6200,
          "medianPricePercent": -1.43,
          "categorySales": "9526",
          "categorySalesChangePercent": -42.75,
          "categoryTotalRevenue": "57081327",
          "categoryRevenueChangePercent": -44.76,
          "totalMerchant": 479,
          "totalMerchantChangePercent": 1.27,
          "merchantWithSales": 44,
          "merchantWithSalesChangePercent": 2.33,
          "totalBrands": "301",
          "brandsChangePercent": 0.67,
          "brandsWithSales": 26,
          "percentBrandsWithSales": 0
        },
        {...}
      ]
    }
    Поле Описание
    categoryNameНазвание основной категории
    categoryName2–4Подкатегории до 4-го уровня вложенности
    categoryProductsCountКоличество товаров в категории
    categoryProductsPercentИзменение количества товаров в % относительно предыдущего периода
    medianPriceМедианная цена товаров в категории
    medianPricePercentИзменение медианной цены в % относительно предыдущего периода
    categorySalesКоличество продаж
    categorySalesChangePercentИзменение продаж в % относительно предыдущего периода
    categoryTotalRevenueОбщая выручка
    categoryRevenueChangePercentИзменение выручки в % относительно предыдущего периода
    totalMerchantКоличество продавцов
    totalMerchantChangePercentИзменение числа продавцов в % относительно предыдущего периода
    merchantWithSalesПродавцы с продажами
    merchantWithSalesChangePercentИзменение продавцов с продажами в % относительно предыдущего периода
    totalBrandsКоличество брендов
    brandsChangePercentИзменение количества брендов в % относительно предыдущего периода
    brandsWithSalesБренды с продажами
    percentBrandsWithSalesДоля брендов с продажами в % относительно предыдущего периода

    Пример успешного ответа для category с filterName

    {
      "data": [
        {
          "categoryName": "ТВ, Аудио, Видео",
          "categoryName2": "",
          "categoryName3": "",
          "categoryName4": "Телевизоры",
          "categoryProductsCount": 316,
          "categoryProductsChangePercent": 81.61,
          "medianPrice": 208675,
          "medianPriceChangePercent": 3.05,
          "categorySales": "19466",
          "categorySalesChangePercent": -33.08,
          "categoryTotalRevenue": "4305669534",
          "categoryRevenueChangePercent": -32.9,
          "totalMerchant": 298,
          "totalMerchantChangePercent": 41.9,
          "merchantWithSales": 53,
          "merchantWithSalesChangePercent": 1.92,
          "totalBrands": "121",
          "brandsChangePercent": 1.68,
          "brandsWithSales": 19,
          "percentBrandsWithSales": 0,
          "categorySalesPerDay": [
            {
              "date": "2025-08-01",
              "categoryTotalRevenue": "510275700",
              "categorySales": "2430",
              "categoryProductsCount": "124",
              "medianPrice": "209990"
            },
            {...}
          ],
          "segmentSales": [
            {
              "priceFrom": "40001",
              "priceTo": "50000",
              "revenue": "20960524",
              "revenueChangePercent": -40.72,
              "totalSales": "524",
              "salesChangePercent": -40.72,
              "merchant": "297",
              "merchantChangePercent": 0,
              "totalUniqueProductsInSegment": "11",
              "totalUniqueProductsInSegmentChangePercent": -8.33,
              "totalProductsWithSale": "11",
              "totalProductsWithSaleChangePercent": 0,
              "totalUniqueBrandsInSegment": "9",
              "totalUniqueBrandsInSegmentChangePercent": -10,
              "totalUniqueBrandsWithSale": "9",
              "totalUniqueBrandsWithSaleChangePercent": 0
            },
            {...}
          ]
        }
      ]
    }
    Поле Описание
    categoryName1–4Название категории и подкатегорий
    categoryProductsCountКоличество товаров в категории
    categoryProductsChangePercentИзменение количества товаров в % относительно предыдущего периода
    medianPriceМедианная цена товаров категории (в тенге)
    medianPriceChangePercentИзменение медианной цены в % относительно предыдущего периода
    categorySalesКоличество продаж товаров категории за период
    categorySalesChangePercentИзменение продаж категории в % относительно предыдущего периода
    categoryTotalRevenueОбщий доход от продаж категории (в тенге)
    categoryRevenueChangePercentИзменение дохода категории в % относительно предыдущего периода
    totalMerchantКоличество продавцов в категории
    totalMerchantChangePercentИзменение числа продавцов в % относительно предыдущего периода
    merchantWithSalesКоличество продавцов с продажами
    merchantWithSalesChangePercentИзменение числа продавцов с продажами в % относительно предыдущего периода
    totalBrandsОбщее количество брендов в категории
    brandsChangePercentИзменение количества брендов в % относительно предыдущего периода
    brandsWithSalesКоличество брендов с продажами
    percentBrandsWithSalesПроцент брендов с продажами
    Массив (categorySalesPerDay) Описание
    dateДата продаж (YYYY-MM-DD)
    categoryTotalRevenueДоход категории за день (в тенге)
    categorySalesКоличество продаж за день
    categoryProductsCountКоличество товаров, участвующих в продажах за день
    medianPriceМедианная цена товаров за день (в тенге)
    Массив (segmentSales) Описание
    priceFromНижняя граница ценового сегмента (в тенге)
    priceToВерхняя граница ценового сегмента (в тенге)
    revenueДоход за период для сегмента (в тенге)
    revenueChangePercentИзменение дохода сегмента в % относительно предыдущего периода
    totalSalesКоличество продаж в сегменте
    salesChangePercentИзменение количества продаж в % относительно предыдущего периода
    merchantКоличество продавцов в сегменте
    merchantChangePercentИзменение числа продавцов в % относительно предыдущего периода
    totalUniqueProductsInSegmentКоличество уникальных товаров в сегменте
    totalUniqueProductsInSegmentChangePercentИзменение количества уникальных товаров в % относительно предыдущего периода
    totalProductsWithSaleКоличество товаров с продажами в сегменте
    totalProductsWithSaleChangePercentИзменение количества товаров с продажами в % относительно предыдущего периода
    totalUniqueBrandsInSegmentКоличество уникальных брендов в сегменте
    totalUniqueBrandsInSegmentChangePercentИзменение количества уникальных брендов в % относительно предыдущего периода
    totalUniqueBrandsWithSaleКоличество уникальных брендов с продажами в сегменте
    totalUniqueBrandsWithSaleChangePercentИзменение количества брендов с продажами в % относительно предыдущего периода

    Пример успешного ответа для products

    {
      "data": [
        {
          "imagesUrl": "https://resources.cdn-kaspi.kz/img/m/p/hcb/hf3/85539665117214.jpg?format=preview-small",
          "sku": "117752201",
          "categoryName": "Детские товары",
          "categoryName2": "Для малыша и мамы",
          "categoryName3": "Уход и гигиена малыша",
          "categoryName4": "Влажные салфетки для малышей",
          "productName": "Детские влажные салфетки JAZZ Mini Wet Wipes 64 шт",
          "brandName": "JAZZ",
          "sale": "9453",
          "salesPercent": -9.11,
          "medianPrice": "390",
          "medianPricePercent": 0,
          "amountSales": "3512830",
          "amountSalesPercent": -10.17,
          "totalMerchant": "38",
          "totalMerchantPercent": 0,
          "rating": 4.99,
          "reviews": "1361",
          "TotalReviewsPercent": -9.15,
          "strongCompetitor": "Да",
          "link": "https://kaspi.kz/shop/p/detskie-vlazhnye-salfetki-jazz-mini-wet-wipes-64-sht-117752201/?c=750000000"
        },
        {...}
      ]
    }
    Поле Описание
    imagesUrlURL изображения товара
    skuУникальный идентификатор товара (артикул Kaspi)
    categoryName1–4Название категории и подкатегорий, к которым принадлежит товар
    productNameПолное название товара
    brandNameНазвание бренда
    saleКоличество продаж за выбранный период
    salesPercentИзменение количества продаж в % относительно предыдущего периода
    medianPriceМедианная цена товара (в тенге)
    medianPricePercentИзменение медианной цены в % относительно предыдущего периода
    amountSalesОбщая сумма продаж за период (в тенге)
    amountSalesPercentИзменение общей суммы продаж в % относительно предыдущего периода
    totalMerchantКоличество продавцов, торгующих этим товаром
    totalMerchantPercentИзменение числа продавцов в % относительно предыдущего периода
    ratingСредний рейтинг товара на Kaspi.kz
    reviewsКоличество отзывов
    reviewsPercentИзменение количества отзывов в % относительно предыдущего периода
    strongCompetitorПризнак наличия сильного конкурента (Да / Нет)
    linkСсылка на карточку товара в Kaspi.kz

    Пример успешного ответа для products с filterName

    {
      "data": [
        {
          "imagesUrl": "https://resources.cdn-kaspi.kz/img/m/p/pa4/p7e/18089592.jpg?format=preview-small",
          "sku": "6301566",
          "categoryName": "Бытовая техника",
          "categoryName2": "Мелкая техника для кухни",
          "categoryName3": "",
          "categoryName4": "Электрочайники и термопоты",
          "productName": "Электрочайник Smeg KLF03CREU бежевый",
          "brandName": "Smeg",
          "sale": "28",
          "salesPercent": -50,
          "medianPrice": "85997",
          "medianPricePercent": 0,
          "amountSales": "2421464",
          "amountSalesPercent": -50.97,
          "minPositins": "98",
          "maxPositins": "124",
          "totalMerchant": "22",
          "totalMerchantPercent": 0,
          "rating": 4.94,
          "totalReviews": "340",
          "periodReviews": "2",
          "TotalReviewsPercent": -71.43,
          "strongCompetitorCount": "0",
          "strongCompetitor": "Да",
          "strongCompetitorNames": "Sulpak, Alser, Top-Sale",
          "competitionLevel": "Средний",
          "daysSinceCreation": "2676",
          "link": "https://kaspi.kz/shop/p/elektrochainik-smeg-klf03creu-bezhevyi-6301566/?c=750000000",
          "commission": "12%",
          "salesPermit": "Нет",
          "optPrice": "0",
          "profit": "85997",
          "margin": 100,
          "salesPerDay": [
            {
              "date": "2025-08-10",
              "sale": "11",
              "minPrice": "85997",
              "amountSales": "945967",
              "reviews": "0",
              "positions": "119"
            },
            {...}
          ],
          "merchantsData": [
            {
              "merchantId": "SmegAjk",
              "merchantName": "SMEG AJK",
              "price": "111900",
              "revenue": "2461800",
              "salesQuantity": "22",
              "reviews": "90",
              "merchantRating": 5
            },
            {...}
          ]
        },
        {...}
      ]
    }
    Поле Описание
    imagesUrlURL изображения товара
    skuУникальный идентификатор товара (артикул Kaspi)
    categoryName1–4Название категории и подкатегорий
    productNameПолное название товара
    brandNameНазвание бренда
    saleКоличество продаж за период
    salesPercentИзменение количества продаж в % относительно предыдущего периода
    medianPriceМедианная цена товара (в тенге)
    medianPricePercentИзменение медианной цены в % относительно предыдущего периода
    amountSalesОбщая сумма продаж (в тенге)
    amountSalesPercentИзменение общей суммы продаж в % относительно предыдущего периода
    minPositins / maxPositinsМинимальная и максимальная позиция товара в рейтинге продаж
    totalMerchant / totalMerchantPercentКоличество продавцов и изменение в % относительно предыдущего периода
    ratingСредний рейтинг товара
    totalReviews / periodReviews / TotalReviewsPercentОбщее количество отзывов, за период и изменение в % относительно предыдущего периода
    strongCompetitor / strongCompetitorCount / strongCompetitorNamesПризнак наличия сильных конкурентов, их количество и названия
    competitionLevelУровень конкуренции (Низкий / Средний / Высокий)
    daysSinceCreationКоличество дней с момента создания товара
    linkСсылка на товар на Kaspi.kz
    commissionКомиссия (%)
    salesPermitРазрешение на продажу (Да/Нет)
    optPriceОптовая цена
    profitПрибыль с товара
    marginМаржинальность (%)
    Массив (salesPerDay) Описание
    dateДата продаж (YYYY-MM-DD)
    saleКоличество продаж за день
    minPriceМинимальная цена товара за день
    amountSalesОбщая сумма продаж за день
    reviewsКоличество отзывов за день
    positionsПозиция товара в категории
    Массив (merchantsData) Описание
    merchantIdУникальный идентификатор продавца
    merchantNameНазвание продавца
    priceЦена товара у продавца
    revenueДоход от продаж у продавца
    salesQuantityКоличество продаж у продавца
    reviewsКоличество отзывов на продавца
    merchantRatingРейтинг продавца

    Пример успешного ответа для analog с filterName

    {
      "data": [
        {
          "sku": "136420155",
          "productName": "Samsung Galaxy A56 5G 8 ГБ/256 ГБ серый",
          "medianPrice": "205900",
          "sale": "398",
          "amountSales": "67409918",
          "link": "https://kaspi.kz/shop/p/samsung-galaxy-a56-5g-8-gb-256-gb-seryi-136420155/?c=750000000",
          "imagesUrl": "https://resources.cdn-kaspi.kz/img/m/p/pb5/pa3/30496239.png?format=preview-small"
        },
        {
          "sku": "136436593",
          "productName": "Samsung Galaxy A26 5G 8 ГБ/256 ГБ черный",
          "medianPrice": "139081",
          "sale": "358",
          "amountSales": "29580074",
          "link": "https://kaspi.kz/shop/p/samsung-galaxy-a26-5g-8-gb-256-gb-chernyi-136436593/?c=750000000",
          "imagesUrl": "https://resources.cdn-kaspi.kz/img/m/p/p60/p06/30558681.png?format=preview-small"
        },
        {...}
      ]
    }
    Поле Описание
    skuУникальный идентификатор товара (артикул Kaspi)
    productNameПолное название аналогичного товара
    medianPriceМедианная цена товара (в тенге)
    saleКоличество продаж за период
    amountSalesОбщая сумма продаж (в тенге)
    linkСсылка на карточку товара в Kaspi.kz
    imagesUrlURL изображения аналогичного товара

    Пример успешного ответа для brand

    {
      "data": [
        {
          "brandName": "Без бренда",
          "brandProductsCount": 544279,
          "brandRating": 1.37,
          "medianPrice": 4980,
          "medianPriceChangePercent": 0.2,
          "brandSales": "892124",
          "brandSalesChangePercent": -43.05,
          "totalRevenue": "6336288957",
          "totalRevenueChangePercent": -44.84,
          "brandMarketPartPercent": 9.24,
          "uniqProductsWithSales": "108217",
          "uniqProductsWithSalesPercent": 19.88
        },
        {...}
      ]
    }
    Поле Описание
    brandNameНазвание бренда
    brandProductsCountКоличество товаров данного бренда
    brandRatingСредний рейтинг бренда
    medianPriceМедианная цена товаров бренда (в тенге)
    medianPriceChangePercentИзменение медианной цены бренда в % относительно предыдущего периода
    brandSalesКоличество продаж товаров бренда за период
    brandSalesChangePercentИзменение количества продаж бренда в % относительно предыдущего периода
    totalRevenueОбщий доход от продаж товаров бренда (в тенге)
    totalRevenueChangePercentИзменение общего дохода бренда в % относительно предыдущего периода
    brandMarketPartPercentДоля рынка бренда (%)
    uniqProductsWithSalesКоличество уникальных товаров бренда с продажами
    uniqProductsWithSalesPercentПроцент уникальных товаров с продажами от общего числа товаров бренда в % относительно предыдущего периода

    Пример успешного ответа для brand с filterName

    {
      "data": [
        {
          "brandName": "Apple",
          "brandProductsCount": 887,
          "brandRating": 3.83,
          "medianPrice": 577196,
          "medianPriceChangePercent": 0.38,
          "brandSales": "24781",
          "brandSalesChangePercent": -45.26,
          "totalRevenue": "8583321517",
          "totalRevenueChangePercent": -45.71,
          "brandMarketPartChangePercent": 100,
          "uniqProductsWithSales": "1265",
          "uniqProductsWithSalesChangePercent": 142.62,
          "salesPerDay": [
            {
              "date": "2025-08-01",
              "totalRevenue": "1537045804",
              "sales": "3993",
              "price": "565990"
            },
            {...}
          ],
          "segmentSales": [
            {
              "price_from": "0",
              "price_to": "499",
              "revenue": "209580",
              "revenueChangePercent": -43.09,
              "totalSales": "420",
              "salesChangePercent": -43.09,
              "merchant": "0",
              "merchantChangePercent": 0,
              "totalProducts": "52",
              "productsChangePercent": -42.22
            },
            {...}
          ],
          "fullSegmentSales": [
            {
              "price_from": "980",
              "price_to": "984",
              "revenue": "5880",
              "revenueChangePercent": 0,
              "totalSales": "6",
              "salesChangePercent": 0,
              "merchant": "3",
              "merchantChangePercent": 0,
              "totalProducts": "1",
              "productsChangePercent": 0
            },
            {...}
          ]
        }
      ]
    }
    Поле Описание
    brandNameНазвание бренда
    brandProductsCountКоличество товаров бренда
    brandRatingСредний рейтинг бренда
    medianPriceМедианная цена товаров бренда (в тенге)
    medianPriceChangePercentИзменение медианной цены в % относительно предыдущего периода
    brandSalesКоличество продаж товаров бренда
    brandSalesChangePercentИзменение количества продаж в % относительно предыдущего периода
    totalRevenueОбщий доход бренда (в тенге)
    totalRevenueChangePercentИзменение дохода бренда в % относительно предыдущего периода
    brandMarketPartChangePercentИзменение доли рынка бренда в % относительно предыдущего периода
    uniqProductsWithSalesКоличество уникальных товаров с продажами
    uniqProductsWithSalesChangePercentИзменение количества уникальных товаров с продажами в % относительно предыдущего периода
    Массив (salesPerDay) Описание
    dateДата продаж (YYYY-MM-DD)
    totalRevenueОбщий доход бренда за день (в тенге)
    salesКоличество продаж за день
    priceСредняя цена продаж за день
    Массив (segmentSales) Описание
    price_from / price_toНижняя и верхняя граница ценового сегмента (в тенге)
    revenueДоход в сегменте (в тенге)
    revenueChangePercentИзменение дохода в % относительно предыдущего периода
    totalSalesКоличество продаж в сегменте
    salesChangePercentИзменение продаж в % относительно предыдущего периода
    merchant / merchantChangePercentКоличество продавцов и изменение в % относительно предыдущего периода
    totalProducts / productsChangePercentКоличество товаров в сегменте и изменение в % относительно предыдущего периода
    Массив (fullSegmentSales) Описание
    price_from / price_toНижняя и верхняя граница ценового сегмента (в тенге)
    revenueДоход в сегменте (в тенге)
    revenueChangePercentИзменение дохода в % относительно предыдущего периода
    totalSalesКоличество продаж в сегменте
    salesChangePercentИзменение продаж в % относительно предыдущего периода
    merchant / merchantChangePercentКоличество продавцов и изменение в % относительно предыдущего периода
    totalProducts / productsChangePercentКоличество товаров в сегменте и изменение в % относительно предыдущего периода

    Пример успешного ответа для merchant

    {
      "data": [
        {
          "merchantId": "Sulpak",
          "merchantName": "Sulpak",
          "categoryProductsCount": "12579",
          "uniqSalesMerchant": "2137",
          "itemWithSalesProcent": 16.99,
          "salesMerchant": "16497",
          "uniqueBrands": "556",
          "medianPrice": "39990",
          "totalRevenue": "661772636",
          "merchantRating": 4,
          "merchantReviewsQuantity": "31624"
        },
        {...}
      ]
    }
    Поле Описание
    merchantId Уникальный идентификатор продавца (короткое имя)
    merchantName Полное название продавца (бренда/магазина)
    categoryProductsCount Количество товаров, представленных продавцом в категории
    uniqSalesMerchant Количество уникальных товаров продавца, которые имели продажи за период
    itemWithSalesProcent Доля товаров с продажами (%)
    salesMerchant Количество продаж у данного продавца за выбранный период
    uniqueBrands Количество уникальных брендов, продаваемых данным продавцом
    medianPrice Медианная цена товаров продавца (в тенге)
    totalRevenue Общая сумма выручки продавца за период (в тенге)
    merchantRating Средний рейтинг магазина на платформе Kaspi.kz
    merchantReviewsQuantity Общее количество отзывов, оставленных покупателями о магазине