release 0.1.0
This commit is contained in:
apilki
123
dist/apis/FBSrFBSMarks.d.ts
vendored
Normal file
123
dist/apis/FBSrFBSMarks.d.ts
vendored
Normal file
@@ -0,0 +1,123 @@
|
||||
/**
|
||||
* Документация 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 { Fbsv4FbsPostingShipV4Request, Fbsv4FbsPostingShipV4Response, V1FbsPostingProductExemplarUpdateRequest, V4FbsPostingShipPackageV4Request, V4FbsPostingShipPackageV4Response, V5FbsPostingProductExemplarStatusV5Request, V5FbsPostingProductExemplarStatusV5Response, V5FbsPostingProductExemplarValidateV5Request, V5FbsPostingProductExemplarValidateV5Response, V6FbsPostingProductExemplarCreateOrGetV6Request, V6FbsPostingProductExemplarCreateOrGetV6Response, V6FbsPostingProductExemplarSetV6Request } from '../models/index';
|
||||
export interface PostingAPIFbsPostingProductExemplarCreateOrGetV6Request {
|
||||
clientId: string;
|
||||
apiKey: string;
|
||||
v6FbsPostingProductExemplarCreateOrGetV6Request: V6FbsPostingProductExemplarCreateOrGetV6Request;
|
||||
}
|
||||
export interface PostingAPIFbsPostingProductExemplarSetV6Request {
|
||||
clientId: string;
|
||||
apiKey: string;
|
||||
v6FbsPostingProductExemplarSetV6Request: V6FbsPostingProductExemplarSetV6Request;
|
||||
}
|
||||
export interface PostingAPIFbsPostingProductExemplarStatusV5Request {
|
||||
clientId: string;
|
||||
apiKey: string;
|
||||
v5FbsPostingProductExemplarStatusV5Request: V5FbsPostingProductExemplarStatusV5Request;
|
||||
}
|
||||
export interface PostingAPIFbsPostingProductExemplarUpdateRequest {
|
||||
clientId: string;
|
||||
apiKey: string;
|
||||
v1FbsPostingProductExemplarUpdateRequest: V1FbsPostingProductExemplarUpdateRequest;
|
||||
}
|
||||
export interface PostingAPIFbsPostingProductExemplarValidateV5Request {
|
||||
clientId: string;
|
||||
apiKey: string;
|
||||
v5FbsPostingProductExemplarValidateV5Request: V5FbsPostingProductExemplarValidateV5Request;
|
||||
}
|
||||
export interface PostingAPIShipFbsPostingPackageRequest {
|
||||
clientId: string;
|
||||
apiKey: string;
|
||||
v4FbsPostingShipPackageV4Request: V4FbsPostingShipPackageV4Request;
|
||||
}
|
||||
export interface PostingAPIShipFbsPostingV4Request {
|
||||
clientId: string;
|
||||
apiKey: string;
|
||||
fbsv4FbsPostingShipV4Request: Fbsv4FbsPostingShipV4Request;
|
||||
}
|
||||
/**
|
||||
*
|
||||
*/
|
||||
export declare class FBSrFBSMarks extends runtime.BaseAPI {
|
||||
/**
|
||||
* Метод для получения информации по экземплярам товаров из отправления, переданных в методе [/v6/fbs/posting/product/exemplar/set](#operation/PostingAPI_FbsPostingProductExemplarSetV6). Используйте метод для получения `exemplar_id`.
|
||||
* Получить данные созданных экземпляров
|
||||
*/
|
||||
postingAPIFbsPostingProductExemplarCreateOrGetV6Raw(requestParameters: PostingAPIFbsPostingProductExemplarCreateOrGetV6Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V6FbsPostingProductExemplarCreateOrGetV6Response>>;
|
||||
/**
|
||||
* Метод для получения информации по экземплярам товаров из отправления, переданных в методе [/v6/fbs/posting/product/exemplar/set](#operation/PostingAPI_FbsPostingProductExemplarSetV6). Используйте метод для получения `exemplar_id`.
|
||||
* Получить данные созданных экземпляров
|
||||
*/
|
||||
postingAPIFbsPostingProductExemplarCreateOrGetV6(clientId: string, apiKey: string, v6FbsPostingProductExemplarCreateOrGetV6Request: V6FbsPostingProductExemplarCreateOrGetV6Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V6FbsPostingProductExemplarCreateOrGetV6Response>;
|
||||
/**
|
||||
* Асинхронный метод: - для проверки наличия экземпляров в обороте в системе «Честный ЗНАК»; - для сохранения данных экземпляров. Чтобы получить результаты проверок, используйте метод [/v5/fbs/posting/product/exemplar/status](#operation/PostingAPI_FbsPostingProductExemplarStatusV5). Для получения данных о созданных экземплярах, используйте метод [/v6/fbs/posting/product/exemplar/create-or-get](#operation/PostingAPI_FbsPostingProductExemplarCreateOrGetV6). Если у вас несколько одинаковых товаров в отправлении, укажите один `product_id` и массив `exemplars` для каждого товара из отправления. Всегда передавайте полный набор данных по экземплярам и продуктам. Например, в вашей системе 10 экземпляров. Вы передали их для проверки и сохранения. Потом добавили в своей системе ещё 60 экземпляров. При повторной передаче экземпляров для проверки и сохранения укажите все экземпляры: и старые, и только что добавленные. Код ответа 200 не гарантирует, что данные об экземплярах приняты. Он указывает, что создана задача для добавления информации. Чтобы проверить статус задачи, используйте метод [/v5/fbs/posting/product/exemplar/status](#operation/PostingAPI_FbsPostingProductExemplarStatusV5).
|
||||
* Проверить и сохранить данные экземпляров
|
||||
*/
|
||||
postingAPIFbsPostingProductExemplarSetV6Raw(requestParameters: PostingAPIFbsPostingProductExemplarSetV6Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
||||
/**
|
||||
* Асинхронный метод: - для проверки наличия экземпляров в обороте в системе «Честный ЗНАК»; - для сохранения данных экземпляров. Чтобы получить результаты проверок, используйте метод [/v5/fbs/posting/product/exemplar/status](#operation/PostingAPI_FbsPostingProductExemplarStatusV5). Для получения данных о созданных экземплярах, используйте метод [/v6/fbs/posting/product/exemplar/create-or-get](#operation/PostingAPI_FbsPostingProductExemplarCreateOrGetV6). Если у вас несколько одинаковых товаров в отправлении, укажите один `product_id` и массив `exemplars` для каждого товара из отправления. Всегда передавайте полный набор данных по экземплярам и продуктам. Например, в вашей системе 10 экземпляров. Вы передали их для проверки и сохранения. Потом добавили в своей системе ещё 60 экземпляров. При повторной передаче экземпляров для проверки и сохранения укажите все экземпляры: и старые, и только что добавленные. Код ответа 200 не гарантирует, что данные об экземплярах приняты. Он указывает, что создана задача для добавления информации. Чтобы проверить статус задачи, используйте метод [/v5/fbs/posting/product/exemplar/status](#operation/PostingAPI_FbsPostingProductExemplarStatusV5).
|
||||
* Проверить и сохранить данные экземпляров
|
||||
*/
|
||||
postingAPIFbsPostingProductExemplarSetV6(clientId: string, apiKey: string, v6FbsPostingProductExemplarSetV6Request: V6FbsPostingProductExemplarSetV6Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
||||
/**
|
||||
* Метод для получения статусов добавления экземпляров, переданных в методе [/v6/fbs/posting/product/exemplar/set](#operation/PostingAPI_FbsPostingProductExemplarSetV6). Также возвращает данные по этим экземплярам.
|
||||
* Получить статус добавления экземпляров
|
||||
*/
|
||||
postingAPIFbsPostingProductExemplarStatusV5Raw(requestParameters: PostingAPIFbsPostingProductExemplarStatusV5Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V5FbsPostingProductExemplarStatusV5Response>>;
|
||||
/**
|
||||
* Метод для получения статусов добавления экземпляров, переданных в методе [/v6/fbs/posting/product/exemplar/set](#operation/PostingAPI_FbsPostingProductExemplarSetV6). Также возвращает данные по этим экземплярам.
|
||||
* Получить статус добавления экземпляров
|
||||
*/
|
||||
postingAPIFbsPostingProductExemplarStatusV5(clientId: string, apiKey: string, v5FbsPostingProductExemplarStatusV5Request: V5FbsPostingProductExemplarStatusV5Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V5FbsPostingProductExemplarStatusV5Response>;
|
||||
/**
|
||||
* Используйте метод после передачи информации по экземплярам методом [/v6/fbs/posting/product/exemplar/set](#operation/PostingAPI_FbsPostingProductExemplarSetV6), чтобы сохранить обновлённые данные по экземплярам для отправлений в статусе «Ожидает отгрузки».
|
||||
* Обновить данные экземпляров
|
||||
*/
|
||||
postingAPIFbsPostingProductExemplarUpdateRaw(requestParameters: PostingAPIFbsPostingProductExemplarUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
||||
/**
|
||||
* Используйте метод после передачи информации по экземплярам методом [/v6/fbs/posting/product/exemplar/set](#operation/PostingAPI_FbsPostingProductExemplarSetV6), чтобы сохранить обновлённые данные по экземплярам для отправлений в статусе «Ожидает отгрузки».
|
||||
* Обновить данные экземпляров
|
||||
*/
|
||||
postingAPIFbsPostingProductExemplarUpdate(clientId: string, apiKey: string, v1FbsPostingProductExemplarUpdateRequest: V1FbsPostingProductExemplarUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
||||
/**
|
||||
* Метод для проверки кодов на соответствие требованиям системы «Честный ЗНАК» по количеству и составу символов, а также других маркировок. Если у вас нет номера грузовой таможенной декларации (ГТД), вы можете его не указывать.
|
||||
* Валидация кодов маркировки
|
||||
*/
|
||||
postingAPIFbsPostingProductExemplarValidateV5Raw(requestParameters: PostingAPIFbsPostingProductExemplarValidateV5Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V5FbsPostingProductExemplarValidateV5Response>>;
|
||||
/**
|
||||
* Метод для проверки кодов на соответствие требованиям системы «Честный ЗНАК» по количеству и составу символов, а также других маркировок. Если у вас нет номера грузовой таможенной декларации (ГТД), вы можете его не указывать.
|
||||
* Валидация кодов маркировки
|
||||
*/
|
||||
postingAPIFbsPostingProductExemplarValidateV5(clientId: string, apiKey: string, v5FbsPostingProductExemplarValidateV5Request: V5FbsPostingProductExemplarValidateV5Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V5FbsPostingProductExemplarValidateV5Response>;
|
||||
/**
|
||||
* <aside class=\"warning\"> Ответ с кодом <tt>200</tt> не гарантирует успешную сборку отправления. Используйте метод <a href=\"#operation/PostingAPI_GetFbsPostingV3\">/v3/posting/fbs/get</a>, чтобы проверить, что отправление собрано. Если в ответе указан <tt>result.substatus = ship_failed</tt>, повторите сборку отправления. </aside> Если в запросе передать часть товаров из отправления, метод разделит первичное отправление на две части. В первичном несобранном отправлении останется часть товаров, которую не передали в запросе. По умолчанию статус созданных отправлений `awaiting_packaging` — ожидает сборки. Статус изначального отправления изменится только после изменения статуса отправлений, на которые он разделился.
|
||||
* Частичная сборка отправления (версия 4)
|
||||
*/
|
||||
postingAPIShipFbsPostingPackageRaw(requestParameters: PostingAPIShipFbsPostingPackageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4FbsPostingShipPackageV4Response>>;
|
||||
/**
|
||||
* <aside class=\"warning\"> Ответ с кодом <tt>200</tt> не гарантирует успешную сборку отправления. Используйте метод <a href=\"#operation/PostingAPI_GetFbsPostingV3\">/v3/posting/fbs/get</a>, чтобы проверить, что отправление собрано. Если в ответе указан <tt>result.substatus = ship_failed</tt>, повторите сборку отправления. </aside> Если в запросе передать часть товаров из отправления, метод разделит первичное отправление на две части. В первичном несобранном отправлении останется часть товаров, которую не передали в запросе. По умолчанию статус созданных отправлений `awaiting_packaging` — ожидает сборки. Статус изначального отправления изменится только после изменения статуса отправлений, на которые он разделился.
|
||||
* Частичная сборка отправления (версия 4)
|
||||
*/
|
||||
postingAPIShipFbsPostingPackage(clientId: string, apiKey: string, v4FbsPostingShipPackageV4Request: V4FbsPostingShipPackageV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4FbsPostingShipPackageV4Response>;
|
||||
/**
|
||||
* <aside class=\"warning\"> Ответ с кодом <tt>200</tt> не гарантирует успешную сборку заказа. Используйте метод <a href=\"#operation/PostingAPI_GetFbsPostingV3\">/v3/posting/fbs/get</a>, чтобы проверить, что заказ собран. Если в ответе указан <tt>result.substatus = ship_failed</tt>, повторите сборку заказа. </aside> Делит заказ на отправления и переводит его в статус `awaiting_deliver`. Каждый элемент в `packages` может содержать несколько элементов `products` или отправлений. Каждый элемент в `products` — это товар, включённый в данное отправление. Разделить заказ нужно, если: - товары не помещаются в одну упаковку, - товары нельзя сложить в одну упаковку. Чтобы разделить заказ, передайте в массиве `packages` несколько объектов. Пример запроса, когда заказ разделять не нужно: 2 товара будут в одном отправлении. ``` { \"packages\": [ { \"products\": [ { \"product_id\": 185479045, \"quantity\": 2 } ] } ], \"posting_number\": \"89491381-0072-1\" } ``` Пример запроса, когда заказ нужно разделить: каждый товар будет в отдельном отправлении. ``` { \"packages\": [ { \"products\": [ { \"product_id\": 185479045, \"quantity\": 1 } ] }, { \"products\": [ { \"product_id\": 185479045, \"quantity\": 1 } ] } ], \"posting_number\": \"89491381-0072-1\" } ``` Чтобы внести информацию по экземплярам, используйте метод [/v6/fbs/posting/product/exemplar/set](#operation/PostingAPI_FbsPostingProductExemplarSetV6).
|
||||
* Собрать заказ (версия 4)
|
||||
*/
|
||||
postingAPIShipFbsPostingV4Raw(requestParameters: PostingAPIShipFbsPostingV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Fbsv4FbsPostingShipV4Response>>;
|
||||
/**
|
||||
* <aside class=\"warning\"> Ответ с кодом <tt>200</tt> не гарантирует успешную сборку заказа. Используйте метод <a href=\"#operation/PostingAPI_GetFbsPostingV3\">/v3/posting/fbs/get</a>, чтобы проверить, что заказ собран. Если в ответе указан <tt>result.substatus = ship_failed</tt>, повторите сборку заказа. </aside> Делит заказ на отправления и переводит его в статус `awaiting_deliver`. Каждый элемент в `packages` может содержать несколько элементов `products` или отправлений. Каждый элемент в `products` — это товар, включённый в данное отправление. Разделить заказ нужно, если: - товары не помещаются в одну упаковку, - товары нельзя сложить в одну упаковку. Чтобы разделить заказ, передайте в массиве `packages` несколько объектов. Пример запроса, когда заказ разделять не нужно: 2 товара будут в одном отправлении. ``` { \"packages\": [ { \"products\": [ { \"product_id\": 185479045, \"quantity\": 2 } ] } ], \"posting_number\": \"89491381-0072-1\" } ``` Пример запроса, когда заказ нужно разделить: каждый товар будет в отдельном отправлении. ``` { \"packages\": [ { \"products\": [ { \"product_id\": 185479045, \"quantity\": 1 } ] }, { \"products\": [ { \"product_id\": 185479045, \"quantity\": 1 } ] } ], \"posting_number\": \"89491381-0072-1\" } ``` Чтобы внести информацию по экземплярам, используйте метод [/v6/fbs/posting/product/exemplar/set](#operation/PostingAPI_FbsPostingProductExemplarSetV6).
|
||||
* Собрать заказ (версия 4)
|
||||
*/
|
||||
postingAPIShipFbsPostingV4(clientId: string, apiKey: string, fbsv4FbsPostingShipV4Request: Fbsv4FbsPostingShipV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Fbsv4FbsPostingShipV4Response>;
|
||||
}
|
||||
Reference in New Issue
Block a user