445 lines
21 KiB
TypeScript
445 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 type { V3AdditionalDataItem } from './V3AdditionalDataItem';
|
||
import type { PostingV3FbsPostingDetailSortingCenter } from './PostingV3FbsPostingDetailSortingCenter';
|
||
import type { PostingV3FbsPostingDetailExternalOrder } from './PostingV3FbsPostingDetailExternalOrder';
|
||
import type { V3FbsPostingRequirementsV3 } from './V3FbsPostingRequirementsV3';
|
||
import type { V2FboSinglePostingLegalInfo } from './V2FboSinglePostingLegalInfo';
|
||
import type { V3PostingProductDetail } from './V3PostingProductDetail';
|
||
import type { PostingV4PostingFbsListResponsePostingsTarifficationStep } from './PostingV4PostingFbsListResponsePostingsTarifficationStep';
|
||
import type { FbsPostingDetailCourier } from './FbsPostingDetailCourier';
|
||
import type { V3FbsPostingProductExemplarsV3 } from './V3FbsPostingProductExemplarsV3';
|
||
import type { V3Customer } from './V3Customer';
|
||
import type { V3PostingFinancialData } from './V3PostingFinancialData';
|
||
import type { FbsPostingDetailPrrOption } from './FbsPostingDetailPrrOption';
|
||
import type { V3FbsTariffication } from './V3FbsTariffication';
|
||
import type { V3FbsPostingAnalyticsData } from './V3FbsPostingAnalyticsData';
|
||
import type { V3Barcodes } from './V3Barcodes';
|
||
import type { V3Cancellation } from './V3Cancellation';
|
||
import type { V3FbsPostingDetailOptional } from './V3FbsPostingDetailOptional';
|
||
import type { V3FbsPostingDetailRelatedPostings } from './V3FbsPostingDetailRelatedPostings';
|
||
import type { PostingV4PostingFbsListResponsePostingsContainer } from './PostingV4PostingFbsListResponsePostingsContainer';
|
||
import type { V3Addressee } from './V3Addressee';
|
||
import type { V3DeliveryMethod } from './V3DeliveryMethod';
|
||
/**
|
||
* Информация об отправлении.
|
||
* @export
|
||
* @interface V3FbsPostingDetail
|
||
*/
|
||
export interface V3FbsPostingDetail {
|
||
/**
|
||
*
|
||
* @type {Array<V3AdditionalDataItem>}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
additional_data?: Array<V3AdditionalDataItem>;
|
||
/**
|
||
*
|
||
* @type {V3Addressee}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
addressee?: V3Addressee;
|
||
/**
|
||
*
|
||
* @type {V3FbsPostingAnalyticsData}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
analytics_data?: V3FbsPostingAnalyticsData;
|
||
/**
|
||
* Доступные действия и информация об отправлении:
|
||
* - `arbitration` — открыть спор;
|
||
* - `awaiting_delivery` — перевести в статус «Ожидает отгрузки»;
|
||
* - `can_create_chat` — начать чат с покупателем;
|
||
* - `cancel` — отменить отправление;
|
||
* - `click_track_number` — просмотреть по трек-номеру историю изменения статусов в личном кабинете;
|
||
* - `customer_phone_available` — телефон покупателя;
|
||
* - `has_weight_products` — весовые товары в отправлении;
|
||
* - `hide_region_and_city` — скрыть регион и город покупателя в отчёте;
|
||
* - `invoice_get` — получить информацию из счёта-фактуры;
|
||
* - `invoice_send` — создать счёт-фактуру;
|
||
* - `invoice_update` — отредактировать счёт-фактуру;
|
||
* - `label_download_big` — скачать большую этикетку;
|
||
* - `label_download_small` — скачать маленькую этикетку;
|
||
* - `label_download` — скачать этикетку;
|
||
* - `non_int_delivered` — перевести в статус «Условно доставлен»;
|
||
* - `non_int_delivering` — перевести в статус «Доставляется»;
|
||
* - `non_int_last_mile` — перевести в статус «Курьер в пути»;
|
||
* - `product_cancel` — отменить часть товаров в отправлении;
|
||
* - `set_cutoff` — необходимо указать дату отгрузки, воспользуйтесь методом [/v1/posting/cutoff/set](#operation/PostingAPI_SetPostingCutoff);
|
||
* - `set_timeslot` — изменить время доставки покупателю;
|
||
* - `set_track_number` — указать или изменить трек-номер;
|
||
* - `ship_async_in_process` — отправление собирается;
|
||
* - `ship_async_retry` — собрать отправление повторно после ошибки сборки;
|
||
* - `ship_async` — собрать отправление;
|
||
* - `ship_with_additional_info` — необходимо заполнить дополнительную информацию;
|
||
* - `ship` — собрать отправление;
|
||
* - `update_cis` — изменить дополнительную информацию.
|
||
*
|
||
* @type {Array<string>}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
available_actions?: Array<string>;
|
||
/**
|
||
*
|
||
* @type {V3Barcodes}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
barcodes?: V3Barcodes;
|
||
/**
|
||
*
|
||
* @type {V3Cancellation}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
cancellation?: V3Cancellation;
|
||
/**
|
||
*
|
||
* @type {FbsPostingDetailCourier}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
courier?: FbsPostingDetailCourier;
|
||
/**
|
||
*
|
||
* @type {V3Customer}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
customer?: V3Customer;
|
||
/**
|
||
*
|
||
* @type {PostingV4PostingFbsListResponsePostingsContainer}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
container?: PostingV4PostingFbsListResponsePostingsContainer;
|
||
/**
|
||
* Тип сортировки грузоместа:
|
||
* - `SORT` — сортируемый;
|
||
* - `NON-SORT` — несортируемый.
|
||
*
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
container_sort_type?: string;
|
||
/**
|
||
* Дата передачи отправления в доставку.
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
delivering_date?: string;
|
||
/**
|
||
*
|
||
* @type {V3DeliveryMethod}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
delivery_method?: V3DeliveryMethod;
|
||
/**
|
||
* Стоимость доставки.
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
delivery_price?: string;
|
||
/**
|
||
*
|
||
* @type {PostingV3FbsPostingDetailExternalOrder}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
external_order?: PostingV3FbsPostingDetailExternalOrder;
|
||
/**
|
||
* Дата фактической передачи отправления в доставку.
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
fact_delivery_date?: string;
|
||
/**
|
||
*
|
||
* @type {V3PostingFinancialData}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
financial_data?: V3PostingFinancialData;
|
||
/**
|
||
* Дата и время начала обработки отправления.
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
in_process_at?: string;
|
||
/**
|
||
* Процесс обработки отправления:
|
||
* - `ozon` — доставка силами Ozon;
|
||
* - `aggregator` — доставка внешней службой, Ozon регистрирует заказ;
|
||
* - `non_integrated` — доставка силами продавца;
|
||
* - `3pl_tracking` — доставка внешней службой, продавец регистрирует заказ;
|
||
* - `hybrid` — гибридная интеграция;
|
||
* - `hybrid_aggregator` — гибридная интеграция с доставкой внешней службой, Ozon регистрирует заказ;
|
||
* - `hybrid_non_integrated` — гибридная интеграция с доставкой силами продавца;
|
||
* - `hybrid_3pl_tracking` — гибридная интеграция с доставкой внешней службой, продавец регистрирует заказ;
|
||
* - `click_and_collect` — бронирование в магазине партнёра;
|
||
* - `FBP` — доставка с партнёрских складов Ozon.
|
||
*
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
integration_type_flow?: string;
|
||
/**
|
||
* Если использовалась быстрая доставка Ozon Express — `true`.
|
||
* @type {boolean}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
is_express?: boolean;
|
||
/**
|
||
* Признак, что в отправлении есть многокоробочный товар и нужно передать количество коробок для него:
|
||
*
|
||
* - `true` — до сборки передайте количество коробок через метод [/v3/posting/multiboxqty/set](#operation/PostingAPI_PostingMultiBoxQtySetV3).
|
||
* - `false` — отправление собрано с указанием количества коробок в параметре `multi_box_qty` или в отправлении нет многокоробочного товара.
|
||
*
|
||
* @type {boolean}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
is_multibox?: boolean;
|
||
/**
|
||
*
|
||
* @type {V2FboSinglePostingLegalInfo}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
legal_info?: V2FboSinglePostingLegalInfo;
|
||
/**
|
||
* Количество коробок, в которые упакован товар.
|
||
* @type {number}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
multi_box_qty?: number;
|
||
/**
|
||
*
|
||
* @type {V3FbsPostingDetailOptional}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
optional?: V3FbsPostingDetailOptional;
|
||
/**
|
||
* Идентификатор заказа, к которому относится отправление.
|
||
* @type {number}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
order_id?: number;
|
||
/**
|
||
* Номер заказа, к которому относится отправление.
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
order_number?: string;
|
||
/**
|
||
* Номер родительского отправления, в результате разделения которого появилось текущее.
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
parent_posting_number?: string;
|
||
/**
|
||
* Дата и время успешной валидации кода курьера. Чтобы проверить код курьера, воспользуйтесь методом [/v1/posting/fbs/pick-up-code/verify](#operation/PostingAPI_PostingFBSPickupCodeVerify).
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
pickup_code_verified_at?: string;
|
||
/**
|
||
* Номер отправления.
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
posting_number?: string;
|
||
/**
|
||
*
|
||
* @type {V3FbsPostingProductExemplarsV3}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
product_exemplars?: V3FbsPostingProductExemplarsV3;
|
||
/**
|
||
* Массив товаров в отправлении.
|
||
* @type {Array<V3PostingProductDetail>}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
products?: Array<V3PostingProductDetail>;
|
||
/**
|
||
* Статус службы доставки.
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
provider_status?: string;
|
||
/**
|
||
*
|
||
* @type {FbsPostingDetailPrrOption}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
prr_option?: FbsPostingDetailPrrOption;
|
||
/**
|
||
*
|
||
* @type {V3FbsPostingDetailRelatedPostings}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
related_postings?: V3FbsPostingDetailRelatedPostings;
|
||
/**
|
||
* Список номеров связанных весовых отправлений.
|
||
* @type {Array<string>}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
related_weight_postings?: Array<string>;
|
||
/**
|
||
* `true`, если нужно заполнить атрибуты прослеживаемости.
|
||
*
|
||
* @type {boolean}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
require_blr_traceable_attrs?: boolean;
|
||
/**
|
||
*
|
||
* @type {V3FbsPostingRequirementsV3}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
requirements?: V3FbsPostingRequirementsV3;
|
||
/**
|
||
* Дата и время, до которой необходимо собрать отправление. Показываем рекомендованное время отгрузки. По истечении этого времени начнёт применяться новый тариф, информацию о нём уточняйте в поле `tariffication`.
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
shipment_date?: string;
|
||
/**
|
||
* Дата и время отгрузки без просрочки.
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
shipment_date_without_delay?: string;
|
||
/**
|
||
*
|
||
* @type {PostingV3FbsPostingDetailSortingCenter}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
sorting_center?: PostingV3FbsPostingDetailSortingCenter;
|
||
/**
|
||
* Статус отправления:
|
||
* - `acceptance_in_progress` — идёт приёмка,
|
||
* - `arbitration` — арбитраж,
|
||
* - `awaiting_approve` — ожидает подтверждения,
|
||
* - `awaiting_deliver` — ожидает отгрузки,
|
||
* - `awaiting_packaging` — ожидает упаковки,
|
||
* - `awaiting_registration` — ожидает регистрации,
|
||
* - `awaiting_verification` — создано,
|
||
* - `cancelled` — отменено,
|
||
* - `cancelled_from_split_pending` — отменён из-за разделения отправления,
|
||
* - `client_arbitration` — клиентский арбитраж доставки,
|
||
* - `delivered` — доставлено,
|
||
* - `delivering` — доставляется,
|
||
* - `driver_pickup` — у водителя,
|
||
* - `not_accepted` — не принят на сортировочном центре,
|
||
*
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
status?: string;
|
||
/**
|
||
* Подстатус отправления:
|
||
* - `posting_acceptance_in_progress` — идёт приёмка,
|
||
* - `posting_in_arbitration` — арбитраж,
|
||
* - `posting_created` — создано,
|
||
* - `posting_in_carriage` — в перевозке,
|
||
* - `posting_not_in_carriage` — не добавлено в перевозку,
|
||
* - `posting_registered` — зарегистрировано,
|
||
* - `posting_transferring_to_delivery` (`status=awaiting_deliver`) — передаётся в доставку,
|
||
* - `posting_awaiting_passport_data` — ожидает паспортных данных,
|
||
* - `posting_created` — создано,
|
||
* - `posting_awaiting_registration` — ожидает регистрации,
|
||
* - `posting_registration_error` — ошибка регистрации,
|
||
* - `posting_transferring_to_delivery` (`status=awaiting_registration`) — передаётся курьеру,
|
||
* - `posting_split_pending` — создано,
|
||
* - `posting_canceled` — отменено,
|
||
* - `posting_in_client_arbitration` — клиентский арбитраж доставки,
|
||
* - `posting_delivered` — доставлено,
|
||
* - `posting_received` — получено,
|
||
* - `posting_conditionally_delivered` — условно доставлено,
|
||
* - `posting_in_courier_service` — курьер в пути,
|
||
* - `posting_in_pickup_point` — в пункте выдачи,
|
||
* - `posting_on_way_to_city` — в пути в ваш город,
|
||
* - `posting_on_way_to_pickup_point` — в пути в пункт выдачи,
|
||
* - `posting_returned_to_warehouse` — возвращено на склад,
|
||
* - `posting_transferred_to_courier_service` — передаётся в службу доставки,
|
||
* - `posting_driver_pick_up` — у водителя,
|
||
* - `posting_not_in_sort_center` — не принято на сортировочном центре,
|
||
* - `ship_failed` — сборка не удалась.
|
||
*
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
substatus?: string;
|
||
/**
|
||
* Предыдущий подстатус отправления. Возможные значения:
|
||
* - `posting_acceptance_in_progress` — идёт приёмка,
|
||
* - `posting_in_arbitration` — арбитраж,
|
||
* - `posting_created` — создано,
|
||
* - `posting_in_carriage` — в перевозке,
|
||
* - `posting_not_in_carriage` — не добавлено в перевозку,
|
||
* - `posting_registered` — зарегистрировано,
|
||
* - `posting_transferring_to_delivery` (`status=awaiting_deliver`) — передаётся в доставку,
|
||
* - `posting_awaiting_passport_data` — ожидает паспортных данных,
|
||
* - `posting_created` — создано,
|
||
* - `posting_awaiting_registration` — ожидает регистрации,
|
||
* - `posting_registration_error` — ошибка регистрации,
|
||
* - `posting_transferring_to_delivery` (`status=awaiting_registration`) — передаётся курьеру,
|
||
* - `posting_split_pending` — создано,
|
||
* - `posting_canceled` — отменено,
|
||
* - `posting_in_client_arbitration` — клиентский арбитраж доставки,
|
||
* - `posting_delivered` — доставлено,
|
||
* - `posting_received` — получено,
|
||
* - `posting_conditionally_delivered` — условно доставлено,
|
||
* - `posting_in_courier_service` — курьер в пути,
|
||
* - `posting_in_pickup_point` — в пункте выдачи,
|
||
* - `posting_on_way_to_city` — в пути в ваш город,
|
||
* - `posting_on_way_to_pickup_point` — в пути в пункт выдачи,
|
||
* - `posting_returned_to_warehouse` — возвращено на склад,
|
||
* - `posting_transferred_to_courier_service` — передаётся в службу доставки,
|
||
* - `posting_driver_pick_up` — у водителя,
|
||
* - `posting_not_in_sort_center` — не принято на сортировочном центре.
|
||
*
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
previous_substatus?: string;
|
||
/**
|
||
* Тип интеграции со службой доставки:
|
||
* - `ozon` — доставка через Ozon логистику.
|
||
* - `aggregator` — доставка внешней службой, Ozon регистрирует заказ.
|
||
* - `3pl_tracking` — доставка внешней службой, продавец регистрирует заказ.
|
||
* - `non_integrated` — доставка силами продавца.
|
||
*
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
tpl_integration_type?: string;
|
||
/**
|
||
* Трек-номер отправления.
|
||
* @type {string}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
tracking_number?: string;
|
||
/**
|
||
*
|
||
* @type {V3FbsTariffication}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
tariffication?: V3FbsTariffication;
|
||
/**
|
||
* Этапы тарификации.
|
||
* @type {Array<PostingV4PostingFbsListResponsePostingsTarifficationStep>}
|
||
* @memberof V3FbsPostingDetail
|
||
*/
|
||
tariffication_steps?: Array<PostingV4PostingFbsListResponsePostingsTarifficationStep>;
|
||
}
|
||
/**
|
||
* Check if a given object implements the V3FbsPostingDetail interface.
|
||
*/
|
||
export declare function instanceOfV3FbsPostingDetail(value: object): value is V3FbsPostingDetail;
|
||
export declare function V3FbsPostingDetailFromJSON(json: any): V3FbsPostingDetail;
|
||
export declare function V3FbsPostingDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): V3FbsPostingDetail;
|
||
export declare function V3FbsPostingDetailToJSON(value?: V3FbsPostingDetail | null): any;
|