По категориям

Получение данных по товарным категориям

Товары

POST oz/get/category

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

Параметр Тип Обязательный Описание Значение по умолчанию
path Строка Да Категория, например Строительство и ремонт/Инструменты Нет
d1 Дата в формате YYYY-MM-DD Нет Дата начала периода Для тарифных планов "Базовый", "Расширенный" равна дате начала периода согласно условиям тарифа без возможности изменения.
d2 Дата в формате YYYY-MM-DD Нет Дата окончания периода Для тарифных планов "Базовый", "Расширенный" равна дате окончания периода согласно условиям тарифа без возможности изменения.

Тело запроса:


{
   // Номер строки начала получения данных
   startRow: 1;
   // Номер строки конца получения данных
   endRow: 100;
   // Не более 5000 записей на один вызов запроса

   // Фильтры
   filterModel: {};
   // Сортировка
   sortModel: [];
}

Тело ответа:


{
   // Номер строки начала получения данных
   startRow: 0;
   // Номер строки конца получения данных
   endRow: 100;
   // Фильтры, которые были установлены при запросе
   filterModel: {};
   // Сортировка, которая была установлена при запросе
   sortModel: [];
   // Кол-во строк в результирующем запросе без учета пагинации
   total: 42,
   // Массив данных
   data: [...{...}]
}

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

curl --location --request POST 'https://mpstats.io/api/oz/get/category?d1=2020-07-13&d2=2020-08-11&path=%D0%A1%D1%82%D1%80%D0%BE%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D1%81%D1%82%D0%B2%D0%BE%20%D0%B8%20%D1%80%D0%B5%D0%BC%D0%BE%D0%BD%D1%82/%D0%98%D0%BD%D1%81%D1%82%D1%80%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D1%8B' \
--header 'X-Mpstats-TOKEN: 5f344c39f1bed8.86604437950c9cc0893508080fc8cef256d5a983' \
--header 'Content-Type: application/json' \
--data-raw '{"startRow":0,"endRow":100,"filterModel":{"delivery_scheme":{"values":["2","3"],"filterType":"set"}, "id":{"filterType":"number","type":"equals","filter":150289066,"filterTo":null}},"sortModel":[{"colId":"revenue","sort":"desc"}]}'

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

    
{
    "data": [
        {
            "id": 150289066,
            "name": "Пылесос для сухой и влажной уборки Karcher WD 3 P Premium",
            "brand": "Karcher",
            "category": "Строительство и ремонт/Инструменты/Силовая техника и оборудование/Промышленные и строительные пылесосы/Karcher",
            "seller": "OZON",
            "delivery_scheme": 2,
            "balance": 230,
            "comments": 93,
            "sales": 548,
            "final_price": 8490,
            "final_price_max": 8490,
            "final_price_min": 8490,
            "final_price_average": 8490,
            "revenue": 4652520,
            "revenue_potential": 4652520,
            "days_in_stock": 30,
            "days_with_sales": 28,
            "average_if_in_stock": 18.266666666667,
            "thumb": "https://cdn1.ozone.ru/s3/multimedia-2/d100/6006503870.jpg",
            "graph": [
                ...,
                10,
                8,
                15
            ]
        }
    ],
    "total": 1,
    "startRow": 0,
    "endRow": 100,
    "filterModel": {
        "delivery_scheme": {
            "values": [
                "2",
                "3"
            ],
            "filterType": "set"
        },
        "id": {
            "filterType": "number",
            "type": "equals",
            "filter": 150289066,
            "filterTo": null
        }
    },
    "sortModel": [
        {
            "colId": "revenue",
            "sort": "desc"
        }
    ]
}
    

Описание полей:

Имя поля Тип Описание
thumb text Изображение товара
id number Идентификатор товарной позиции
name text Название товара
category text Категория товара
brand text Название бренда
seller text Название продавца
delivery_scheme number | 0:FBO, 1:FBS, 2:Retail, 3:Crossborder Схема работы
balance number Последний зафиксированный остаток на складе
comments number Количество комментариев
final_price number Последняя зафиксированная цена
final_price_min number Минимальная цена за период
final_price_max number Максимальная цена за период
final_price_average number Средняя цена за период (выручка / число продаж)
revenue_potential number Потенциал выручки (выручка / число дней в наличии) * дней в отчете
lost_profit number Упущенная выручка (Потенциал - Выручка)
days_in_stock number Количество дней, когда товар был в наличии на конец дня
days_with_sales number Количество дней, когда были продажи
average_if_in_stock number Среднее число продаж, при наличии товара на конец дня
sales number Количество проданных единиц товара за период
revenue number Выручка за период
graph array<number> График продаж

