Monolith-api

Operations
cart-controller-api-v-2
Получить сгруппированную корзину
GET /api/v2/cart

Возвращает Текущую корзину со всем содержимым в сгруппированном виде.

Request parameters

cartRequest
CartRequest required

Responses

200 200

OK

400 400

Bad Request

Body
*/*
401 401

Unauthorized

Body
*/*
403 403

Forbidden

Body
*/*
404 404

Not Found

Body
*/*
422 422

Unprocessable Entity

Body
*/*
500 500

Internal Server Error

Body
*/*
Очистить корзину
DELETE /api/v2/cart

Очищает корзину и возвращает ее текущее (пустое) содержимое.

Request parameters

currencyCode
string optional

Код валюты

Responses

200 200

OK

400 400

Bad Request

Body
*/*
401 401

Unauthorized

Body
*/*
403 403

Forbidden

Body
*/*
404 404

Not Found

Body
*/*
422 422

Unprocessable Entity

Body
*/*
500 500

Internal Server Error

Body
*/*
Добавить позицию в корзину
PUT /api/v2/cart/items

Добавляет позицию в корзину и возвращает текущее содержимое корзины.

Request parameters

productId
integer int64 required

id товара

sizeId
integer int64 required

Id размера товара

count
integer int32 required

Количество

currencyCode
string optional

Код валюты

showSoldWithSimilar
boolean optional
countryId
integer int64 optional

id страны

groupByPickupAddress
boolean optional

Responses

200 200

OK

400 400

Bad Request

401 401

Unauthorized

Body
*/*
403 403

Forbidden

Body
*/*
404 404

Not Found

Body
*/*
422 422

Unprocessable Entity

Body
*/*
500 500

Internal Server Error

Body
*/*
Удалить позицию из корзины
DELETE /api/v2/cart/items/{orderPositionId}

Удаляет позицию из корзины и отправляет товар в избранное (только для авторизованного пользователя) Возвращает обновленную корзину в ответ

Path variables

orderPositionId
integer int64 required

Request parameters

currencyCode
string optional
showSoldWithSimilar
boolean optional
countryId
integer int64 optional
groupByPickupAddress
boolean optional

Responses

200 200

OK

400 400

Bad Request

Body
*/*
401 401

Unauthorized

Body
*/*
403 403

Forbidden

Body
*/*
404 404

Not Found

Body
*/*
422 422

Unprocessable Entity

Body
*/*
500 500

Internal Server Error

Body
*/*
Проверить промокод
GET /api/v2/cart/checkPromoCode

Проверить валидность промокода для позиций конкретного продавца и в случае удачи вернуть виртуальный подзаказ с примененным промокодом Если промокод недопустим, то плюет исключение

Request parameters

sellerId
integer int64 required

id продавца

promoCode
string required

Промокод

currencyCode
string optional

Код валюты

Responses

200 200

OK

400 400

Bad Request

Body
*/*
401 401

Unauthorized

Body
*/*
403 403

Forbidden

Body
*/*
404 404

Not Found

Body
*/*
422 422

Unprocessable Entity

Body
*/*
500 500

Internal Server Error

Body
*/*
Оформить заказ
POST /api/v2/cart/holdv2

Оформить заказ для авторизованного пользователя по конкретному продавцу

Request parameters

sellerId
integer int64 required

Id продавца

pickupAddressEndpointId
integer int64 optional
promoCode
string required

Промокод

paymentBuyerCounterpartyId
integer int64 required
fromMobile
boolean optional
currencyCode
string optional

Код валюты

paymentSystem
string optional
type
string optional
totalBonusesAmount
number optional
countryId
integer int64 optional

Id страны

Responses

200 200

OK

400 400

Bad Request

Body
*/*
401 401

Unauthorized

Body
*/*
403 403

Forbidden

Body
*/*
404 404

Not Found

Body
*/*
422 422

Unprocessable Entity

Body
*/*
500 500

Internal Server Error

