159 lines
21 KiB
TypeScript
159 lines
21 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 { CommonCreateReportResponse, CreateReportResponse, Financev3FinanceTransactionListV3Request, Financev3FinanceTransactionListV3Response, Financev3FinanceTransactionTotalsV3Request, Financev3FinanceTransactionTotalsV3Response, V1CreateDocumentB2BSalesJSONReportRequest, V1CreateDocumentB2BSalesJSONReportResponse, V1CreateDocumentB2BSalesReportRequest, V1CreateMutualSettlementReportRequest, V1GetCompensationReportRequest, V1GetDecompensationReportRequest, V1GetFinanceProductsBuyoutRequest, V1GetFinanceProductsBuyoutResponse, V1GetRealizationReportPostingRequest, V1GetRealizationReportPostingResponse, V2GetRealizationReportRequestV2, V2GetRealizationReportResponseV2 } from '../models/index';
|
||
export interface FinanceAPIFinanceTransactionListV3Request {
|
||
clientId: string;
|
||
apiKey: string;
|
||
financev3FinanceTransactionListV3Request: Financev3FinanceTransactionListV3Request;
|
||
}
|
||
export interface FinanceAPIFinanceTransactionTotalV3Request {
|
||
clientId: string;
|
||
apiKey: string;
|
||
financev3FinanceTransactionTotalsV3Request: Financev3FinanceTransactionTotalsV3Request | null;
|
||
}
|
||
export interface FinanceAPIGetRealizationReportV1Request {
|
||
clientId: string;
|
||
apiKey: string;
|
||
v1GetRealizationReportPostingRequest: V1GetRealizationReportPostingRequest;
|
||
}
|
||
export interface FinanceAPIGetRealizationReportV2Request {
|
||
clientId: string;
|
||
apiKey: string;
|
||
v2GetRealizationReportRequestV2: V2GetRealizationReportRequestV2;
|
||
}
|
||
export interface GetFinanceProductsBuyoutRequest {
|
||
v1GetFinanceProductsBuyoutRequest?: V1GetFinanceProductsBuyoutRequest;
|
||
}
|
||
export interface ReportAPICreateDocumentB2BSalesJSONReportRequest {
|
||
v1CreateDocumentB2BSalesJSONReportRequest: V1CreateDocumentB2BSalesJSONReportRequest;
|
||
}
|
||
export interface ReportAPICreateDocumentB2BSalesReportRequest {
|
||
v1CreateDocumentB2BSalesReportRequest: V1CreateDocumentB2BSalesReportRequest;
|
||
}
|
||
export interface ReportAPICreateMutualSettlementReportRequest {
|
||
clientId: string;
|
||
apiKey: string;
|
||
v1CreateMutualSettlementReportRequest: V1CreateMutualSettlementReportRequest;
|
||
}
|
||
export interface ReportAPIGetCompensationReportRequest {
|
||
v1GetCompensationReportRequest: V1GetCompensationReportRequest;
|
||
}
|
||
export interface ReportAPIGetDecompensationReportRequest {
|
||
v1GetDecompensationReportRequest: V1GetDecompensationReportRequest;
|
||
}
|
||
/**
|
||
*
|
||
*/
|
||
export declare class FinanceAPI extends runtime.BaseAPI {
|
||
/**
|
||
* <aside class=\"warning\"> Метод устаревает и будет отключён 8 сентября 2026 года. Переключитесь на <a href=\"#operation/GetFinanceAccrualPostings\">/v1/finance/accrual/postings</a>, <a href=\"#operation/GetFinanceAccrualTypes\">/v1/finance/accrual/types</a>, <a href=\"#operation/GetFinanceAccrualByDay\">/v1/finance/accrual/by-day</a>. <br><br> Используйте метод с последовательной отправкой запросов.<br> Данные могут не соответствовать информации в личном кабинете. </aside> Возвращает подробную информацию по всем начислениям. Максимальный период, за который можно получить информацию в одном запросе — 1 месяц. Если в запросе не указывать `posting_number`, то в ответе будут все отправления за указанный период или отправления определённого типа.
|
||
* Список транзакций
|
||
*/
|
||
financeAPIFinanceTransactionListV3Raw(requestParameters: FinanceAPIFinanceTransactionListV3Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Financev3FinanceTransactionListV3Response>>;
|
||
/**
|
||
* <aside class=\"warning\"> Метод устаревает и будет отключён 8 сентября 2026 года. Переключитесь на <a href=\"#operation/GetFinanceAccrualPostings\">/v1/finance/accrual/postings</a>, <a href=\"#operation/GetFinanceAccrualTypes\">/v1/finance/accrual/types</a>, <a href=\"#operation/GetFinanceAccrualByDay\">/v1/finance/accrual/by-day</a>. <br><br> Используйте метод с последовательной отправкой запросов.<br> Данные могут не соответствовать информации в личном кабинете. </aside> Возвращает подробную информацию по всем начислениям. Максимальный период, за который можно получить информацию в одном запросе — 1 месяц. Если в запросе не указывать `posting_number`, то в ответе будут все отправления за указанный период или отправления определённого типа.
|
||
* Список транзакций
|
||
*/
|
||
financeAPIFinanceTransactionListV3(clientId: string, apiKey: string, financev3FinanceTransactionListV3Request: Financev3FinanceTransactionListV3Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Financev3FinanceTransactionListV3Response>;
|
||
/**
|
||
* <aside class=\"warning\"> Метод устаревает и будет отключён 8 сентября 2026 года. Переключитесь на <a href=\"#operation/GetFinanceAccrualPostings\">/v1/finance/accrual/postings</a>, <a href=\"#operation/GetFinanceAccrualTypes\">/v1/finance/accrual/types</a>, <a href=\"#operation/GetFinanceAccrualByDay\">/v1/finance/accrual/by-day</a>. <br><br> Данные могут не соответствовать информации в личном кабинете. </aside> Возвращает итоговые суммы по транзакциям за указанный период. Если вы неправильно заполните номера отправлений, в ответе вернутся нулевые значения.
|
||
* Суммы транзакций
|
||
*/
|
||
financeAPIFinanceTransactionTotalV3Raw(requestParameters: FinanceAPIFinanceTransactionTotalV3Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Financev3FinanceTransactionTotalsV3Response>>;
|
||
/**
|
||
* <aside class=\"warning\"> Метод устаревает и будет отключён 8 сентября 2026 года. Переключитесь на <a href=\"#operation/GetFinanceAccrualPostings\">/v1/finance/accrual/postings</a>, <a href=\"#operation/GetFinanceAccrualTypes\">/v1/finance/accrual/types</a>, <a href=\"#operation/GetFinanceAccrualByDay\">/v1/finance/accrual/by-day</a>. <br><br> Данные могут не соответствовать информации в личном кабинете. </aside> Возвращает итоговые суммы по транзакциям за указанный период. Если вы неправильно заполните номера отправлений, в ответе вернутся нулевые значения.
|
||
* Суммы транзакций
|
||
*/
|
||
financeAPIFinanceTransactionTotalV3(clientId: string, apiKey: string, financev3FinanceTransactionTotalsV3Request: Financev3FinanceTransactionTotalsV3Request | null, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Financev3FinanceTransactionTotalsV3Response>;
|
||
/**
|
||
* <aside class=\"warning\"> Метод недоступен для продавцов, которые заключили договор с ТОО «ОЗОН Маркетплейс Казахстан». </aside> Отчёт о реализации доставленных и возвращённых товаров с детализацией по каждому заказу. Отмены и невыкупы не включаются. Отчёт доступен с настоящего времени по август 2023 года включительно.
|
||
* Позаказный отчёт о реализации товаров
|
||
*/
|
||
financeAPIGetRealizationReportV1Raw(requestParameters: FinanceAPIGetRealizationReportV1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1GetRealizationReportPostingResponse>>;
|
||
/**
|
||
* <aside class=\"warning\"> Метод недоступен для продавцов, которые заключили договор с ТОО «ОЗОН Маркетплейс Казахстан». </aside> Отчёт о реализации доставленных и возвращённых товаров с детализацией по каждому заказу. Отмены и невыкупы не включаются. Отчёт доступен с настоящего времени по август 2023 года включительно.
|
||
* Позаказный отчёт о реализации товаров
|
||
*/
|
||
financeAPIGetRealizationReportV1(clientId: string, apiKey: string, v1GetRealizationReportPostingRequest: V1GetRealizationReportPostingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1GetRealizationReportPostingResponse>;
|
||
/**
|
||
* <aside class=\"warning\"> Метод недоступен для продавцов, которые заключили договор с ТОО «ОЗОН Маркетплейс Казахстан». Метод позволяет получить отчёт за период не раньше августа 2023 года. Отчёты за более ранние периоды доступны в личном кабинете. </aside> Отчёт о реализации доставленных и возвращённых товаров за месяц. Отмены и невыкупы не включаются. Соответствует разделу **Финансы → Документы → Отчёты о реализации → Отчёт о реализации товара** в личном кабинете. Отчёт придёт не позднее 5-го числа следующего месяца. [Подробнее об отчёте в Базе знаний продавца](https://seller-edu.ozon.ru/docs/finances-documents/calculations-documents/otchet-o-realizacii-tovarov.html)
|
||
* Отчёт о реализации товаров (версия 2)
|
||
*/
|
||
financeAPIGetRealizationReportV2Raw(requestParameters: FinanceAPIGetRealizationReportV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2GetRealizationReportResponseV2>>;
|
||
/**
|
||
* <aside class=\"warning\"> Метод недоступен для продавцов, которые заключили договор с ТОО «ОЗОН Маркетплейс Казахстан». Метод позволяет получить отчёт за период не раньше августа 2023 года. Отчёты за более ранние периоды доступны в личном кабинете. </aside> Отчёт о реализации доставленных и возвращённых товаров за месяц. Отмены и невыкупы не включаются. Соответствует разделу **Финансы → Документы → Отчёты о реализации → Отчёт о реализации товара** в личном кабинете. Отчёт придёт не позднее 5-го числа следующего месяца. [Подробнее об отчёте в Базе знаний продавца](https://seller-edu.ozon.ru/docs/finances-documents/calculations-documents/otchet-o-realizacii-tovarov.html)
|
||
* Отчёт о реализации товаров (версия 2)
|
||
*/
|
||
financeAPIGetRealizationReportV2(clientId: string, apiKey: string, v2GetRealizationReportRequestV2: V2GetRealizationReportRequestV2, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2GetRealizationReportResponseV2>;
|
||
/**
|
||
* Возвращает отчёт о товарах, которые выкупил Ozon. Соответствует разделу **Финансы → Документы → УПД по сделкам с юр. лицами → УПД по выкупленным товарам** в личном кабинете. [Подробнее о выкупе товаров в Базе знаний](https://seller-edu.ozon.ru/commissions-tariffs/commissions-tariffs-ozon/prodaji-tovarov-v-eaes-i-drugie-strany?search=выкупленные+товары)
|
||
* Отчёт о выкупленных товарах
|
||
*/
|
||
getFinanceProductsBuyoutRaw(requestParameters: GetFinanceProductsBuyoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1GetFinanceProductsBuyoutResponse>>;
|
||
/**
|
||
* Возвращает отчёт о товарах, которые выкупил Ozon. Соответствует разделу **Финансы → Документы → УПД по сделкам с юр. лицами → УПД по выкупленным товарам** в личном кабинете. [Подробнее о выкупе товаров в Базе знаний](https://seller-edu.ozon.ru/commissions-tariffs/commissions-tariffs-ozon/prodaji-tovarov-v-eaes-i-drugie-strany?search=выкупленные+товары)
|
||
* Отчёт о выкупленных товарах
|
||
*/
|
||
getFinanceProductsBuyout(v1GetFinanceProductsBuyoutRequest?: V1GetFinanceProductsBuyoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1GetFinanceProductsBuyoutResponse>;
|
||
/**
|
||
* Используйте метод, чтобы получить отчёт по продажам юридическим лицам в JSON-формате. Соответствует разделу **Финансы → Документы → Реестр продаж юр. лицам** в личном кабинете.
|
||
* Реестр продаж юридическим лицам в JSON-формате
|
||
*/
|
||
reportAPICreateDocumentB2BSalesJSONReportRaw(requestParameters: ReportAPICreateDocumentB2BSalesJSONReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1CreateDocumentB2BSalesJSONReportResponse>>;
|
||
/**
|
||
* Используйте метод, чтобы получить отчёт по продажам юридическим лицам в JSON-формате. Соответствует разделу **Финансы → Документы → Реестр продаж юр. лицам** в личном кабинете.
|
||
* Реестр продаж юридическим лицам в JSON-формате
|
||
*/
|
||
reportAPICreateDocumentB2BSalesJSONReport(v1CreateDocumentB2BSalesJSONReportRequest: V1CreateDocumentB2BSalesJSONReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1CreateDocumentB2BSalesJSONReportResponse>;
|
||
/**
|
||
* Используйте метод, чтобы получить отчёт по продажам юридическим лицам. Соответствует разделу **Финансы → Документы → Реестр продаж юр. лицам** в личном кабинете.
|
||
* Реестр продаж юридическим лицам
|
||
*/
|
||
reportAPICreateDocumentB2BSalesReportRaw(requestParameters: ReportAPICreateDocumentB2BSalesReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CommonCreateReportResponse>>;
|
||
/**
|
||
* Используйте метод, чтобы получить отчёт по продажам юридическим лицам. Соответствует разделу **Финансы → Документы → Реестр продаж юр. лицам** в личном кабинете.
|
||
* Реестр продаж юридическим лицам
|
||
*/
|
||
reportAPICreateDocumentB2BSalesReport(v1CreateDocumentB2BSalesReportRequest: V1CreateDocumentB2BSalesReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CommonCreateReportResponse>;
|
||
/**
|
||
* Используйте метод, чтобы получить отчёт о взаиморасчетах. Соответствует разделу **Финансы → Документы → Аналитические отчеты → Отчет о взаиморасчетах** в личном кабинете.
|
||
* Отчёт о взаиморасчётах
|
||
*/
|
||
reportAPICreateMutualSettlementReportRaw(requestParameters: ReportAPICreateMutualSettlementReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CommonCreateReportResponse>>;
|
||
/**
|
||
* Используйте метод, чтобы получить отчёт о взаиморасчетах. Соответствует разделу **Финансы → Документы → Аналитические отчеты → Отчет о взаиморасчетах** в личном кабинете.
|
||
* Отчёт о взаиморасчётах
|
||
*/
|
||
reportAPICreateMutualSettlementReport(clientId: string, apiKey: string, v1CreateMutualSettlementReportRequest: V1CreateMutualSettlementReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CommonCreateReportResponse>;
|
||
/**
|
||
* Метод для получения отчёта о компенсациях. Соответствует отчёту из раздела **Финансы → Документы → Компенсации и прочие начисления** в личном кабинете.
|
||
* Отчёт о компенсациях
|
||
*/
|
||
reportAPIGetCompensationReportRaw(requestParameters: ReportAPIGetCompensationReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateReportResponse>>;
|
||
/**
|
||
* Метод для получения отчёта о компенсациях. Соответствует отчёту из раздела **Финансы → Документы → Компенсации и прочие начисления** в личном кабинете.
|
||
* Отчёт о компенсациях
|
||
*/
|
||
reportAPIGetCompensationReport(v1GetCompensationReportRequest: V1GetCompensationReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateReportResponse>;
|
||
/**
|
||
* Метод для получения отчёта о декомпенсациях. Соответствует отчёту из раздела **Финансы → Документы → Компенсации и прочие начисления** в личном кабинете.
|
||
* Отчёт о декомпенсациях
|
||
*/
|
||
reportAPIGetDecompensationReportRaw(requestParameters: ReportAPIGetDecompensationReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateReportResponse>>;
|
||
/**
|
||
* Метод для получения отчёта о декомпенсациях. Соответствует отчёту из раздела **Финансы → Документы → Компенсации и прочие начисления** в личном кабинете.
|
||
* Отчёт о декомпенсациях
|
||
*/
|
||
reportAPIGetDecompensationReport(v1GetDecompensationReportRequest: V1GetDecompensationReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateReportResponse>;
|
||
}
|