Подкатегории

GET oz/get/category/subcategories

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

Параметр Тип Обязательный Описание Значение по умолчанию
path Строка Да Категория, например Строительство и ремонт/Инструменты Нет
d1 Дата в формате YYYY-MM-DD Нет Дата начала периода Для тарифных планов "Базовый", "Расширенный" равна дате начала периода согласно условиям тарифа без возможности изменения.
d2 Дата в формате YYYY-MM-DD Нет Дата окончания периода Для тарифных планов "Базовый", "Расширенный" равна дате окончания периода согласно условиям тарифа без возможности изменения.

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

curl --location --request GET 'https://mpstats.io/api/oz/get/category/subcategories?d1=2020-07-13&d2=2020-08-11&path=%D0%A1%D1%82%D1%80%D0%BE%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D1%81%D1%82%D0%B2%D0%BE%20%D0%B8%20%D1%80%D0%B5%D0%BC%D0%BE%D0%BD%D1%82/%D0%98%D0%BD%D1%81%D1%82%D1%80%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D1%8B' \
--header 'X-Mpstats-TOKEN: 5f344c39f1bed8.86604437950c9cc0893508080fc8cef256d5a983' \
--header 'Content-Type: application/json'

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

    
[
    ...,

    "Ручной инструмент": {
        "crossborder": {
            "items": 1248,
            "sales": 2387,
            "revenue": 7223102
        },
        "retail": {
            "items": 3481,
            "sales": 19332,
            "revenue": 37525928
        },
        "fbo": {
            "items": 6818,
            "sales": 38981,
            "revenue": 28409486
        },
        "fbs": {
            "items": 17791,
            "sales": 852884,
            "revenue": 1614595140
        },
        "parent_category": "Строительство и ремонт/Инструменты"
    },

    ...,

]
    

Описание полей:

Имя поля Тип Описание
sales number Количество проданных единиц товара за период
revenue number Выручка за период
items number Наименований товаров

Продавцы

GET oz/get/category/sellers

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

Параметр Тип Обязательный Описание Значение по умолчанию
path Строка Да Категория, например Строительство и ремонт/Инструменты Нет
d1 Дата в формате YYYY-MM-DD Нет Дата начала периода Для тарифных планов "Базовый", "Расширенный" равна дате начала периода согласно условиям тарифа без возможности изменения.
d2 Дата в формате YYYY-MM-DD Нет Дата окончания периода Для тарифных планов "Базовый", "Расширенный" равна дате окончания периода согласно условиям тарифа без возможности изменения.

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

curl --location --request GET 'https://mpstats.io/api/oz/get/category/sellers?d1=2020-07-13&d2=2020-08-11&path=%D0%A1%D1%82%D1%80%D0%BE%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D1%81%D1%82%D0%B2%D0%BE%20%D0%B8%20%D1%80%D0%B5%D0%BC%D0%BE%D0%BD%D1%82/%D0%98%D0%BD%D1%81%D1%82%D1%80%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D1%8B' \
--header 'X-Mpstats-TOKEN: 5f344c39f1bed8.86604437950c9cc0893508080fc8cef256d5a983' \
--header 'Content-Type: application/json'

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

    
[
    ...,

    "MACTAK": {
        "fbo": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        },
        "fbs": {
            "items": 2118,
            "sales": 266576,
            "revenue": 541783370
        },
        "retail": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        },
        "crossborder": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        }
    },

    ...,

]
    

Описание полей:

Имя поля Тип Описание
sales number Количество проданных единиц товара за период
revenue number Выручка за период
items number Наименований товаров

Бренды

GET oz/get/category/brands

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

Параметр Тип Обязательный Описание Значение по умолчанию
path Строка Да Категория, например Строительство и ремонт/Инструменты Нет
d1 Дата в формате YYYY-MM-DD Нет Дата начала периода Для тарифных планов "Базовый", "Расширенный" равна дате начала периода согласно условиям тарифа без возможности изменения.
d2 Дата в формате YYYY-MM-DD Нет Дата окончания периода Для тарифных планов "Базовый", "Расширенный" равна дате окончания периода согласно условиям тарифа без возможности изменения.

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

