169 lines
26 KiB
TypeScript
169 lines
26 KiB
TypeScript
/**
|
||
* Документация Ozon Seller API
|
||
* По вопросам работы с Seller API обращайтесь в поддержку через личный кабинет. <aside class=\"warning\">Обновляем корневой TLS/SSL-сертификат GlobalSign — вместо него будем использовать <a href=\"https://app.harica.gr/\">HARICA</a>.<br><a href=\"https://dev.ozon.ru/news/775-Izmeneniia-v-Ozon-API-migratsiia-kornevogo-sertifikata-UTs-Ozon/\">Подробнее о переходе на HARICA на платформе разработчиков Ozon for dev</a></aside> > [Инструкции по работе с маркетплейсом](https://seller-edu.ozon.ru) > [Информационная платформа и сообщество разработчиков Ozon for dev](https://dev.ozon.ru/)
|
||
*
|
||
* The version of the OpenAPI document: 2.1
|
||
*
|
||
*
|
||
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
||
* https://openapi-generator.tech
|
||
* Do not edit the class manually.
|
||
*/
|
||
import * as runtime from '../runtime';
|
||
import type { AnalyticsAnalyticsGetDataRequest, AnalyticsAnalyticsGetDataResponse, ChatChatSendMessageRequest, ChatChatSendMessageResponse, ChatChatStartRequest, ChatChatStartResponse, ChatRead, GetRealizationReportByDayResponse, V1AnalyticsProductQueriesDetailsRequest, V1AnalyticsProductQueriesDetailsResponse, V1AnalyticsProductQueriesRequest, V1AnalyticsProductQueriesResponse, V1GetRealizationReportByDayRequest, V1ProductPricesDetailsRequest, V1ProductPricesDetailsResponse, V1SearchQueriesTextRequest, V1SearchQueriesTextResponse, V1SearchQueriesTopRequest, V1SearchQueriesTopResponse, V2ChatReadResponse } from '../models/index';
|
||
export interface AnalyticsAPIAnalyticsGetDataRequest {
|
||
clientId: string;
|
||
apiKey: string;
|
||
analyticsAnalyticsGetDataRequest: AnalyticsAnalyticsGetDataRequest;
|
||
}
|
||
export interface AnalyticsAPIAnalyticsProductQueriesRequest {
|
||
clientId: string;
|
||
apiKey: string;
|
||
v1AnalyticsProductQueriesRequest: V1AnalyticsProductQueriesRequest;
|
||
}
|
||
export interface AnalyticsAPIAnalyticsProductQueriesDetailsRequest {
|
||
clientId: string;
|
||
apiKey: string;
|
||
v1AnalyticsProductQueriesDetailsRequest: V1AnalyticsProductQueriesDetailsRequest;
|
||
}
|
||
export interface ChatAPIChatReadV2Request {
|
||
clientId: string;
|
||
apiKey: string;
|
||
chatRead: ChatRead;
|
||
}
|
||
export interface ChatAPIChatSendMessageRequest {
|
||
clientId: string;
|
||
apiKey: string;
|
||
chatChatSendMessageRequest: ChatChatSendMessageRequest;
|
||
}
|
||
export interface ChatAPIChatStartRequest {
|
||
clientId: string;
|
||
apiKey: string;
|
||
chatChatStartRequest: ChatChatStartRequest;
|
||
}
|
||
export interface FinanceAPIGetRealizationByDayReportV1Request {
|
||
clientId: string;
|
||
apiKey: string;
|
||
v1GetRealizationReportByDayRequest: V1GetRealizationReportByDayRequest;
|
||
}
|
||
export interface ProductPricesDetailsRequest {
|
||
clientId: string;
|
||
apiKey: string;
|
||
v1ProductPricesDetailsRequest: V1ProductPricesDetailsRequest;
|
||
}
|
||
export interface SearchQueriesAPISearchQueriesTextRequest {
|
||
clientId: string;
|
||
apiKey: string;
|
||
v1SearchQueriesTextRequest: V1SearchQueriesTextRequest;
|
||
}
|
||
export interface SearchQueriesAPISearchQueriesTopRequest {
|
||
clientId: string;
|
||
apiKey: string;
|
||
v1SearchQueriesTopRequest: V1SearchQueriesTopRequest;
|
||
}
|
||
/**
|
||
*
|
||
*/
|
||
export declare class Premium extends runtime.BaseAPI {
|
||
/**
|
||
* Уĸажите период и метриĸи, ĸоторые нужно посчитать. В ответе будет аналитиĸа, сгруппированная по параметру `dimensions`. Для продавцов без подписки [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus): - доступны данные за последние 3 месяца, - есть ограничения по способам группировки данных и метрикам. Для продавцов с подпиской [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro) ограничений нет. Метод можно использовать не больше 1 раза в минуту. Соответствует разделу **Аналитика → Графики** в личном кабинете.
|
||
* Данные аналитики
|
||
*/
|
||
analyticsAPIAnalyticsGetDataRaw(requestParameters: AnalyticsAPIAnalyticsGetDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AnalyticsAnalyticsGetDataResponse>>;
|
||
/**
|
||
* Уĸажите период и метриĸи, ĸоторые нужно посчитать. В ответе будет аналитиĸа, сгруппированная по параметру `dimensions`. Для продавцов без подписки [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus): - доступны данные за последние 3 месяца, - есть ограничения по способам группировки данных и метрикам. Для продавцов с подпиской [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro) ограничений нет. Метод можно использовать не больше 1 раза в минуту. Соответствует разделу **Аналитика → Графики** в личном кабинете.
|
||
* Данные аналитики
|
||
*/
|
||
analyticsAPIAnalyticsGetData(clientId: string, apiKey: string, analyticsAnalyticsGetDataRequest: AnalyticsAnalyticsGetDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AnalyticsAnalyticsGetDataResponse>;
|
||
/**
|
||
* Используйте метод, чтобы получить данные о запросах ваших товаров. Полная аналитика доступна с подпиской [Premium](https://seller-edu.ozon.ru/seller-rating/about-rating/premium-program), [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro). Без подписки вы можете посмотреть часть показателей. Метод аналогичен вкладке **Товары в поиске → Запросы моего товара** в личном кабинете. Аналитику по запросам можно проверить за определённые даты. Для этого укажите интервал в полях `date_from` и `date_to`. Данные за последний месяц доступны в любом интервале, кроме текущей даты — расчёт происходит в течение 1–2 дней. Аналитика за даты раньше месяца назад доступна только с подпиской [Premium](https://seller-edu.ozon.ru/seller-rating/about-rating/premium-program), [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro) и только по неделям — в запросе укажите параметр `date_from`. [Подробнее о работе с запросами товара в Базе знаний продавца](https://seller-edu.ozon.ru/analytics-and-metrics/graphs/analitika-po-zaprosu)
|
||
* Получить информацию о запросах моих товаров
|
||
*/
|
||
analyticsAPIAnalyticsProductQueriesRaw(requestParameters: AnalyticsAPIAnalyticsProductQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1AnalyticsProductQueriesResponse>>;
|
||
/**
|
||
* Используйте метод, чтобы получить данные о запросах ваших товаров. Полная аналитика доступна с подпиской [Premium](https://seller-edu.ozon.ru/seller-rating/about-rating/premium-program), [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro). Без подписки вы можете посмотреть часть показателей. Метод аналогичен вкладке **Товары в поиске → Запросы моего товара** в личном кабинете. Аналитику по запросам можно проверить за определённые даты. Для этого укажите интервал в полях `date_from` и `date_to`. Данные за последний месяц доступны в любом интервале, кроме текущей даты — расчёт происходит в течение 1–2 дней. Аналитика за даты раньше месяца назад доступна только с подпиской [Premium](https://seller-edu.ozon.ru/seller-rating/about-rating/premium-program), [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro) и только по неделям — в запросе укажите параметр `date_from`. [Подробнее о работе с запросами товара в Базе знаний продавца](https://seller-edu.ozon.ru/analytics-and-metrics/graphs/analitika-po-zaprosu)
|
||
* Получить информацию о запросах моих товаров
|
||
*/
|
||
analyticsAPIAnalyticsProductQueries(clientId: string, apiKey: string, v1AnalyticsProductQueriesRequest: V1AnalyticsProductQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1AnalyticsProductQueriesResponse>;
|
||
/**
|
||
* Используйте метод, чтобы получить данные по запросам на конкретный товар. Полная аналитика доступна с подпиской [Premium](https://seller-edu.ozon.ru/seller-rating/about-rating/premium-program), [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro). Без подписки вы можете посмотреть часть показателей. Метод аналогичен просмотру данных по товару на вкладке **Товары в поиске → Запросы моего товара** в личном кабинете. Аналитику по запросам можно проверить за определённые даты. Для этого укажите интервал в полях `date_from` и `date_to`. Данные за последний месяц доступны в любом интервале, кроме текущей даты — расчёт происходит в течение 1–2 дней. Аналитика за даты раньше месяца назад доступна только с подпиской [Premium](https://seller-edu.ozon.ru/seller-rating/about-rating/premium-program), [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro) и только по неделям — в запросе укажите параметр `date_from`. [Подробнее о работе с запросами товара в Базе знаний продавца](https://seller-edu.ozon.ru/analytics-and-metrics/graphs/analitika-po-zaprosu)
|
||
* Получить детализацию запросов по товару
|
||
*/
|
||
analyticsAPIAnalyticsProductQueriesDetailsRaw(requestParameters: AnalyticsAPIAnalyticsProductQueriesDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1AnalyticsProductQueriesDetailsResponse>>;
|
||
/**
|
||
* Используйте метод, чтобы получить данные по запросам на конкретный товар. Полная аналитика доступна с подпиской [Premium](https://seller-edu.ozon.ru/seller-rating/about-rating/premium-program), [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro). Без подписки вы можете посмотреть часть показателей. Метод аналогичен просмотру данных по товару на вкладке **Товары в поиске → Запросы моего товара** в личном кабинете. Аналитику по запросам можно проверить за определённые даты. Для этого укажите интервал в полях `date_from` и `date_to`. Данные за последний месяц доступны в любом интервале, кроме текущей даты — расчёт происходит в течение 1–2 дней. Аналитика за даты раньше месяца назад доступна только с подпиской [Premium](https://seller-edu.ozon.ru/seller-rating/about-rating/premium-program), [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro) и только по неделям — в запросе укажите параметр `date_from`. [Подробнее о работе с запросами товара в Базе знаний продавца](https://seller-edu.ozon.ru/analytics-and-metrics/graphs/analitika-po-zaprosu)
|
||
* Получить детализацию запросов по товару
|
||
*/
|
||
analyticsAPIAnalyticsProductQueriesDetails(clientId: string, apiKey: string, v1AnalyticsProductQueriesDetailsRequest: V1AnalyticsProductQueriesDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1AnalyticsProductQueriesDetailsResponse>;
|
||
/**
|
||
* Доступно для продавцов с подпиской [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro). Метод для отметки выбранного сообщения и сообщений до него прочитанными. <br><br> Получите список чатов с покупателем `chats.chat.chat_type=\"Buyer_Seller\"` в ответе метода [/v3/chat/list](#operation/ChatAPI_ChatListV3).
|
||
* Отметить сообщения как прочитанные
|
||
*/
|
||
chatAPIChatReadV2Raw(requestParameters: ChatAPIChatReadV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ChatReadResponse>>;
|
||
/**
|
||
* Доступно для продавцов с подпиской [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro). Метод для отметки выбранного сообщения и сообщений до него прочитанными. <br><br> Получите список чатов с покупателем `chats.chat.chat_type=\"Buyer_Seller\"` в ответе метода [/v3/chat/list](#operation/ChatAPI_ChatListV3).
|
||
* Отметить сообщения как прочитанные
|
||
*/
|
||
chatAPIChatReadV2(clientId: string, apiKey: string, chatRead: ChatRead, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ChatReadResponse>;
|
||
/**
|
||
* Доступно для продавцов с подпиской [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro). Отправляет сообщение в существующий чат по его идентификатору. <br><br> Получите список чатов с покупателем `chats.chat.chat_type=\"Buyer_Seller\"` в ответе метода [/v3/chat/list](#operation/ChatAPI_ChatListV3). Для отправлений: - FBO — вы можете отправить сообщение в течение 48 часов с момента получения последнего сообщения от покупателя. - FBS или rFBS — вы можете отправить сообщение покупателю после оплаты и в течение 72 часов после доставки отправления. После этого вы можете только отвечать на сообщения в течение 48 часов с момента получения последнего сообщения от покупателя.
|
||
* Отправить сообщение
|
||
*/
|
||
chatAPIChatSendMessageRaw(requestParameters: ChatAPIChatSendMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChatChatSendMessageResponse>>;
|
||
/**
|
||
* Доступно для продавцов с подпиской [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro). Отправляет сообщение в существующий чат по его идентификатору. <br><br> Получите список чатов с покупателем `chats.chat.chat_type=\"Buyer_Seller\"` в ответе метода [/v3/chat/list](#operation/ChatAPI_ChatListV3). Для отправлений: - FBO — вы можете отправить сообщение в течение 48 часов с момента получения последнего сообщения от покупателя. - FBS или rFBS — вы можете отправить сообщение покупателю после оплаты и в течение 72 часов после доставки отправления. После этого вы можете только отвечать на сообщения в течение 48 часов с момента получения последнего сообщения от покупателя.
|
||
* Отправить сообщение
|
||
*/
|
||
chatAPIChatSendMessage(clientId: string, apiKey: string, chatChatSendMessageRequest: ChatChatSendMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChatChatSendMessageResponse>;
|
||
/**
|
||
* Доступно для продавцов с подпиской [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro). Создает новый чат с покупателем по отправлению. Например, чтобы уточнить адрес или модель товара. Для отправлений: - FBO — начать чат может только покупатель. - FBS и rFBS — вы можете открыть чат в течение 72 часов после оплаты или доставки отправления.
|
||
* Создать новый чат
|
||
*/
|
||
chatAPIChatStartRaw(requestParameters: ChatAPIChatStartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChatChatStartResponse>>;
|
||
/**
|
||
* Доступно для продавцов с подпиской [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro). Создает новый чат с покупателем по отправлению. Например, чтобы уточнить адрес или модель товара. Для отправлений: - FBO — начать чат может только покупатель. - FBS и rFBS — вы можете открыть чат в течение 72 часов после оплаты или доставки отправления.
|
||
* Создать новый чат
|
||
*/
|
||
chatAPIChatStart(clientId: string, apiKey: string, chatChatStartRequest: ChatChatStartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChatChatStartResponse>;
|
||
/**
|
||
* Доступно для продавцов с подпиской [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro). Возвращает данные о суммах реализации из [отчёта о реализации товаров](#operation/FinanceAPI_GetRealizationReportV2) за день. Отмены и невыкупы не включаются. Данные доступны не более чем за 32 календарных дня от текущей даты.
|
||
* Отчёт о реализации товаров за день
|
||
*/
|
||
financeAPIGetRealizationByDayReportV1Raw(requestParameters: FinanceAPIGetRealizationByDayReportV1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetRealizationReportByDayResponse>>;
|
||
/**
|
||
* Доступно для продавцов с подпиской [Premium Plus](https://seller-edu.ozon.ru/seller-rating/about-rating/subscription-premium-plus) или [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro). Возвращает данные о суммах реализации из [отчёта о реализации товаров](#operation/FinanceAPI_GetRealizationReportV2) за день. Отмены и невыкупы не включаются. Данные доступны не более чем за 32 календарных дня от текущей даты.
|
||
* Отчёт о реализации товаров за день
|
||
*/
|
||
financeAPIGetRealizationByDayReportV1(clientId: string, apiKey: string, v1GetRealizationReportByDayRequest: V1GetRealizationReportByDayRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRealizationReportByDayResponse>;
|
||
/**
|
||
* Доступно для продавцов с подпиской Premium Pro.
|
||
* Получить подробную информацию о ценах товаров
|
||
*/
|
||
productPricesDetailsRaw(requestParameters: ProductPricesDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1ProductPricesDetailsResponse>>;
|
||
/**
|
||
* Доступно для продавцов с подпиской Premium Pro.
|
||
* Получить подробную информацию о ценах товаров
|
||
*/
|
||
productPricesDetails(clientId: string, apiKey: string, v1ProductPricesDetailsRequest: V1ProductPricesDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1ProductPricesDetailsResponse>;
|
||
/**
|
||
* Доступно для продавцов с подпиской [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro).
|
||
* Получить список поисковых запросов по тексту
|
||
*/
|
||
searchQueriesAPISearchQueriesTextRaw(requestParameters: SearchQueriesAPISearchQueriesTextRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1SearchQueriesTextResponse>>;
|
||
/**
|
||
* Доступно для продавцов с подпиской [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro).
|
||
* Получить список поисковых запросов по тексту
|
||
*/
|
||
searchQueriesAPISearchQueriesText(clientId: string, apiKey: string, v1SearchQueriesTextRequest: V1SearchQueriesTextRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1SearchQueriesTextResponse>;
|
||
/**
|
||
* Доступно для продавцов с подпиской [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro).
|
||
* Получить список популярных поисковых запросов
|
||
*/
|
||
searchQueriesAPISearchQueriesTopRaw(requestParameters: SearchQueriesAPISearchQueriesTopRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1SearchQueriesTopResponse>>;
|
||
/**
|
||
* Доступно для продавцов с подпиской [Premium Pro](https://seller-edu.ozon.ru/seller-rating/about-rating/podpiska-premium-pro).
|
||
* Получить список популярных поисковых запросов
|
||
*/
|
||
searchQueriesAPISearchQueriesTop(clientId: string, apiKey: string, v1SearchQueriesTopRequest: V1SearchQueriesTopRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1SearchQueriesTopResponse>;
|
||
}
|