Body
*/*
Type Definitions
OrderDTO

Заказ

Object
id
integer int64

Id заказа

items

Вещи в корзине

discount

Скидка

comment
string

Необязательный комментарий покупателя к заказу.

seller

Продавец, в тех случаях, когда позиции группируются по продавцам

buyer

Покупатель

state
string

Статус заказа

Enumeration:
CREATED

Новый

CANCELED

Отменен

HOLD_PROCESSING

Платеж выполняется

HOLD_ERROR

Ошибка при оплате

HOLD

Средства на оплату успешно зарезервированы

HOLD_COMPLETED

Оплачен успешно

HOLD_COMPLETE_REJECTED

Деньги расхолдировались

REFUND

Возврат средств

MONEY_TRANSFERRED

Деньги на банковском счете

MONEY_PAYMENT_ERROR

Ошибка перевода денег продавцу

MONEY_PAYMENT_NOT_ENOUGH

Недостаточно денег на счету

MONEY_PAYMENT_TECHNICAL_ERROR

Техническая ошибка банка

MONEY_PAYMENT_WAIT

Ожидаем перевод денег продавцу

SELLER_PAID

Оплатили продавцу

COMPLETED

Заказ завершен

RETURN

Возвращение заказа

DELETED

Удален

orderStateTitle
string

Русский заголовок стейта заказа

orderStateSuccess
boolean

Успешность стейта заказа (false - красный, true - зеленый)

orderStateIcon
string

Иконка стейта заказа

stateTime
integer int64

Время установления статуса заказа в секундах

orderStatus
string

Статус заказа (сущность, отличная от State)

Enumeration:
UNDEFINED
UNCOMPLETED
ORDER_CANT_CONFIRM_NO_SELLER_ADDRESS

Заказ не может быть подтвержен, нет адреса

ORDER_CONFIRMING

Заказ подтверждается продавцом

ORDER_REFUND

Возврат средств

ORDER_CONFIRMED

Продажа подтверждена (неопознанный адрес)

CONCIERGE_ITEMS_WAITING_CONFIRMATION

Заказ подтверждается консьержем

SELLER_IN_MOSCOW

Товар в Москве (выбор способа доставки)

EXPECTING_COURIER_TO_SELLER

Ожидаем курьера для забора товара у продавца

OURSELVES_PICKING_UP_FROM_SELLER

Забираем сами у продавца

OURSELVES_FROM_SELLER_TO_OFFICE

Сами везем товар от продавца в офис

LOGIST_ON_WAY_TO_SELLER

Логист в пути к продавцу

FROM_SELLER_TO_OFFICE

Логист везет товар от продавца в офис

HAS_CONCIERGE_ITEMS

Консьерж везет товар в офис

EXPERTISE_START

Экспертиза началась

EXPERTISE_COMPLETED

Экспертиза завершена

CHOOSING_DELIVERY_METHOD_O2B

Выбор способа доставки

HOLD_COMPLETE_REJECTED

Деньги расхолдировались

EXPECTING_COURIER_TO_BUYER

Ожидаем курьера для доставки покупателю

LOGIST_ON_WAY_TO_BUYER

Курьер в пути к покупателю

BUYER_IN_MOSCOW

Товар в Москве (выбор способа доставки)

OURSELVES_DELIVERY_TO_BUYER

Доставляем покупателю сами

OURSELVES_FROM_OFFICE_TO_BUYER

В пути к покупателю сами

ORDER_DELIVERED

Заказ доставлен

HAS_DISPUTE

Есть спор

ORDER_IN_BOUTIQUE

Товар в бутике

ORDER_SOLD_IN_BOUTIQUE

Продано в бутике

EXPECTING_CONFIRM_AGENT_REPORT

Ожидаем подтверждение отчета о продаже

WAIT_PAYMENT_MONEY_TO_SELLER

Отчет подтвержден, ожидает зачисления

ORDER_COMPLETED

Заказ завершен (деньги выплачены)

ORDER_COMPLETED_RETURN

Заказ завершен (возврат)

RETURN_CREATED

Подана заявка на возврат

RETURN_ON_WAY_TO_OFFICE

В пути в офис

RETURN_EXPERTISE

Экспертиза

RETURN_COMPLETED

Возврат завершен

BOUTIQUE_ORDER_ON_WAY_TO_OFFICE

Заказы в пути в офис

BOUTIQUE_ORDER_ON_EXPERTISE

Заказы на экспертизе

BOUTIQUE_ORDER_ON_WAY_TO_BOUTIQUE

Заказы в пути в бутик

BOUTIQUE_ORDER_IN_BOUTIQUE

Заказы (товары) в бутике

BOUTIQUE_ORDER_SOLD_IN_BOUTIQUE

Продано в бутике (выплаты)

BOUTIQUE_ORDER_ONLINE_CONFIRM

Online заказы: подтверждение

BOUTIQUE_ORDER_ONLINE_PICKUP

Online заказы: отгрузка

orderStatusTitle
string

Русский заголовок статуса

deliveryAddressEndpoint

Точка доставки заказа

pickupAddressEndpoint

Точка забора заказа

deliveryAddressEndpointAggregation

Точка доставки заказа интернешнл

pickupAddressEndpointAggregation

Точка забора заказа интернешнл

buyerCounterparty

Контрагент покупателя

sellerCounterparty

Контрагент продавца

confirmedAmount
number

Подтвержденная сумма

clearAmount
number

Сумма заказа без учета скидки (без учета доставки)

finalAmount
number

Итоговая цена с учетом стоимости доставки и возможных скидок.

bonusesInfo
effectiveBonusesInfo
bonusesLimitReached
boolean
bonusesWithdrawLimitReached
boolean
finalAmountWithoutDeliveryCost
number

Итоговая цена с учетом возможных скидок, торгов, но без учета доставки.

deliveryCost
number

Стоимость доставки

sellerReceivesAmount
number

Сумма, которую получит продавец

waybillId
string

Номер накладной доставки заказа покупателю

trackingUrl
string

URL для отслеживания доставки

ourselvesDelivery
boolean

true, если заказ доставляется своим курьером

ourselvesDeliveryName
string

Имя курьера (в случае доставки своим курьером)

ourselvesDeliveryPhone
string

Телефон курьера (в случае доставки своим курьером)

deliveryTitle
string

Заголовок к блоку доставки, н.п. ‘Доставляем сами’

deliveryIcon
string

Иконка доставки (транспортная компания или наша)

deliveryDescription
string

Строка с подробностями о доставке. Может содержать ссылку на трекинг, имя и телефон курьера, обрамлена в

deliveryInfo
string

Строка с кратким описанием доставки, н.п. ‘Доставка до 5 дней по России’

agentReportId
integer int64

Идентификатор отчета агента

adminComment
string

Комментарий, который виден только сотрудникам OSKELLY

deliveryToBuyerDateHint
string date-time

Ориентировочная дата доставки покупателю. Изменено менеджером в панели администратора.

agentReport

Отчет агента

agentReportConfirmed
boolean

Отчет агента подтвержден (true/false, если он существует, null - если не усществует)

orderStepChain

Цепочка состояний по заказу для отображения в удобном виде покупателю, продавцу или моредатору

orderTrack

Цепочка состояний по заказу для отображения в удобном виде покупателю, продавцу или моредатору

linkedNotification

Связанное с заказом уведомление, которое отображается под цепочкой статусов. Может быть использовано для вывода уведомления о выполнении заказа с кнопкой ‘Подвердить доставку’ (для продавца) или для отображения уведомления для продавца (подтвердите отчет агента).

isMadeByNewUser
boolean

Заказ сделан новым пользователем (первый оплеченный заказ покупателя). Доступно только для покупателя

pickupTimeIntervalId
integer int64

ID временного интервала забора заказа

pickupComment
string

Комментарий к забору заказа от продавца

deliveryComment
string

Комментарий к доставке заказа покупателю

pickupDateFromSeller
integer int64

Дата забора от продавца (секунды)

pickupIntervalFromSeller
string

Интервал забора от продавца

pickupDateToBuyer
integer int64

Дата забора от ОСКЕЛЛИ покупателю (секунды)

conciergeClientChannel
counterpartyRequestType
string
Enumeration:
ORDER_CONFIRMATION

подтверждение заказа

AGENT_REPORT_CONFIRMATION

подтверждение отчета агента

ORDER_AND_AGENT_REPORT_CONFIRMATION

подтверждение заказа и отчет агента

waybills
Array of WaybillDTO

Накладные ТК

waybillFromSeller

Накладная ТК от продавца

waybillToBuyer

Накладная ТК покупателю

ourselvesDeliveries

Самостоятельные доставки

ourselvesDeliveryFromSeller

Самостоятельная доставка от продавца

ourselvesDeliveryToBuyer

Самостоятельная доставка покупателю

orderCreationProblems

Проблемы, в связи с которыми нельзя оформить заказ, н.п. не достигнута минимальная сумма. Используется для корзины для вывода кнопки ‘Дособрать заказ на странице продавца’.

orderSource
string

Вид заказа: обычный или бутика.

Enumeration:
ONLINE

обычный

BOUTIQUE

бутик

orderSourceInfo
productLocation
string

Местонахождение товара

Enumeration:
SELLER

Товар находится у продавца.

BOUTIQUE

Товар находится в бутике.

boutiqueAddress
string

Для заказов из бутка заполняется адрес бутика

soldTime
string date-time

Дата/время исполнения заказа в бутике

isEffectiveBuyer
boolean

Признак того, что в заказе уже заполнен effectiveBuyer. Это признак того, что заказ был реализован в бутике и реальным покупателем является effectiveBuyer

deletable
boolean
vatIncluded
boolean
duties
Array of DutyDTO
pickupCountry
payment
sellerConciergeOrder
boolean
counterpartyRequiredOnConfirmation
boolean
counterpartyModificationAllowed
boolean
legalEntity
tabbySplit
userActions
paymentInfo
empty
boolean
size
integer int32
count
integer int32

Количество товаров в позиции. Используется только для корзины.

faulty
boolean
dutiesAmount
number
rrpSum
number
CartRequest
Object
currencyCode
string

Код валюты

showSoldWithSimilar
boolean

Признак того, в response будут проданные товары

countryId
integer int64

id страны

sellerId
integer int64

Id продавца

promoCode
string

Промокод примененный к корзине

checkoutMode
boolean

TODO

recalcAndApplyWithdrawBonusesToCart
boolean

Признак применения бонусов к корзине

pickupAddressEndpointId
integer int64

Id точки вывоза для заказа

groupByPickupAddress
boolean

Признак Группировки заказа по точке вызова

Api2ResponseGroupedCart
Object
message
string

Техническое описание ошибки/успешного запроса

humanMessage
string

Описание ошибки понятное пользователю

Данные

errorData
Object

Описание ошибки

validationMessages
Object

Развернутое описание ошибки валидации полей

additional properties
string
timestamp
integer int64

Время отправки запроса

executionTimeMillis
integer int64

Время выполнения запроса

success
boolean

Признак успешного запроса

Api2_1ResponseObject
Object
data
Object

Данные

Описание ошибки

timestamp
integer int64

Время отправки запроса

executionTimeMillis
integer int64

Время выполнения запроса

UserBanDTO
Object
id
integer int64

id пользователя

banType
string

Тип бана

Enumeration:
USER_BAN

Заблокировать пользователя

COMMENT_BAN

Запрет на комментарии

PUBLISH_BAN

Запрет на публикацию

STORIES_BAN

Запрет на публикацию сторис

BARGAIN_BAN

Запрет на торги

STREAM_BAN

Запрет на прямые эфиры

WARNING

Выслать предупреждение

OSOCIAL_POST_BAN

Запрет на публикацию постов в O!Trends

OSOCIAL_COMMENT_BAN

Запрет на комментарии в O!Trends

COMMENT_SHADOW_BAN

Теневой запрет на комментарии

title
string

Тип ограничения действий пользователя в текстовом виде

subTitle
string
timeToEndBan
integer int64

Дата окончания блокировки

description
string

Комментарий администратора

banned
boolean

Признак блокировки

Api2Response
Object
message
string

Техническое описание ошибки/успешного запроса

humanMessage
string

Описание ошибки понятное пользователю

data
Object

Данные

errorData
Object

Описание ошибки

validationMessages
Object

Развернутое описание ошибки валидации полей

additional properties
string
timestamp
integer int64

Время отправки запроса

executionTimeMillis
integer int64

Время выполнения запроса

success
boolean

Признак успешного запроса

GroupedCart

Представление корзины, сгруппированной по продавцам

Object
groups
Array of OrderDTO

Сгруппированная корзина по продавцам

size
integer int32

Количество товарных позиций (строк)

count
integer int32

Количество товаров (с учетом количества)

availableCount
integer int32

Доступное количество

ErrorObject
Object
data
Object

Описание ошибки

code
string

Причина ошибки

Enumeration:
BAN

Пользователь забанен

VALIDATION

Ошибки валидации

LOGIC

Логическая ошибка

humanMessage
string

Описание ошибки понятное пользователю

OrderPositionDTO
Object
id
integer int64
categoryId
integer int64

Id категории

categoryName
string

Название категории

productId
integer int64

Id продукта

state
string

Состояние позиции заказа

Enumeration:
INITIAL

Начальное состояние позиции заказа

PURCHASE_REQUEST

Покупатель оплатил вещь в рамках заказа

SALE_CONFIRMED

Продавец подтвердил продажу вещи после того, как покупатель купил ее

SALE_REJECTED

Продавец отменил продажу вещи после того, как покупатель купил ее

PICKUP_DECLINED

Не был отгружен продавцом

HQ_WAREHOUSE

Приняли на склад (первичная приемка)

ON_VERIFICATION

Направили на верификацию

VERIFICATION_OK

Вещь прошла верификацию. ## Можно списывать деньги

VERIFICATION_NEED_CLEANING

Вещь прошла верификацию, но требуется направить на химчистку ## Можно списывать деньги

VERIFICATION_BAD_STATE

Состояние вещи не соответсвует заявленному. Клиент подтвердил покупку, НО со скидкой. В этом кейсе, мы должны будем внести скидку в цену и списать меньше. ## Можно списывать деньги, с учетом скидки!

REJECTED_AFTER_VERIFICATION

Отклонили при верификации Сюда можно попасть или сразу после ON_VERIFICATION, или после VERIFICATION_BAD_STATE ## Деньги за вещь возвращаем покупателю

READY_TO_SHIP

Готово к отправке покупателю. Создана накладная на перевозку, ждем Курьера

CREATE_WAYBILL_TO_BUYER

Курьер вызван, но еще не приехал

SHIPPED_TO_CLIENT

Отправили клиенту (передали курьеру)

REQUESTED_TO_RETURN

Подана заявка на возврат

RETURN_ACCEPTED

Принят на возврат

RETURN_DECLINED

Отклонен на возврат

RETURN_VERIFICATION_OK

Экспертиза одобрена

RETURN_VERIFICATION_REJECTED

Экспертиза отклонена

stateTitle
string

Строковое представление состояния позиции заказа.

alertLevel
string

Используется для выбора цвета, которым выводится статус позиции в заказе.

Enumeration:
GRAY
ORANGE
RED
imageUrl
string

Ссылка на миниатюру изображения товара

brandId
integer int64

id бренда

brandName
string

Название бренда

productName
string

Название товара

productConditionId
integer int64

Идентификатор состояния вещи Ссылается на таблицу product_condition Варианты значений 2,Отличное состояние,“Надевали пару раз, вещь в отличном состоянии.”,2,refurbished 3,Хорошее состояние,Хорошее состояние товара. Незначительные следы носки.,3,used 1,Новое с биркой,Товар с биркой. Вещь ни разу не надевали.,1,new

productCondition
string

Состояние товара

productSelectedForConcierge
boolean
bonusesInfo

Информация о начислении/списании бонусов

effectiveBonusesInfo

Информация об итоговом начислении/списании бонусов

amount
number

Стоимость всего лота, а не одного товара. Если у нас 4 товара в лоте, то стоимость лота = цена товара * 4 Без учета скидок

itemSaleAmount
number

‘Сырая’ стоимость продажи позиции от продавца (каталог - торг) Без учета добавленных пошлин и скидок

finalAmount
number

Стоимость лота с учетом скидок

strikethroughPrice
number

Цена без скидок за лот

finalStrikethroughPrice
number

Сумма зачеркнутых цен всех единиц в одной позиции

promocodeAmount
number

Сумма промокода (скидки), примененная к данной позиции (т. е. после разбиения по позициям)

commission
number

Размер комиссии 0-1

sellerReceivesAmount
number

Сумма, которую получит продавец (за вычетом комиссии и других издержек)

sellerReceivesOriginalAmount
number

Сумма, которую получил бы продавец, если бы не было дефектов, химчистки и т.п.

hasSimilar
boolean

У товара есть похожие.

size
One of

Размер. Null если у товара нет атрибута размера.

sizes
Array of SizeValueDTO

Доступные размеры и остатки. Используется исключительно в корзине и формируется на лету из актуальных данных о товаре. Эта информация в таблице order_position не хранится

availableSizes
Array of Size

Другие размеры этого товара, которые есть в наличии.

rrp
number

Рекомендуемая цена для товара

description
string

Используется для вывода комментария при просмотре заказа. Н.п. ‘Этот товар не прошел экспертизу: оторван каблук’

count
integer int32

Количество товаров в позиции. Используется только для корзины.

isConfirmed
boolean

Позиция подтверждена или нет. NULL - если решение еще не принято

isMoneyReturned
boolean

True - деньги по этой позиции возвращены. В остальных случаях информации о возврате не было.

expertises
Array of ExpertiseDTO

Список пройденных экспертиз

metadata
One of

Метаданные со статусом успешности позиции, заголовком и комментарием

buyerCommentsCount
integer int32

Количество комментариев покупателя. Доступно только для покупателя.

isLiked
boolean

Используется в корзине для отображения наличия лайка (товар в избранном)

isConciergeAPAvailable
boolean

Признак доступности точки входа в консьерж-сервис (используется в корзине)

productHasDiscount
boolean

Товар продается со скидкой на момент запроса.

buyerFollowsSeller
boolean

Покупатель подписан на продавца на момент запроса

afterAcceptedOffer
boolean

Позиция была добавлена в связи с принятым оффером. Доступно только для покупателя.

isNeedDatamatrix
boolean

Требуется ли код маркировки для товара

datamatrix
string

Код маркировки товара

countryOfOriginRequired
boolean

Требуется ли страна происхождения?

countryOfOrigin
One of

Страна происхождения

amountInForeignCurrency
number

Цена в другой валюте

foreignCurrencyRate
number

Курс другой валюты

foreignCurrencyId
integer int64

Идентификатор другой валюты

productModel
discount
integer int32

Скидка %

saleRejectionReason

Причина отказа продажи

stateForBadge
string

Статус позиции заказа, который отображается на карточке товара в заказе в виде бейджа.

Enumeration:
AUTHENTIC

Оригинал

FAKE

Фейк

amountsDetails
isFromSelection
boolean

Флаг, указывающий на то, что данный купленный товар находится в подборке, отправленной клиенту

available
boolean

Товар можно купить в данный момент.

expertisePass
boolean

Пройдена ли экспертиза

bonusesProhibited
boolean

Выставляться в true в случаях, если списание запрещено на товаре или если весь бренд запрещен к списанию

Discount

Назначенная скидка

Object
optionalText
string
code
string

Скидка все еще действительна

isValidYet
boolean
discountValue
number

Сумма скидки абсолютная, не округленная

discountProc
number

Сумма скидки в процентах (0-100), не округленная

savingsValue
integer int64

Сумма в рублях, округленная до копеек, которую экономит покупатель, используя скидку для оплаты заказа

baseAmount
integer int64

Базовая сумма, которую должен был получить продавец (цена товара - комиссия), из которой вычитаются скидки за дефекты и химчистку

resultAmount
integer int64
resultAmountWithDeliveryCost
integer int64
type
string
DutyDTO
Object
sequence
integer int32
amount
number
description
string
oskellyCommission
boolean
UserDTO
Object
id
integer int64
email
string

Email пользователя

phone
string

Телефон пользователя

nickname
string

Никнейм пользователя

registrationTime
string date-time

Дата регистрации

activationTime
string date-time

Дата активации

sex
string

Пол пользователя

Enumeration:
MALE

Мужской

FEMALE

Женский

BOY

Мальчик

GIRL

Девочка

ADULT

Взрослый (unisex)

CHILD

Ребенок (unisex)

birthDate
string date-time

Дата рождения

isTrusted
boolean

Является подвержденным пользователем (одобряемым OSKELLY)

countryId
integer int64

Код страны

userType
string

Тип пользователя

Enumeration:
SIMPLE_USER

Физик

IP

Индивидуальный предприниматель

OOO

ООО

position
string

Должность пользователя. Заполняется для экспертов, например “младший эксперт”.

sellerType
string

Тип продавца

Enumeration:
INDIVIDUAL

Частный продавец

CONSIGNMENT_SHOP

Ресейл магазин

BOUTIQUE

Бутик

BRAND

Бренд

MULTI_BRAND

Мульти-бренд

MONO_BRAND

Моно-бренд

BUYER

Персональный шопер

pickupCountryId
integer int64

Id страны самовывоза

celebrity
boolean

Признак селебрити

bestFriend
boolean

Признак статуса лучший друг

legalEntity
boolean
vip
boolean

Признак vip статуса

pro
boolean

Признак cтатус pro

banned
boolean

Признак бана

firstName
string

Имя

lastName
string

Фамилия

admin
boolean

Является ли админом

agentSeller
boolean
deleted
boolean

Признак удаления

moderator
boolean

Является ли модератором

avatarPath
string

Путь до аватара

tags
Array of string

Теги

commissionGrid
acceptsReturns
boolean

Признак возможности вернуть товар

AddressEndpointDTO

Точка (пункт) доставки/заобра товара или любая другая географическая точка, где имеется представитель и телефон. Не путать с адресом! Точка СОДЕРЖИТ в себе адрес, но является более широким понятием, т.к. имеет представителя (ФИО) и контакты (телефон)

Object
id
integer int64
userId
integer int64

Id пользователя, создавший данный адрес

firstName
string

Имя представителя по адресу доставки/забора

patronymicName
string

Отчество представителя по адресу доставки/забора

lastName
string

Фамилия представителя по адресу доставки/забора

phone
string

Телефон представителя по адресу доставки/забора

address

Адрес доставки

deliveryCost
number

Стоимость доставки

deleteTime
integer int64

Дата ‘мягкого’ удаления (не удаляется, а помечается удаленным)

changeTime
integer int64

Дата изменения точки. Толька может быть изменена только в том случае, если она не задействована в заказах в качестве точки забора/доставки.

AddressEndpointAggregationDTO

Аккумулирующая сущность точки для интернациональной версии. Может содержать физический и платежный адрес.

Object
id
integer int64

Физический адрес

Платежный адрес

usePhysicalAddressForBilling
boolean

Флаг, если true, то billing адрес не создается и физический является платежным.

CounterpartyDTO
Object
id
integer int64
type
string

Тип контрагента

Enumeration:
PHYS

Физическое лицо

IP

Индивидуальный предприниматель

JUR

Юридическое лицо

CARD

Банковская карта

BONUS_12_STOREEZ

Бонусы 12Storeez

INTERNATIONAL

Счет для международных переводов - Физическое лицо

INTERNATIONAL_LEGAL_ENTITY

Счет для международных переводов - Юридическое лицо

isActive
boolean

Активный контрагент пользователя

createTiestamp
integer int64

Дата создания контрагента

userId
integer int64

Пользователь, к которому привязан этот контрагент

jurAddress

Юридический адрес

physAddress

Физический адрес

passport
string

Паспорт для физ.лица

inn
string

ИНН для юр.л./ИП/физ.лица

orgn
string

Используется как для юр. лиц, так и для ИП (вместо ОГРНИП)

kpp
string

КПП

companyForm
string

ООО, ЗАО. ПАО

companyName
string

Название компании без правовой формы и без кавычек (если только часть названия не выделена кавычками)

bik
string

БИК (идентификатор банка) для юр.л./ИП/физ.лица

correspondentAccount
string

Корреспондентский счет для юр.л./ИП

paymentAccount
string

Номер счета для юр.л./ИП/физ.лица

bankName
string

Название банка

directorName
string

Имя директора

unifiedSocialCreditCode
string
businessRegistrationNumber
string
iban
string

IBAN для международных переводов.

swiftCode
string

SWIFT-код для международных переводов.

routingNumber
string

Маршрутный номер для международных переводов.

trn
string

TRN для международных контрагентов

billingAddress

Платежный адрес

legalAddress

Юридический адрес

accountType
string
Enumeration:
CHECKING
SAVING
countryCounterpartyType
string

Тип страны контрагента

Enumeration:
UAE_COUNTERPARTY
DEFAULT_COUNTERPARTY
country

Страна

firstName
string

Имя

patronymicName
string

Отчество

lastName
string

Фамилия

phone
string

Номер телефона

isCard
boolean

Данные карты продавца

cardRefId
string

Уникальный индентификатор карты в банковской системе

cardNumber
string

Номер карты

cardBindTime
string date-time

Время привязки карты

cardUnbindTime
string date-time

Время отвязки карты

cardHolder
string

Держатель карты

cardBrand
string

Тип карты MASTERCARD / VISA

cardBindBank
string

В каком банке привязка карты

vatRateIndex
integer int32

Ставка НДС: 1 - 10% 2 - 20% 3 - 0% 4 - Без НДС 5 - 5% 6 - 7%

cardExpireTime
string date-time

Время действия (expire)

isCardActive
boolean
deleteTime
string date-time
counterpartyImage
string
isActiveInCurrentOrder
boolean
contractNumber
string
contractDate
string date-time
BonusesInfoDTO

Структура позволяющая хранить информацию о начислении/списании бонусов

Object
withdrawBonusesAmount

Бонусы которые могут быть списаны

transferBonusesAmount

Бонусы которые могут быть начислены

AgentReportDTO

Отчет агента

Object
id
integer int64
createTime
integer int64

Дата создания

userType
string
Enumeration:
SIMPLE_USER
IP
OOO
name
string
firstName
string
patronymic
string
secondName
string
bik
string
inn
string
paymentAccount
string
numberContract
string

id пользователя

paymentDetails
string
kpp
string

Код причины постановки (ООО)

dateContract
integer int64

дата регистрации пользователя

isConfirmed
boolean
isCard
boolean

Данные карты продавца

cardRefId
string
cardNumber
string
cardHolder
string
cardBrand
string
iban
string

Для международных контрагентов

swiftCode
string

swift-code для международных переводов

routingNumber
string
order
paymentAmount
number
cleaningAmount
number
defectsDiscountAmount
number
baseAmount
number
OrderStepChain

Цепочка стадий заказа для представления пользователю (продавцу/покупателю/модератору).

Object
steps
Array of OrderStepDTO

Цепочка стадий заказа для представления пользователю (продавцу/покупателю/модератору).

OrderTrackDTO

Цепочка стадий заказа для представления пользователю (продавцу/покупателю/модератору).

Object
orderStages
Array of OrderStageDTO

Цепочка стадий заказа для представления пользователю (продавцу/покупателю/модератору).

NotificationDTO
Object
id
integer int64
type
string

Тип уведомления

mainIcon
string

Иконка основная. Обычно используется для аватарки инициатора события или логотип Оскелли ‘О’

tinyIcon
string

Мелкая иконка, показывающая смысл уведомления (комментарий, покупка)

initiator

Пользователь, который иницировал событие

targetUser

Пользователь, в отношении которого было совершено действие

guestToken
string

Токен гостя

targetObject
Object

Целевой объект (товар, комментарий, пользователь, оффер, заказ и т.п.)

targetObjectImage
string

Картинка с объектом, в отношении которого было выполнено действие. Для заказа это картинка товара.

targetObjectImageHint
string

Короткий текст поверх картинки объекта. Для заказа ‘+3’ означет, что всего в заказе 4 позиции.

targetObjectType
string

Тип объекта

targetObjectId
integer int64

Идентификатор объекта, в отношении которого было совершено действие

targetObjectUrl
string

URL, ведущий на страницу объекта, в отношении которого было совершено действие Например, на страницу товара или страницу подтверждения продажи

createTime
string date-time

Дата создания

readTime
string date-time

Дата прочтения

counter
integer int32

Счетчик. Может использоваться в разных типах уведомлений для сохранения целого числа событий. Например, в уведомлении об отвержении торга в сообщении выводится количество оставшихся попыток.

needAction
boolean
actionCompletedTime
string date-time

Дата выполнения

title
string

Первый заголовок (обычно имя пользователя)

subTitle
string

Второй заголовок (обычно тема уведомления)

shortMessage
string

Укороченное сообщение уведомления

message
string

Полное сообщение уведомление

modificationMetadata

Метаданные для заполнения форм

metadata
Object

Метаданные для нестандартных уведомлений

images
Array of string

Изображения, например для отображения в комментариях

params
string
read
boolean

Признак прочтения

deleted
boolean

Признак удаления

actionCompleted
boolean

Признак выполнения

targetUserId
integer int64

Id пользователя, в отношении которого было совершено действие

messageFormat
ConciergeClientChannelDto
Object
id
integer int64
name
string
orderNumber
integer int32
WaybillDTO
Object
id
integer int64

Идентификатор в нашей системе

externalSystemId
string

Идентификатор в системе логистов

pickupDestinationType
string

Где лежит товар

Enumeration:
OFFICE

Офис

SELLER

Продавец

BUYER

Покупатель

deliveryDestinationType
string

Куда доставить товар

Enumeration:
OFFICE

Офис

SELLER

Продавец

BUYER

Покупатель

pickupDate
string date-time

Дата взятия товара

pickupInterval
string
OurselvesDeliveryDTO

заказ доставляется своим курьером

Object
courierName
string

Имя курьера

courierPhone
string

Телефон курьера

OrderCreationProblemDTO
Object
type
string

Тип проблемы

Enumeration:
NOT_ENOUGH_AMOUNT

Не достигнута минимальная сумма

CANT_DELIVERY_ITEM_TO_FOREIGN_COUNTRY

Данная категория товаров доставляется только по России. Если вы в России, то проверьте что ваш адрес указан правильно.

CANT_CONTAIN_MULTIPLE_ORDER_POSITIONS

Заказ не может содержать несколько позиций.

CANT_BE_CONCIERGE

Заказ не может быть консьержным.

CANT_BE_BOUTIQUE

Заказ не может быть бутиковым.

data
Object

Данные, н.п. минимальная сумма

description
string

Описание проблемы

OrderSourceInfoDTO
Object
id
integer int64
name
string
type
string
displayName
string
isHidden
boolean
isMarketplaceLocation
boolean
isPointOfSale
boolean
productItemLocation
CountryDTO
Object
id
integer int64
name
string

Название страны

isoCodeAlpha2
string

iso код страны

imageUrl
string
currency

Валюта

uiCurrencyCode
string

Код валюты

requireZipcode
boolean

Признак требования почтового индекса

environment
string
Enumeration:
RU
INT
countryCounterpartyType
string

Тип страны контрагента

Enumeration:
UAE_COUNTERPARTY
DEFAULT_COUNTERPARTY
OrderUITextsDTO
Object
pickupFromSellerDateAndTime
string
deliverySectionTitle
string
estimatedDeliveryDate
string
stateTitle
string
OrderNumbersDTO
Object
totalAmount
number

Для Покупателя: сколько заплатит Покупатель. Для Продавца: сколько получит Продавец.

totalItemSaleAmount
number

Общая стоимость всех товаров (без пошлин сверху, по стоимости на сайте: продавцуНаРуки + КомиссияОскелли)

totalOriginalAmount
number

Для Покупателя: сколько заплатил бы Покупатель, если бы не было дефектов. Для Продавца: сколько получил бы Продавец, если бы не было дефектов и платных услуг.

totalBuyerAmount
number

Для Покупателя: не заполняется. Для Продавца: сколько заплатит Покупатель с точки зрения Продавца. Не включает скидку за промокод.

promocodeAmount
number

Для Покупателя: суммарная скидка за промокоды по всем позициям. Для Продавца: не заполняется.

discountAmount
number

Для Покупателя: суммарная скидка за дефекты по всем позициям. Для Продавца: не заполняется.

deliveryWithCustomsAmount
number

Для Покупателя: сумма дополнительных пошлин (таможня) и доставки Для Продавца: сумма дополнительных пошлин (таможня) и доставки

PaymentDTO

Платеж

Object
id
integer int64
paymentVersion
string

Текущая версия схема платежей

paymentMethod
string

Способ оплаты

failText
string

Текст ошибки

PaymentInfoDto
Object
paymentOptionType
string

Тип оплаты

Enumeration:
YANDEX_PAY

Яндекс Пэй

CARD

Оплата картой

YANDEX_SPLIT

Яндекс Сплит

SBP

СПБ

TABBY_PAY4PAYS

Tabby

PLATI_CHASTYAMI

Плати частями

SBER_PAY

SberPay

ONLINE

Онлайн оплата

cardNumber
string

Номер карты

LegalEntityDTO
Object
id
integer int64
onecUuid
string
title
string
systemName
string
isPointOfSale
boolean
SplitInfo

Оплата сплитом

Object
firstPayment
number

Первый платеж

remainingPayment
number

Остаток платежа

parts
Array of Part

Части платежа

UserActions

Действия пользователя

Object
providePersonalDataForCustomsClearance

Необходимость предоставить персональные данные для таможенного оформления

SizeValueDTO
Object
id
integer int64
productSizeType
string

Тип размера товара

Enumeration:
RU
EU
US
INT
UK
FR
IT
DE
AU
JPN
INCHES
CENTIMETERS
COLLAR_CENTIMETERS
COLLAR_INCHES
RING_RUSSIAN
RING_EUROPEAN
JEANS
HEIGHT
AGE
NO_SIZE
BUST
productSizeValue
string

Размер товара

productCustomSizeType
string
productCustomSizeValue
string
categorySizeType
categorySizeValue
string
interestingSizeType
string
Enumeration:
RU
EU
US
INT
UK
FR
IT
DE
AU
JPN
INCHES
CENTIMETERS
COLLAR_CENTIMETERS
COLLAR_INCHES
RING_RUSSIAN
RING_EUROPEAN
JEANS
HEIGHT
AGE
NO_SIZE
BUST
interestingSizeValue
string
count
integer int32
additionalSizeValues
Object
additional properties
integer int32
offer
bargainLite
ordering
integer int64
isAuthentic
boolean
link
string
payoutInfo
Size

Размер

Object
id
integer int64
value
string

Размер

ExpertiseDTO
Object
id
integer int64
createTime
integer int64
isApproved
boolean

Если isApproved == false, значит экспертиза не пройдена Экспертиза считается пойденной в случаях: 1. isApproved == true 2. defectDiscount != null 3. cleaningPrice != null

defectDiscount
number

Скидка за дефекты в процентах по старому

defectDiscountPrice
number

Скидка за дефекты в рублях по новому Важно: Нельзя задавать одновременно defectDiscount и defectDiscount. Только чтото одно.

defectComment
string
cleaningPrice
number

Цена за чистку

rejectionReason
string

Причина отказа

pickupFrom
string

Откуда был доставлен товар на экспертизу.

Enumeration:
OFFICE
SELLER
BUYER
Metadata

Метаданные со статусом успешности позиции, заголовком и комментарием

Object
priceDescription
string

Описание под заголовком бренда товара.

status
string

Статус позиции. Согласно Мобильному API отображается зеленным или красным в зависимости от поля #isPositiveCase

positiveCase
boolean

Если позитивное значение данного поля, то для мобильного API необходимо предовать значение позитивного отображения поля #status * Согласно Мобильному API регулирует отображение #status зеленым или красным цветом

ModificationMetadata

Изменение, которое можно или нельзя выполнить через попап уведомление. Например дата рождения, фото профиля, размер

Object
title
string

Заголовок поля ввода, н.п. ‘Дата рождения’

acceptUrl
string

УРЛ пересылки данных из попапа

acceptMethod
string

Метод отправки данных

Enumeration:
GET
HEAD
POST
PUT
PATCH
DELETE
OPTIONS
TRACE
acceptMediaType
acceptParamName
string

Имя параметра для пересылки

acceptParamFormat
string

Формат значения (имя класса)

currentValue
Object

Текущее значение

modifiable
boolean

Можно изменять

ProductModelDTO

Модель товара

Object
id
integer int64
name
string

Название товара

url
string

Ссылка на товар

SaleRejectionReasonDTO

Причина отказа в продаже

Object
reasonType
string

Тип причины

Enumeration:
CHANGE_DECISION

Передумал продавать

SOLD_ON_OTHER_PLATFORM

Продал на другой платформе

GOING_TO_CHANGE_PRICE

Хочу изменить цену

PRODUCT_CONDITION_CHANGED

Изменилось состояние товара

OTHER

Другое

DONT_ANSWER

Не могу отправить в данный момент

CAN_NOT_SEND

Продавец не отвечает

displayName
string
salePlatform
string

Платформа продажи

newPrice
number

Новая цена

comment
string

Комментарий

OrderPositionAmountsDTO
Object
displayAmount
number

Цена для отображения в списке товаров на клиенте (есть правила выбора на бэкенде)

rawSellAmount
number

‘Сырая’ цена продажи (цена в каталоге), без доп. пошлин / наценок / промокодов / бонусов

payableAmount
number

Итоговая сумма к оплате (после пошлин / промиков / наценок)

dutiesExtraAmount
number

Сумма пошлин ‘сверху’ (т. е. добавленных к цене каталога / продажи)

CommissionGridDTOV3

Тип комиссионной сетки

Object
id
integer int64
name
string

Название

type
string

Тип комиссионной сетки.

Enumeration:
DEFAULT

Комиссионная сетка для частных продавцов.

PRO

Комиссионная сетка для бутиков.

CUSTOM

Произвольная сетка

commissions
Array of CommissionDTOV3

Записи интервалов комиссионных сеток

deleteTime
string date-time

Время удаления

fixedAmount
number

Фиксированная комиссия

AddressDTO

Адрес

Object
id
integer int64
zipCode
string

Почтовый индекс

country
string

Страна

countryData

Данные о стране

cityData

Данные о городе

region
string

Регион

city
string

Населенный пункт

address
string

Адрес, содержащий все остальное (улица/проспект/шоссе, дом/корпус/строение, квартира) н.п. ‘ул.Ленина, д.6, кв. 9’

addressBreakdown

Распаршенный адрес

address2
string

Адрес дополнительный 2

address3
string

Адрес дополнительный 3

fiasId
string

Данные из fias

regionFiasId
string

Регион из fias

cityFiasId
string

Город из fias

settlementFiasId
string

Поселение из fias

dadataFullAddress
string
fullCityName
string

Полное название населенного пункта

fullAddress
string

Полный адрес

cityValidated
boolean

Признак пройденной валидации населенного пункта

addressValidated
boolean

Признак пройденной валидации адреса

checked
boolean
createTime
integer int64

Дата создания

changeTime
integer int64

Дата изменения

deleteTime
integer int64

Дата удаления

cis
boolean

Признак того, что адрес находится в СНГ

CommissionDTOV3

Сущность комиссии. Представляет собой записи интервалов комиссионных сеток.

Object
id
integer int64
commissionGridId
integer int64
publicPrice
number

Максимальная публичная (сумма, которую платит покупатель) цена (НЕ включительно).

value
number

Комиссия (от 0 до 1).

boutiqueValue
number

Комиссия для товаров, каналом продаж которых указан бутик и сайт (от 0 до 1)

valueScaled
number
boutiqueValueScaled
number
CityDTO

Город

Object
id
integer int64
name
string

Названание населенного пункта

region
string

Регион населенного пункта

AddressBreakdownDTO
Object
street
string

Улица

house
string

Номер дома

flat
string

Номер квартиры

AddressAggregationEndpointDTO
Object
id
integer int64
firstName
string

Имя

patronymicName
string

Отчество

lastName
string

Фамилия

phone
string

Телефон

Адрес

AddressAggregationDTO
Object
id
integer int64
zipCode
string

Почтовый индекс

countryData

Информация о стране

cityData

Информация о населенном пункте

address
string

Адрес, содержащий все остальное (улица/проспект/шоссе, дом/корпус/строение, квартира) н.п. ‘ул.Ленина, д.6, кв. 9’

address2
string

Адрес дополнительный 2

address3
string

Адрес дополнительный 2

createTime
string date-time

Дата создания адреса

changeTime
string date-time

Дата изменения адреса

CurrencyDTO

DTO для представления валюты

Object
id
integer int64

id

name
string

Название валюты

sign
string

Символ валюты

isoCode
string

iso код валюты

isoNumber
integer int32

iso номер валюты

isBase
boolean

Признак того, что валюта является базовой для системы (например, для конвертации)

isActive
boolean

Признак того, что валюта доступна для использования в системе

selectedByDefault
boolean

Признак того, что валюта выбрана по умолчанию для отображения пользователю

BonusesAmountDTO

Сгораемые и несгораемые баллы объединенные одним объектом

Object
bonuses
number

Количество сгорамых баллов

money
number

Количество несгораемых баллов

total
number

Общее количество баллов

OrderStepDTO

Стадия заказа для представления пользователю (продавцу/покупателю/модератору).

Object
type
string

Тип шага

Enumeration:
DISABLED

Неактивный

WAITING

Ожидание

COMPLETE

Завершено

FAILED

Есть проблемы

CONFIRMATION

Подтверждение заказа

EXPERTISE

Экспертиза

DELIVERING

Курьер выехал к покупателю

title
string

Заголовок шага

message
string

Основная часть сообщения, остающаяся при отображении дальнейших шагов

temporaryMessage
string

Временная часть сообщения, исчезающая в случае, если имеется следующий шаг

time
integer int64

Дата/время

warning
string

Воскл знак с отдельным комментарием ведет к списку неподтвержденных (не прошедших экспертизу) позиций заказа (aly на иконке)

description
string

Информация, выводящаяся в виде комментария после нажатия на шаг и всплытия попапа

descriptionTitle
string

Заголовок информации, выводящаяся в виде комментария после нажатия на шаг и всплытия попапа (н.п. ‘Неподтвержденные товары’)

descriptionItemIds
Array

Список идентификаторов позиций заказа, которые попадают во всплывашку (неподтвержденные, непрошедшие экспертизу)

integer int64
itemDescriptions
Object

Описания по позициям заказа с проблемами (для всплывающего окна). description_ID - описание.

additional properties
string
typeIcon
string

Иконка в зависимости от типа шага

warningIcon
string
MessageFormat
Object
text
string
date
string date-time
ProductItemLocationDTO
Object
id
integer int64
code
string
name
string
addressDisplayName
string
OrderStageDTO

Стадия заказа для представления пользователю V2 (продавцу/покупателю/модератору).

Object
type
string

определяет, что следует сделать с заказом

Enumeration:
SELLER_CONFIRMATION
DELIVERY_TO_OFFICE
EXPERTISE
DELIVERY_TO_BUYER
DELIVERY_TO_BOUTIQUE
BUYER_CONFIRMATION
SOLD_IN_BOUTIQUE
PAYOUT
RETURNED_TO_SELLER
progressState
string

показывает прогресс стадии

Enumeration:
UPCOMING
IN_PROGRESS
COMPLETE
successState
string

то, чем закончилась стадия, можно заполнить после завершения этапа

Enumeration:
SUCCEEDED
PARTIALLY_SUCCEEDED
FAILED
title
string

название стадии, которую видит пользователь

description
string

описывает действия, которые выполняются с заказом в данный момент (обычный шрифт, текст под заголовком)

positions

список выделенных позиций после этапа подтверждения/экспертизы, иногда пользователь может работать с ними

comment
string

Что-то, что должно быть выделено для пользователя, или ожидаемая дата завершения (серый шрифт, текст под заголовком)

updatedAt
string date-time
estimatedDateTime
string date-time

ожидаемая дата и время завершения заказа

Part

Части платежа

Object
date
string date-time
value
number
label
string
ProvidePersonalDataForCustomsClearanceUserAction

Необходимость предоставить персональные данные для таможенного оформления

Object
required
boolean

Требуется ли предоставить персональные данные

SizeTypeLocalized
Object
abbreviation
string

Сокращенное название размерной сетки (RUS, INT, FR)

description
string

Сокращенное название размерной сетки (RUS, INT, FR)

sizeType
string

Тип размера

Enumeration:
RU
EU
US
INT
UK
FR
IT
DE
AU
JPN
INCHES
CENTIMETERS
COLLAR_CENTIMETERS
COLLAR_INCHES
RING_RUSSIAN
RING_EUROPEAN
JEANS
HEIGHT
AGE
NO_SIZE
BUST
OfferDTO

Информация о предложении продавца

Object
id
integer int64
comparisonCriteria
Array
Unique items: YES
string
Enumeration:
PRICE
DELIVERY_DATE
shipmentId
integer int64

Идентификатор заявки

Продавец

Магазин

Товар

type
string

Типы предложений товаров/услуг

Enumeration:
PLATFORM_PRODUCT
BUYER_OFFER
sellerType
string

Тип продавца

creationDate
string date-time

Дата создания предложения

buyerOffers
BargainLiteDTO

Сокращенная информация о контрторге

Object
id
integer int64 required

Идентификатор контрторга

state
BargainStateDTO required

Статус контрторга

product

Товар

size
BargainSizeDTO required

Размер

basePrice
integer int32 required

Первоначальная цена на момент создания контрторга

lastPrice
integer int32 required

Последняя предложенная цена

buyer
BargainUserDTO required

Покупатель

seller
BargainUserDTO required

Продавец

createTime
string date-time required

Дата создания

changeTime
string date-time

Дата обновления

timeLeft
integer int64

Сколько времени осталось до принятия решения покупателем или продавцом (секунды)

attemptsLeft
integer int32

Сколько попыток осталось

PayoutInfoDTO

Цена товара

Object
value
number

Сумма

currencyCode
string

Код валюты

PositionDetailsDTO
Object
text
string
positionId
integer int64
OrderTrackActionDTO

Действие заказа, связанное с этапом

Object
title
string

Отображаемое имя действия

type
string
Enumeration:
CHANGE_PICKUP_DATE

выбрать новую дату (изменение даты и интервала забора у Продавца)

PAY_OSKELLY_SERVICE

оплатить услуги Oskelly (плата за проверку оригинальности в случае если оригинальность не пройдена, химчистку и т д)

GO_TO_NEGOTIATION

перейти к согласованию (согласование дефектов)

GO_TO_DETAILS_INFO

подробнее (про химчистку)

CHANGE_DELIVERY_DATE

выбрать дату доставки (для покупателя доставка к нему после экспертизы)

CONFIRM_DELIVERY

подтвердить получение заказа (для Покупателя)

CONFIRM_PAYOUT_DETAILS

подтвердить реквизиты для выплаты (для Продавца)

MediaType
Object
type
string
subtype
string
parameters
Object
additional properties
string
qualityValue
number double
concrete
boolean
wildcardType
boolean
wildcardSubtype
boolean
charset
string
SellerInfoDTO

Информация о продавце/шопера товара

Object
sellerId
integer int64

Тип продавца

sellerFio
string

ФИО продавца/шопера

sellerEmail
string

Электронная почта продавца/шопера

sellerNickname
string

Никнейм продавца/шопера в системе

urlAvatar
string

Ссылка на аватар продавца/шопера

ShopperInfoDTO

Информация о покупателе(шопере)

Object
id
integer int64
userId
integer int64

Идентификатор пользователя (шопера)

nickName
string

Никнейм шопера

fio
string

ФИО шопера

urlAvatar
string

URL аватара

interactionTypes

Типы взаимодействия

ProductPlatformDTO

Продукт с платформы

Object
productId
integer int64

Идентификатор товара, существующего на платформе

currencyPrice
number

Цена в валюте

productPhoto

Фото товара

productLocation
string

Расположение товара

brand
string

Бренд

productCategory
string

Категория товара

availableSizes
Array of string

Размеры в наличии

priceWithoutDiscount
number

Цена без скидки

priceWithDiscount
number

Цена со скидкой (при наличии)

discountAmount
number

Размер скидки (при наличии)

sizeType
string

Тип размера

conditionId
integer int32

Идентификатор состояния товара

conditionName
string

Название состояния товара

productState
string

Состояние публикации товара

likesCount
integer int32

Количество лайков

isLiked
boolean

Флаг, указывающий, лайкнут ли товар пользователем

url
string

URL товара

discount
number

Размер скидки в процентах

currency

Тип валюты

BuyerOffers
Object
proposedOffers
Unique items: YES
BargainStateDTO

Статус контрторга

Object
name
string required

Статус контрторга

Enumeration:
INITIAL

Статус до создания торга (в шаблоне)

OFFER

Покупатель сделал предложение и ждет ответа продавца

COUNTER_OFFER

Продавец сделал встречное предложение со своей ценой

DECLINED

Отклонено продавцом

CONFIRMED

Подтверждено продавцом

SOLD

Товар продан или более недоступен

CONSUMED

Товар куплен покупателем по цене торгов

EXPIRED

Покупатель не успел воспользоваться предложением

CANCELLED

Отменен (по другим причинам, н.п. изменение цены)

UNDEFINED

Неопределенное состояние контрторга ()когда по каким-то причинам не удалось выяснить новое состояние

UNAVAILABLE

Состояние товара изменилось с PUBLISHED на другое

title
string required

Человекочитаемое название статуса

decoration
string required

Декорация статуса

Enumeration:
NEGATIVE
POSITIVE
NEUTRAL
BargainProductDTO
Object
id
integer int64 required
title
string required

Название товара

image
string required

Изображение товара

withBadge
boolean required

С биркой

isLiked
boolean required

Лайкнут текущим пользователем

likesCount
integer int32 required

Количество лайков

commentsCount
integer int32 required

Количество комментариев

isSubscribed
boolean required

Наличие подписки от текущего пользователя

subscribersCount
integer int32 required

Количество подписчиков

category
inBoutique
boolean required

Товар находится в бутике

BargainSizeDTO
Object
id
integer int64 required
title
string required

Название размера

sizeType
string

Тип размера

Enumeration:
RU
EU
US
INT
UK
FR
IT
DE
AU
JPN
INCHES
CENTIMETERS
COLLAR_CENTIMETERS
COLLAR_INCHES
RING_RUSSIAN
RING_EUROPEAN
JEANS
HEIGHT
AGE
NO_SIZE
BUST
BargainUserDTO
Object
id
integer int64 required
nickname
string required

Никнейм

avatar
string

Аватар

isPro
boolean

Является бутиком (PRO-продавцом)

type
string

Тип продавца для отображения, н.п. Бутик

DescriptionStructureEnum

Структура описания перечисляемого значения с локализацией

Object
code
string

Код значения (техническое обозначение)

localizedDescription
string

Локализованное описание значения

ImageDTO

Информация об изображении

Object
id
string uuid
url
string

URL для доступа к изображению

creationDate
string date-time

Дата и время загрузки изображения

ProposedOfferDTO

Данные о предложении продавца

Object
id
integer int64
proposedProductId
integer int64

Уникальный идентификатор товара предложения

rublePrice
number

Цена предложения в рублях

deliveryDate
string date-time

Дата доставки по предложению

validUntil
string date-time

Срок действия предложения

creationDate
string date-time

Дата создания предложения

currency
string

Валюта закупки

Enumeration:
USD

Доллар США

AED

Дирхам ОАЭ

EUR

Евро

KRW

Южнокорейская вона

KGS

Кыргызский сом

RUB

Российский рубль

TL

Турецкая лира

CNY

Китайский юань

JPY

Японская иена

currencyPrice
number

Цена в валюте закупки

currencyRate
number

Курс валюты к рублю

hasReceipt
boolean

Флаг наличия чека

isCompleteSet
boolean

Флаг полного комплекта товара

hasCustomCommission
boolean

Флаг произвольной комиссии

commission
number

Размер комиссии в процентах

comment
string

Комментарий к предложению

productCondition

Состояние товара

offerId
integer int64

Идентификатор оффера, к которому относится предложение

BargainCategoryDTO

Категория товар контрторга

Object
id
integer int64 required
title
string required

Название категории

ProductConditionDTO

Описание состояния товара

Object
id
integer int64

ID состояния товара в монолите

name
string

Название состояния товара

description
string

Описание состояния товара

Api2ResponseInitOrderResult
Object
message
string

Техническое описание ошибки/успешного запроса

humanMessage
string

Описание ошибки понятное пользователю

Данные

errorData
Object

Описание ошибки

validationMessages
Object

Развернутое описание ошибки валидации полей

additional properties
string
timestamp
integer int64

Время отправки запроса

executionTimeMillis
integer int64

Время выполнения запроса

success
boolean

Признак успешного запроса

InitOrderResult

Response payload

Object
orderId
integer int64
bank_url
string
paymentSystem
string
Api2ResponseOrderDTO
Object
message
string

Техническое описание ошибки/успешного запроса

humanMessage
string

Описание ошибки понятное пользователю

data

Данные

errorData
Object

Описание ошибки

validationMessages
Object

Развернутое описание ошибки валидации полей

additional properties
string
timestamp
integer int64

Время отправки запроса

executionTimeMillis
integer int64

Время выполнения запроса

success
boolean

Признак успешного запроса