curl --location --request GET 'https://mpstats.io/api/oz/get/category/brands?d1=2020-07-13&d2=2020-08-11&path=%D0%A1%D1%82%D1%80%D0%BE%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D1%81%D1%82%D0%B2%D0%BE%20%D0%B8%20%D1%80%D0%B5%D0%BC%D0%BE%D0%BD%D1%82/%D0%98%D0%BD%D1%81%D1%82%D1%80%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D1%8B' \
--header 'X-Mpstats-TOKEN: 5f344c39f1bed8.86604437950c9cc0893508080fc8cef256d5a983' \
--header 'Content-Type: application/json'

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

    
[
    ...,

    "Ресанта": {
        "retail": {
            "items": 71,
            "sales": 902,
            "revenue": 3090495
        },
        "fbo": {
            "items": 147,
            "sales": 3,
            "revenue": 24370
        },
        "fbs": {
            "items": 982,
            "sales": 51021,
            "revenue": 279245897
        },
        "crossborder": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        }
    },

    ...,

]
    

Описание полей:

Имя поля Тип Описание
sales number Количество проданных единиц товара за период
revenue number Выручка за период
items number Наименований товаров

По дням

GET oz/get/category/by_date

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

Параметр Тип Обязательный Описание Значение по умолчанию
path Строка Да Категория, например Строительство и ремонт/Инструменты Нет
d1 Дата в формате YYYY-MM-DD Нет Дата начала периода Для тарифных планов "Базовый", "Расширенный" равна дате начала периода согласно условиям тарифа без возможности изменения.
d2 Дата в формате YYYY-MM-DD Нет Дата окончания периода Для тарифных планов "Базовый", "Расширенный" равна дате окончания периода согласно условиям тарифа без возможности изменения.

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

curl --location --request GET 'https://mpstats.io/api/oz/get/category/by_date?d1=2020-07-13&d2=2020-08-11&path=%D0%A1%D1%82%D1%80%D0%BE%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D1%81%D1%82%D0%B2%D0%BE%20%D0%B8%20%D1%80%D0%B5%D0%BC%D0%BE%D0%BD%D1%82/%D0%98%D0%BD%D1%81%D1%82%D1%80%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D1%8B' \
--header 'X-Mpstats-TOKEN: 5f344c39f1bed8.86604437950c9cc0893508080fc8cef256d5a983' \
--header 'Content-Type: application/json'

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

    
[
    ...,

    "2020-08-11": {
        "data": 1597093200,
        "fbs": {
            "items": 28944,
            "sales": 16670,
            "revenue": 40448313
        },
        "fbo": {
            "items": 6982,
            "sales": 2180,
            "revenue": 2329119
        },
        "retail": {
            "items": 5602,
            "sales": 1185,
            "revenue": 3078088
        },
        "crossborder": {
            "items": 1736,
            "sales": 9,
            "revenue": 21335
        }
    },

    ...,

]
    

Описание полей:

Имя поля Тип Описание
sales number Количество проданных единиц товара за период
revenue number Выручка за период
items number Наименований товаров

По продавцам

Получение данных по продавцам

Товары

POST oz/get/seller

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

Параметр Тип Обязательный Описание Значение по умолчанию
path Строка Да Название продавца, например ZITREK Нет
d1 Дата в формате YYYY-MM-DD Нет Дата начала периода Для тарифных планов "Базовый", "Расширенный" равна дате начала периода согласно условиям тарифа без возможности изменения.
d2 Дата в формате YYYY-MM-DD Нет Дата окончания периода Для тарифных планов "Базовый", "Расширенный" равна дате окончания периода согласно условиям тарифа без возможности изменения.

Тело запроса:


{
   // Номер строки начала получения данных
   startRow: 1;
   // Номер строки конца получения данных
   endRow: 100;
   // Не более 5000 записей на один вызов запроса

   // Фильтры
   filterModel: {};
   // Сортировка
   sortModel: [];
}

Тело ответа:


{
   // Номер строки начала получения данных
   startRow: 0;
   // Номер строки конца получения данных
   endRow: 100;
   // Фильтры, которые были установлены при запросе
   filterModel: {};
   // Сортировка, которая была установлена при запросе
   sortModel: [];
   // Кол-во строк в результирующем запросе без учета пагинации
   total: 42,
   // Массив данных
   data: [...{...}]
}

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

