Files
ozon-seller-typescript/dist/apis/FBO.d.ts
2026-08-21 12:19:50 +00:00

240 lines
19 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/**
* Документация 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 { PostingGetFboPostingListRequest, PostingGetFboPostingRequest, PostingV3PostingFboListRequest, PostingV3PostingFboListResponse, SupplyOrderV2SupplyOrderTimeslotListRequest, SupplyOrderV2SupplyOrderTimeslotListResponse, V1CancelReasonListResponseFbo, V1GetSupplyOrderBundleRequest, V1GetSupplyOrderBundleResponse, V1GetSupplyOrderTimeslotStatusRequest, V1GetSupplyOrderTimeslotStatusResponse, V1GetSupplyOrderTimeslotsRequest, V1GetSupplyOrderTimeslotsResponse, V1SupplierAvailableWarehousesResponse, V1SupplyOrderDetailsRequest, V1SupplyOrderDetailsResponse, V1SupplyOrderPassCreateRequest, V1SupplyOrderPassCreateResponse, V1SupplyOrderPassStatusRequest, V1SupplyOrderPassStatusResponse, V1SupplyOrderStatusCounterResponse, V1UpdateSupplyOrderTimeslotRequest, V1UpdateSupplyOrderTimeslotResponse, V2FboPostingListResponse, V2FboPostingResponse, V3SupplyOrderGetRequest, V3SupplyOrderGetResponse, V3SupplyOrderListRequest, V3SupplyOrderListResponse } from '../models/index';
export interface PostingAPIGetFboPostingRequest {
clientId: string;
apiKey: string;
postingGetFboPostingRequest: PostingGetFboPostingRequest;
}
export interface PostingAPIGetFboPostingListRequest {
clientId: string;
apiKey: string;
postingGetFboPostingListRequest: PostingGetFboPostingListRequest;
}
export interface PostingAPIGetPostingFboCancelReasonListRequest {
clientId: string;
apiKey: string;
}
export interface PostingFboListRequest {
clientId: string;
apiKey: string;
postingV3PostingFboListRequest: PostingV3PostingFboListRequest;
}
export interface SupplierAPISupplierAvailableWarehousesRequest {
clientId: string;
apiKey: string;
}
export interface SupplyOrderAPIGetSupplyOrderTimeslotStatusRequest {
clientId: string;
apiKey: string;
v1GetSupplyOrderTimeslotStatusRequest: V1GetSupplyOrderTimeslotStatusRequest;
}
export interface SupplyOrderAPIGetSupplyOrderTimeslotsRequest {
clientId: string;
apiKey: string;
v1GetSupplyOrderTimeslotsRequest: V1GetSupplyOrderTimeslotsRequest;
}
export interface SupplyOrderAPISupplyOrderDetailsRequest {
clientId: string;
apiKey: string;
v1SupplyOrderDetailsRequest: V1SupplyOrderDetailsRequest;
}
export interface SupplyOrderAPISupplyOrderPassCreateRequest {
clientId: string;
apiKey: string;
v1SupplyOrderPassCreateRequest: V1SupplyOrderPassCreateRequest;
}
export interface SupplyOrderAPISupplyOrderPassStatusRequest {
clientId: string;
apiKey: string;
v1SupplyOrderPassStatusRequest: V1SupplyOrderPassStatusRequest;
}
export interface SupplyOrderAPISupplyOrderStatusCounterRequest {
clientId: string;
apiKey: string;
}
export interface SupplyOrderAPIUpdateSupplyOrderTimeslotRequest {
clientId: string;
apiKey: string;
v1UpdateSupplyOrderTimeslotRequest: V1UpdateSupplyOrderTimeslotRequest;
}
export interface SupplyOrderBundleRequest {
v1GetSupplyOrderBundleRequest: V1GetSupplyOrderBundleRequest;
}
export interface SupplyOrderGetRequest {
v3SupplyOrderGetRequest?: V3SupplyOrderGetRequest;
}
export interface SupplyOrderListRequest {
v3SupplyOrderListRequest?: V3SupplyOrderListRequest;
}
export interface SupplyOrderTimeslotListRequest {
clientId: string;
apiKey: string;
supplyOrderV2SupplyOrderTimeslotListRequest: SupplyOrderV2SupplyOrderTimeslotListRequest;
}
/**
*
*/
export declare class FBO extends runtime.BaseAPI {
/**
* Возвращает информацию об отправлении по его идентификатору.
* Информация об отправлении
*/
postingAPIGetFboPostingRaw(requestParameters: PostingAPIGetFboPostingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2FboPostingResponse>>;
/**
* Возвращает информацию об отправлении по его идентификатору.
* Информация об отправлении
*/
postingAPIGetFboPosting(clientId: string, apiKey: string, postingGetFboPostingRequest: PostingGetFboPostingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2FboPostingResponse>;
/**
* <aside class=\"warning\"> С 31 августа 2026 года метод будет отключён. Переключитесь на <a href=\"#operation/PostingFboList\">/v3/posting/fbo/list</a>. </aside> Возвращает список отправлений за указанный период времени. Если период больше года, вернётся ошибка `PERIOD_IS_TOO_LONG`. Дополнительно можно отфильтровать отправления по их статусу.
* Список отправлений
* @deprecated
*/
postingAPIGetFboPostingListRaw(requestParameters: PostingAPIGetFboPostingListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2FboPostingListResponse>>;
/**
* <aside class=\"warning\"> С 31 августа 2026 года метод будет отключён. Переключитесь на <a href=\"#operation/PostingFboList\">/v3/posting/fbo/list</a>. </aside> Возвращает список отправлений за указанный период времени. Если период больше года, вернётся ошибка `PERIOD_IS_TOO_LONG`. Дополнительно можно отфильтровать отправления по их статусу.
* Список отправлений
* @deprecated
*/
postingAPIGetFboPostingList(clientId: string, apiKey: string, postingGetFboPostingListRequest: PostingGetFboPostingListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2FboPostingListResponse>;
/**
* Возвращает список причин отмены для всех FBO-отправлений.
* Причины отмены отправлений по схеме FBO
*/
postingAPIGetPostingFboCancelReasonListRaw(requestParameters: PostingAPIGetPostingFboCancelReasonListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1CancelReasonListResponseFbo>>;
/**
* Возвращает список причин отмены для всех FBO-отправлений.
* Причины отмены отправлений по схеме FBO
*/
postingAPIGetPostingFboCancelReasonList(clientId: string, apiKey: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1CancelReasonListResponseFbo>;
/**
* Возвращает список отправлений за указанный период времени. Если период больше года, вернётся ошибка `PERIOD_IS_TOO_LONG`. Дополнительно можно отфильтровать отправления по их статусу.
* Получить список отправлений
*/
postingFboListRaw(requestParameters: PostingFboListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostingV3PostingFboListResponse>>;
/**
* Возвращает список отправлений за указанный период времени. Если период больше года, вернётся ошибка `PERIOD_IS_TOO_LONG`. Дополнительно можно отфильтровать отправления по их статусу.
* Получить список отправлений
*/
postingFboList(clientId: string, apiKey: string, postingV3PostingFboListRequest: PostingV3PostingFboListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostingV3PostingFboListResponse>;
/**
* Метод возвращает список активных складов Ozon с информацией об их средней загруженности на ближайшее время.
* Загруженность складов Ozon
*/
supplierAPISupplierAvailableWarehousesRaw(requestParameters: SupplierAPISupplierAvailableWarehousesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1SupplierAvailableWarehousesResponse>>;
/**
* Метод возвращает список активных складов Ozon с информацией об их средней загруженности на ближайшее время.
* Загруженность складов Ozon
*/
supplierAPISupplierAvailableWarehouses(clientId: string, apiKey: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1SupplierAvailableWarehousesResponse>;
/**
* Статус интервала поставки
*/
supplyOrderAPIGetSupplyOrderTimeslotStatusRaw(requestParameters: SupplyOrderAPIGetSupplyOrderTimeslotStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1GetSupplyOrderTimeslotStatusResponse>>;
/**
* Статус интервала поставки
*/
supplyOrderAPIGetSupplyOrderTimeslotStatus(clientId: string, apiKey: string, v1GetSupplyOrderTimeslotStatusRequest: V1GetSupplyOrderTimeslotStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1GetSupplyOrderTimeslotStatusResponse>;
/**
* <aside class=\"warning\"> Метод устаревает и будет отключён 19 августа 2026 года. Переключитесь на <a href=\"#operation/SupplyOrderTimeslotList\">/v2/supply-order/timeslot/list</a>. </aside>
* Интервалы поставки
*/
supplyOrderAPIGetSupplyOrderTimeslotsRaw(requestParameters: SupplyOrderAPIGetSupplyOrderTimeslotsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1GetSupplyOrderTimeslotsResponse>>;
/**
* <aside class=\"warning\"> Метод устаревает и будет отключён 19 августа 2026 года. Переключитесь на <a href=\"#operation/SupplyOrderTimeslotList\">/v2/supply-order/timeslot/list</a>. </aside>
* Интервалы поставки
*/
supplyOrderAPIGetSupplyOrderTimeslots(clientId: string, apiKey: string, v1GetSupplyOrderTimeslotsRequest: V1GetSupplyOrderTimeslotsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1GetSupplyOrderTimeslotsResponse>;
/**
* Получить подробную информацию о заявке на поставку
*/
supplyOrderAPISupplyOrderDetailsRaw(requestParameters: SupplyOrderAPISupplyOrderDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1SupplyOrderDetailsResponse>>;
/**
* Получить подробную информацию о заявке на поставку
*/
supplyOrderAPISupplyOrderDetails(clientId: string, apiKey: string, v1SupplyOrderDetailsRequest: V1SupplyOrderDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1SupplyOrderDetailsResponse>;
/**
* Указать данные о водителе и автомобиле
*/
supplyOrderAPISupplyOrderPassCreateRaw(requestParameters: SupplyOrderAPISupplyOrderPassCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1SupplyOrderPassCreateResponse>>;
/**
* Указать данные о водителе и автомобиле
*/
supplyOrderAPISupplyOrderPassCreate(clientId: string, apiKey: string, v1SupplyOrderPassCreateRequest: V1SupplyOrderPassCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1SupplyOrderPassCreateResponse>;
/**
* Статус ввода данных о водителе и автомобиле
*/
supplyOrderAPISupplyOrderPassStatusRaw(requestParameters: SupplyOrderAPISupplyOrderPassStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1SupplyOrderPassStatusResponse>>;
/**
* Статус ввода данных о водителе и автомобиле
*/
supplyOrderAPISupplyOrderPassStatus(clientId: string, apiKey: string, v1SupplyOrderPassStatusRequest: V1SupplyOrderPassStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1SupplyOrderPassStatusResponse>;
/**
* Возвращает количество заявок в конкретном статусе.
* Количество заявок по статусам
*/
supplyOrderAPISupplyOrderStatusCounterRaw(requestParameters: SupplyOrderAPISupplyOrderStatusCounterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1SupplyOrderStatusCounterResponse>>;
/**
* Возвращает количество заявок в конкретном статусе.
* Количество заявок по статусам
*/
supplyOrderAPISupplyOrderStatusCounter(clientId: string, apiKey: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1SupplyOrderStatusCounterResponse>;
/**
* Обновить интервал поставки
*/
supplyOrderAPIUpdateSupplyOrderTimeslotRaw(requestParameters: SupplyOrderAPIUpdateSupplyOrderTimeslotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1UpdateSupplyOrderTimeslotResponse>>;
/**
* Обновить интервал поставки
*/
supplyOrderAPIUpdateSupplyOrderTimeslot(clientId: string, apiKey: string, v1UpdateSupplyOrderTimeslotRequest: V1UpdateSupplyOrderTimeslotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1UpdateSupplyOrderTimeslotResponse>;
/**
* Используйте метод, чтобы получить товарный состав поставки или черновика заявки на поставку. Одним вызовом метода можно получить состав одной поставки или черновика заявки.
* Состав поставки или заявки на поставку
*/
supplyOrderBundleRaw(requestParameters: SupplyOrderBundleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1GetSupplyOrderBundleResponse>>;
/**
* Используйте метод, чтобы получить товарный состав поставки или черновика заявки на поставку. Одним вызовом метода можно получить состав одной поставки или черновика заявки.
* Состав поставки или заявки на поставку
*/
supplyOrderBundle(v1GetSupplyOrderBundleRequest: V1GetSupplyOrderBundleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1GetSupplyOrderBundleResponse>;
/**
* Учитываются заявки с поставкой на конкретный склад и через [виртуальный распределительный центр (вРЦ)](https://seller-edu.ozon.ru/fbo/scheme-of-work/about#чем-отличаются-процессы-при-заявках-через-врц-и-напрямую-на-склад).
* Информация о заявке на поставку
*/
supplyOrderGetRaw(requestParameters: SupplyOrderGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V3SupplyOrderGetResponse>>;
/**
* Учитываются заявки с поставкой на конкретный склад и через [виртуальный распределительный центр (вРЦ)](https://seller-edu.ozon.ru/fbo/scheme-of-work/about#чем-отличаются-процессы-при-заявках-через-врц-и-напрямую-на-склад).
* Информация о заявке на поставку
*/
supplyOrderGet(v3SupplyOrderGetRequest?: V3SupplyOrderGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V3SupplyOrderGetResponse>;
/**
* Учитываются заявки с поставкой на конкретный склад и через [виртуальный распределительный центр (вРЦ)](https://seller-edu.ozon.ru/fbo/scheme-of-work/about#чем-отличаются-процессы-при-заявках-через-врц-и-напрямую-на-склад).
* Список заявок на поставку на склад Ozon
*/
supplyOrderListRaw(requestParameters: SupplyOrderListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V3SupplyOrderListResponse>>;
/**
* Учитываются заявки с поставкой на конкретный склад и через [виртуальный распределительный центр (вРЦ)](https://seller-edu.ozon.ru/fbo/scheme-of-work/about#чем-отличаются-процессы-при-заявках-через-врц-и-напрямую-на-склад).
* Список заявок на поставку на склад Ozon
*/
supplyOrderList(v3SupplyOrderListRequest?: V3SupplyOrderListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V3SupplyOrderListResponse>;
/**
* Получить список доступных интервалов поставки
*/
supplyOrderTimeslotListRaw(requestParameters: SupplyOrderTimeslotListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SupplyOrderV2SupplyOrderTimeslotListResponse>>;
/**
* Получить список доступных интервалов поставки
*/
supplyOrderTimeslotList(clientId: string, apiKey: string, supplyOrderV2SupplyOrderTimeslotListRequest: SupplyOrderV2SupplyOrderTimeslotListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SupplyOrderV2SupplyOrderTimeslotListResponse>;
}