curl --location --request POST 'https://mpstats.io/api/oz/get/seller?d1=2020-07-13&d2=2020-08-11&path=ZITREK' \
--header 'X-Mpstats-TOKEN: 5f344c39f1bed8.86604437950c9cc0893508080fc8cef256d5a983' \
--header 'Content-Type: application/json' \
--data-raw '{"startRow":0,"endRow":100,"filterModel":{"delivery_scheme":{"values":["0"],"filterType":"set"}, "id":{"filterType":"number","type":"equals","filter":172485618,"filterTo":null}},"sortModel":[{"colId":"revenue","sort":"desc"}]}'

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

    
{"data":[{"id":172485618,"name":"Уровень лазерный самовыравнивающийся DEKO DKLL12PВ1, 3\/360; зеленый луч (12 линий)","brand":"DEKO","category":"Строительство и ремонт\/Инструменты\/Измерительные инструменты\/Измерение длин и углов наклона\/Строительные уровни, нивелиры и отвесы\/DEKO","seller":"ZITREK","delivery_scheme":0,"balance":9,"comments":61,"sales":306,"final_price":5448,"revenue":1667088,"thumb":"https:\/\/cdn1.ozone.ru\/s3\/multimedia-o\/d100\/6013297668.jpg","graph":[0,11,12,13,16,7,9,6,0,10,16,10,0,8,12,0,14,11,14,21,14,9,8,14,7,10,14,5,5,17,13]}],"total":1,"startRow":0,"endRow":100,"filterModel":{"delivery_scheme":{"values":["0"],"filterType":"set"},"id":{"filterType":"number","type":"equals","filter":172485618,"filterTo":null}},"sortModel":[{"colId":"revenue","sort":"desc"}]}
    

Описание полей:

Имя поля Тип Описание
thumb text Изображение товара
id number Идентификатор товарной позиции
name text Название товара
category text Категория товара
brand text Название бренда
seller text Название продавца
delivery_scheme number | 0:FBO, 1:FBS, 2:Retail, 3:Crossborder Схема работы
balance number Последний зафиксированный остаток на складе
comments number Количество комментариев
final_price number Последняя зафиксированная цена
final_price_min number Минимальная цена за период
final_price_max number Максимальная цена за период
final_price_average number Средняя цена за период (выручка / число продаж)
revenue_potential number Потенциал выручки (выручка / число дней в наличии) * дней в отчете
lost_profit number Упущенная выручка (Потенциал - Выручка)
days_in_stock number Количество дней, когда товар был в наличии на конец дня
days_with_sales number Количество дней, когда были продажи
average_if_in_stock number Среднее число продаж, при наличии товара на конец дня
sales number Количество проданных единиц товара за период
revenue number Выручка за период
graph array<number> График продаж

Категории

GET oz/get/seller/categories

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

Параметр Тип Обязательный Описание Значение по умолчанию
path Строка Да Название продавца, например ZITREK Нет
d1 Дата в формате YYYY-MM-DD Нет Дата начала периода Для тарифных планов "Базовый", "Расширенный" равна дате начала периода согласно условиям тарифа без возможности изменения.
d2 Дата в формате YYYY-MM-DD Нет Дата окончания периода Для тарифных планов "Базовый", "Расширенный" равна дате окончания периода согласно условиям тарифа без возможности изменения.

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

curl --location --request GET 'https://mpstats.io/api/oz/get/seller/categories?d1=2020-07-13&d2=2020-08-11&path=ZITREK' \
--header 'X-Mpstats-TOKEN: 5f344c39f1bed8.86604437950c9cc0893508080fc8cef256d5a983' \
--header 'Content-Type: application/json'

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

    
[
    ...,

    "Строительство и ремонт/Инструменты/Электроинструменты/Шуруповерты/DEKO": {
        "fbo": {
            "items": 25,
            "sales": 2377,
            "revenue": 6517496
        },
        "average_comments": 193.65107212476,
        "rating": 4.7116179337232,
        "fbs": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        },
        "retail": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        },
        "crossborder": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        }
    },

    ...,

]
    

Описание полей:

Имя поля Тип Описание
sales number Количество проданных единиц товара за период
revenue number Выручка за период
items number Наименований товаров
average_comments number Среднее количество комментариев к товарам
rating number Средний рейтинг товаров для тех товаров, у которых есть рейтинг

Бренды

GET oz/get/seller/brands

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

Параметр Тип Обязательный Описание Значение по умолчанию
path Строка Да Название продавца, например ZITREK Нет
d1 Дата в формате YYYY-MM-DD Нет Дата начала периода Для тарифных планов "Базовый", "Расширенный" равна дате начала периода согласно условиям тарифа без возможности изменения.
d2 Дата в формате YYYY-MM-DD Нет Дата окончания периода Для тарифных планов "Базовый", "Расширенный" равна дате окончания периода согласно условиям тарифа без возможности изменения.

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

curl --location --request GET 'https://mpstats.io/api/oz/get/seller/brands?d1=2020-07-13&d2=2020-08-11&path=ZITREK' \
--header 'X-Mpstats-TOKEN: 5f344c39f1bed8.86604437950c9cc0893508080fc8cef256d5a983' \
--header 'Content-Type: application/json'

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

    
[
    ...,

    "DEKO": {
        "fbo": {
            "items": 247,
            "sales": 15230,
            "revenue": 25272430
        },
        "average_comments": 74.334729006746,
        "rating": 4.580262851826,
        "fbs": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        },
        "retail": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        },
        "crossborder": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        }
    },

    ...,

]
    

Описание полей:

Имя поля Тип Описание
sales number Количество проданных единиц товара за период
revenue number Выручка за период
items number Наименований товаров
average_comments number Среднее количество комментариев к товарам
rating number Средний рейтинг товаров для тех товаров, у которых есть рейтинг

По дням

GET oz/get/seller/by_date

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

Параметр Тип Обязательный Описание Значение по умолчанию
path Строка Да Название продавца, например ZITREK Нет
d1 Дата в формате YYYY-MM-DD Нет Дата начала периода Для тарифных планов "Базовый", "Расширенный" равна дате начала периода согласно условиям тарифа без возможности изменения.
d2 Дата в формате YYYY-MM-DD Нет Дата окончания периода Для тарифных планов "Базовый", "Расширенный" равна дате окончания периода согласно условиям тарифа без возможности изменения.

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

curl --location --request GET 'https://mpstats.io/api/oz/get/seller/by_date?d1=2020-07-13&d2=2020-08-11&path=ZITREK' \
--header 'X-Mpstats-TOKEN: 5f344c39f1bed8.86604437950c9cc0893508080fc8cef256d5a983' \
--header 'Content-Type: application/json'

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

    
[
    ...,

    "2020-08-11": {
        "fbo": {
            "items": 264,
            "sales": 866,
            "revenue": 1210367
        },
        "average_comments": 60.678217821782,
        "rating": 4.5513861386139,
        "data": 1597093200,
        "fbs": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        },
        "retail": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        },
        "crossborder": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        }
    },

    ...,

]
    

Описание полей:

Имя поля Тип Описание
sales number Количество проданных единиц товара за период
revenue number Выручка за период
items number Наименований товаров
average_comments number Среднее количество комментариев к товарам
rating number Средний рейтинг товаров для тех товаров, у которых есть рейтинг

По брендам

Получение данных по брендам

Товары

POST oz/get/brand

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

Параметр Тип Обязательный Описание Значение по умолчанию
path Строка Да Название бренда, например DEKO Нет
d1 Дата в формате YYYY-MM-DD Нет Дата начала периода Для тарифных планов "Базовый", "Расширенный" равна дате начала периода согласно условиям тарифа без возможности изменения.
d2 Дата в формате YYYY-MM-DD Нет Дата окончания периода Для тарифных планов "Базовый", "Расширенный" равна дате окончания периода согласно условиям тарифа без возможности изменения.

Тело запроса:


{
   // Номер строки начала получения данных
   startRow: 1;
   // Номер строки конца получения данных
   endRow: 100;
   // Не более 5000 записей на один вызов запроса

   // Фильтры
   filterModel: {};
   // Сортировка
   sortModel: [];
}

Тело ответа:


{
   // Номер строки начала получения данных
   startRow: 0;
   // Номер строки конца получения данных
   endRow: 100;
   // Фильтры, которые были установлены при запросе
   filterModel: {};
   // Сортировка, которая была установлена при запросе
   sortModel: [];
   // Кол-во строк в результирующем запросе без учета пагинации
   total: 42,
   // Массив данных
   data: [...{...}]
}

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

curl --location --request POST 'https://mpstats.io/api/oz/get/brand?d1=2020-07-13&d2=2020-08-11&path=DEKO' \
--header 'X-Mpstats-TOKEN: 5f344c39f1bed8.86604437950c9cc0893508080fc8cef256d5a983' \
--header 'Content-Type: application/json' \
--data-raw '{"startRow":0,"endRow":100,"filterModel":{"delivery_scheme":{"values":["0", "1"],"filterType":"set"}, "id":{"filterType":"number","type":"equals","filter":172485618,"filterTo":null}},"sortModel":[{"colId":"revenue","sort":"desc"}]}'

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

    
{"data":[{"id":172485618,"name":"Уровень лазерный самовыравнивающийся DEKO DKLL12PВ1, 3\/360; зеленый луч (12 линий)","brand":"DEKO","category":"Строительство и ремонт\/Инструменты\/Измерительные инструменты\/Измерение длин и углов наклона\/Строительные уровни, нивелиры и отвесы\/DEKO","seller":"ZITREK","delivery_scheme":0,"balance":9,"comments":61,"sales":306,"final_price":5448,"revenue":1667088,"thumb":"https:\/\/cdn1.ozone.ru\/s3\/multimedia-o\/d100\/6013297668.jpg","graph":[0,11,12,13,16,7,9,6,0,10,16,10,0,8,12,0,14,11,14,21,14,9,8,14,7,10,14,5,5,17,13]}],"total":1,"startRow":0,"endRow":100,"filterModel":{"delivery_scheme":{"values":["0","1"],"filterType":"set"},"id":{"filterType":"number","type":"equals","filter":172485618,"filterTo":null}},"sortModel":[{"colId":"revenue","sort":"desc"}]}
    

Описание полей:

Имя поля Тип Описание
thumb text Изображение товара
id number Идентификатор товарной позиции
name text Название товара
category text Категория товара
brand text Название бренда
seller text Название продавца
delivery_scheme number | 0:FBO, 1:FBS, 2:Retail, 3:Crossborder Схема работы
balance number Последний зафиксированный остаток на складе
comments number Количество комментариев
final_price number Последняя зафиксированная цена
final_price_min number Минимальная цена за период
final_price_max number Максимальная цена за период
final_price_average number Средняя цена за период (выручка / число продаж)
revenue_potential number Потенциал выручки (выручка / число дней в наличии) * дней в отчете
lost_profit number Упущенная выручка (Потенциал - Выручка)
days_in_stock number Количество дней, когда товар был в наличии на конец дня
days_with_sales number Количество дней, когда были продажи
average_if_in_stock number Среднее число продаж, при наличии товара на конец дня
sales number Количество проданных единиц товара за период
revenue number Выручка за период
graph array<number> График продаж

Категории

GET oz/get/brand/categories

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

Параметр Тип Обязательный Описание Значение по умолчанию
path Строка Да Название бренда, например DEKO Нет
d1 Дата в формате YYYY-MM-DD Нет Дата начала периода Для тарифных планов "Базовый", "Расширенный" равна дате начала периода согласно условиям тарифа без возможности изменения.
d2 Дата в формате YYYY-MM-DD Нет Дата окончания периода Для тарифных планов "Базовый", "Расширенный" равна дате окончания периода согласно условиям тарифа без возможности изменения.

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

curl --location --request GET 'https://mpstats.io/api/oz/get/brand/categories?d1=2020-07-13&d2=2020-08-11&path=DEKO' \
--header 'X-Mpstats-TOKEN: 5f344c39f1bed8.86604437950c9cc0893508080fc8cef256d5a983' \
--header 'Content-Type: application/json'

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

    
[
    ...,

    "Строительство и ремонт/Инструменты/Электроинструменты/Шуруповерты": {
        "fbs": {
            "items": 38,
            "sales": 513,
            "revenue": 1383452
        },
        "fbo": {
            "items": 28,
            "sales": 2383,
            "revenue": 6500534
        },
        "retail": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        },
        "crossborder": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        }
    },

    ...,

]
    

Описание полей:

Имя поля Тип Описание
sales number Количество проданных единиц товара за период
revenue number Выручка за период
items number Наименований товаров

Продавцы

GET oz/get/brand/sellers

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

Параметр Тип Обязательный Описание Значение по умолчанию
path Строка Да Название бренда, например DEKO Нет
d1 Дата в формате YYYY-MM-DD Нет Дата начала периода Для тарифных планов "Базовый", "Расширенный" равна дате начала периода согласно условиям тарифа без возможности изменения.
d2 Дата в формате YYYY-MM-DD Нет Дата окончания периода Для тарифных планов "Базовый", "Расширенный" равна дате окончания периода согласно условиям тарифа без возможности изменения.

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

curl --location --request GET 'https://mpstats.io/api/oz/get/brand/sellers?d1=2020-07-13&d2=2020-08-11&path=DEKO' \
--header 'X-Mpstats-TOKEN: 5f344c39f1bed8.86604437950c9cc0893508080fc8cef256d5a983' \
--header 'Content-Type: application/json'

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

    
[
    ...,

    "DEKO Russia": {
        "fbo": {
            "items": 6,
            "sales": 19,
            "revenue": 37112
        },
        "fbs": {
            "items": 220,
            "sales": 3175,
            "revenue": 4580240
        },
        "retail": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        },
        "crossborder": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        }
    },

    ...,

]
    

Описание полей:

Имя поля Тип Описание
sales number Количество проданных единиц товара за период
revenue number Выручка за период
items number Наименований товаров

По дням

GET oz/get/brand/by_date

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

Параметр Тип Обязательный Описание Значение по умолчанию
path Строка Да Название бренда, например DEKO Нет
d1 Дата в формате YYYY-MM-DD Нет Дата начала периода Для тарифных планов "Базовый", "Расширенный" равна дате начала периода согласно условиям тарифа без возможности изменения.
d2 Дата в формате YYYY-MM-DD Нет Дата окончания периода Для тарифных планов "Базовый", "Расширенный" равна дате окончания периода согласно условиям тарифа без возможности изменения.

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

curl --location --request GET 'https://mpstats.io/api/oz/get/brand/by_date?d1=2020-07-13&d2=2020-08-11&path=DEKO' \
--header 'X-Mpstats-TOKEN: 5f344c39f1bed8.86604437950c9cc0893508080fc8cef256d5a983' \
--header 'Content-Type: application/json'

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

    
[
    ...,

    "2020-08-11": {
        "data": 1597093200,
        "fbo": {
            "items": 221,
            "sales": 772,
            "revenue": 1110446
        },
        "fbs": {
            "items": 335,
            "sales": 259,
            "revenue": 453794
        },
        "retail": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        },
        "crossborder": {
            "items": 0,
            "sales": 0,
            "revenue": 0
        }
    },

    ...,

]
    

Описание полей:

Имя поля Тип Описание
sales number Количество проданных единиц товара за период
revenue number Выручка за период
items number Наименований товаров

Товарная позиция (SKU)

Получение данных по товару

GET oz/get/item/{sku}

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

curl --location --request GET 'https://mpstats.io/api/oz/get/item/150289066' \
--header 'X-Mpstats-TOKEN: 5f356bf2a55695.18670170077856385aaba91fb0b6b76bb7533b52' \
--header 'Content-Type: application/json'

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

    
{
    "item": {
        "id": 150289066,
        "name": "Пылесос для сухой и влажной уборки Karcher WD 3 P Premium",
        "first_name": "Пылесос для сухой и влажной уборки Karcher WD 3 P Premium",
        "link": "https://ozon.ru/context/detail/id/150289066/",
        "brand": "Karcher",
        "seller": "OZON",
        "category": "Строительство и ремонт/Инструменты/Силовая техника и оборудование/Промышленные и строительные пылесосы/Karcher",
        "delivery_from": "со склада OZON",
        "delivery_scheme": "Retail",
        "rating": 488,
        "balance": 253,
        "comments": 96,
        "price": 8490,
        "final_price": 6990,
        "discount": 17,
        "updated": "2020-08-14",
        "is_bestseller": 1
    },
    "photos": [
        {
            "f": "https://cdn1.ozone.ru/s3/multimedia-2/6006503870.jpg",
            "t": "https://cdn1.ozone.ru/s3/multimedia-2/d100/6006503870.jpg"
        }
    ]
}
    

Описание полей:

Имя поля Тип Описание
id number Идентификатор товара (SKU)
name text Название
link text Ссылка на площадке
brand text Бренд
seller text Продавец
category text Товарная категория
delivery_from text Доставка от
delivery_scheme text Схема работы
comments number Комментариев
balance number Остаток
price number Цена
final_price number Цена с учетом скидки
discount number Скидка
updated date Обновлено
is_bestseller number Бестселлер

Продажи и остатки

GET oz/get/item/{sku}/sales

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

Параметр Тип Обязательный Описание Значение по умолчанию
d1 Дата в формате YYYY-MM-DD Нет Дата начала периода Для тарифных планов "Базовый", "Расширенный" равна дате начала периода согласно условиям тарифа без возможности изменения.
d2 Дата в формате YYYY-MM-DD Нет Дата окончания периода Для тарифных планов "Базовый", "Расширенный" равна дате окончания периода согласно условиям тарифа без возможности изменения.

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

curl --location --request GET 'https://mpstats.io/api/oz/get/item/150289066/sales?d1=2020-06-16&d2=2020-08-14' \
--header 'X-Mpstats-TOKEN: 5f356bf2a55695.18670170077856385aaba91fb0b6b76bb7533b52' \
--header 'Content-Type: application/json'

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

    
[
    {
        "no_data": 0,
        "data": "2020-08-14",
        "balance": 253,
        "sales": 0,
        "rating": 4.88,
        "price": 8490,
        "final_price": 6990,
        "is_bestseller": 1,
        "comments": 96
    },
    {
        "no_data": 0,
        "data": "2020-08-13",
        "balance": 193,
        "sales": 20,
        "rating": 4.88,
        "price": 8490,
        "final_price": 6990,
        "is_bestseller": 1,
        "comments": 96
    },
    ...,

]
    

Описание полей:

Имя поля Тип Описание
no_data number 0: OK, 1: Продаж и остатков не зафиксировано
data date Дата
sales number Продажи
balance number Остаток
price number Цена
final_price number Со скидкой
comments number Комментариев
rating number Рейтинг
is_bestseller number Бестселлер

История позиций по категориям

GET oz/get/item/{sku}/by_category

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

Параметр Тип Обязательный Описание Значение по умолчанию
d1 Дата в формате YYYY-MM-DD Нет Дата начала периода Для тарифных планов "Базовый", "Расширенный" равна дате начала периода согласно условиям тарифа без возможности изменения.
d2 Дата в формате YYYY-MM-DD Нет Дата окончания периода Для тарифных планов "Базовый", "Расширенный" равна дате окончания периода согласно условиям тарифа без возможности изменения.

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

curl --location --request GET 'https://mpstats.io/api/oz/get/item/3867317/by_category?d1=2020-07-15&d2=2020-08-13' \
--header 'X-Mpstats-TOKEN: 5f356bf2a55695.18670170077856385aaba91fb0b6b76bb7533b52' \
--header 'Content-Type: application/json'

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

    
{
    balance: [0, 0, 8757, 8597, 8436, 8285, 8094, 7925, 7774, 7549, 7275, 7043, 6701, 6419, 6201, 6011, 5788, 5606,…]
    categories: {,…}
        Женщинам/Белье: ["NaN", "NaN", 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 2, 2, 2, 2, 2, 2, 2, 2, 1]
        Женщинам/Белье/Колготки и чулки: ["NaN", "NaN", 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1]
        Женщинам/Белье/Колготки и чулки/Носки: ["NaN", "NaN", 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1]
    days: ["14.07", "15.07", "16.07", "17.07", "18.07", "19.07", "20.07", "21.07", "22.07", "23.07", "24.07",…]
    final_price: [0, 0, 498, 498, 498, 439, 439, 439, 439, 439, 439, 439, 439, 439, 439, 439, 439, 439, 439, 439, 439,…]
    sales: [0, 0, 144, 160, 161, 151, 192, 169, 151, 225, 274, 232, 342, 282, 219, 190, 223, 182, 163, 166, 153,…]
    }
    

Описание полей:

Имя поля Тип Описание
final_price array<number> Цена со скидкой
categories object{[string]: array<string|number>} Категория и позиции в ней. NaN: Позиция не определена
days array<string> Дни
balance array<number> Остаток
sales array<number> Продаж

Пакетные запросы

Товарные позиции (SKUs)

Получение данных по товарам

POST oz/get/items/batch

Тело запроса:


{
    // Массив sku товаров, не более 200 в одном запросе
   ids: [];

}

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

curl --location --request POST 'https://mpstats.io/api/oz/get/items/batch' \
--header 'X-Mpstats-TOKEN: 5f356bf2a55695.18670170077856385aaba91fb0b6b76bb7533b52' \
--header 'Content-Type: application/json' \
--header 'Cookie: XDEBUG_SESSION=PHPDEBUG' \
--data-raw '{"ids":[150289066, 150355659]}'

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

    
[
    {
        "item": {
            "id": 150289066,
            "name": "Пылесос для сухой и влажной уборки Karcher WD 3 P Premium",
            "first_name": "Пылесос для сухой и влажной уборки Karcher WD 3 P Premium",
            "link": "https://ozon.ru/context/detail/id/150289066/",
            "brand": "Karcher",
            "seller": "OZON",
            "category": "Строительство и ремонт/Инструменты/Силовая техника и оборудование/Промышленные и строительные пылесосы/Karcher",
            "delivery_from": "со склада OZON",
            "delivery_scheme": "Retail",
            "rating": 488,
            "balance": 253,
            "comments": 96,
            "price": 8490,
            "final_price": 6990,
            "discount": 17,
            "updated": "2020-08-14",
            "is_bestseller": 1
        },
        "photos": [
            {
                "f": "https://cdn1.ozone.ru/s3/multimedia-2/6006503870.jpg",
                "t": "https://cdn1.ozone.ru/s3/multimedia-2/d100/6006503870.jpg"
            }
        ]
    }
    ...,
]
    

Описание полей:

Имя поля Тип Описание
id number Идентификатор товара (SKU)
name text Название
link text Ссылка на площадке
brand text Бренд
seller text Продавец
category text Товарная категория
delivery_from text Доставка от
delivery_scheme text Схема работы
comments number Комментариев
balance number Остаток
price number Цена
final_price number Цена с учетом скидки
discount number Скидка
updated date Обновлено
is_bestseller number Бестселлер