logo
API docs by Redocly

RDV API (v.20241228)

Download OpenAPI specification:Download

Описание RDV API

Подключение к RDV API позволяет настроить единую интеграцию для работы с 4 крупнейшими маркетплейсами по схемам FBS и FBM. Методы работы унифицированы вне зависимости от требований маркетплейсов. Т.е. если изменился остаток по товару, который продается в 3х разных личных кабинетах, то достаточно вызвать метод передачи измененного остатка один раз, после чего сервис самостоятельно распределит остатки по личным кабинетам в соответсвии с требованиями маркетплейсов

Подключение к сервису

Управление подключением к сервису RDV API

Подключиться к сервису

Передает в сервис параметр clientKey - идентификатор рабочей системы клиента.

По этому параметру в заголовке запроса сервис идентифицирует обращения из рабочей системы клиента. Поэтому важно, чтобы в тестовые экземпляры системы имели значение ключа, отличное от рабочей системы. Например, реализовать ключ вычисляемым по параметрам среды размещения или передавать уникальное наименование рабочей системы. В примере ниже значение ключа - хеш адреса информационной базы клиента.

Request Body schema: application/json
clientKey
required
string (clientKey) <= 100 characters

Ключ системы клиента

clientInfo
string

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

Responses

Request samples

Content type
application/json
{
  • "clientKey": "E89F93E81A80B470B737820D78BBD2CA",
  • "clientInfo": "Client base"
}

Response samples

Content type
applcation/json
Example
{
  • "success": true
}

Проверить подключения к сервису

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

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Responses

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": {
    }
}

Подключение к личным кабинетам

Методы подключения к личным кабинетам маркетплейсов

Изменить подключение к личному кабинету

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

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: applcation/json
apiId
required
string <uuid> (apiID) <= 50 characters

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

name
required
string

Наименование личного кабинета

marketplace
required
string (marketplace)
Enum: "Ozon" "WB" "Yandex" "Mega"

Маркетплейс

fbs
boolean
Default: false

Продажи по схеме FBS

fbo
boolean
Default: false

Продажи по схеме FBO

dbs
boolean
Default: false

Продажи по схеме DBS

dropshipping
boolean
Default: false

Продажи по схеме дропшиппинга

finance
boolean
Default: false

Расчет финансовых показателей

isExchangeActive
boolean
Default: false

Обмен с личным кабинетом включен

isOrderExchangeActive
boolean
Default: false

Обмен заказами с личным кабинетом включен

isPriceExchangeActive
boolean
Default: false

Обмен ценами с личным кабинетом включен

isStockExchangeActive
boolean
Default: false

Обмен остатками с личным кабинетом включен

dateStartOrderExchange
string <date>

Дата начала загрузки заказов

loadReservesWithoutOrder
boolean
Default: false

Загружать резервы без заказа. Параметр применим только к личным кабинетам Ozon и обеспечивает загрузку данных из корзины и отражение в резервах

useMinStock
boolean
Default: false

Использовать минимальный остаток при отправке данных в личный кабинет

minStock
integer

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

ozon_сlientId
string

Параметр для личных кабинетов Ozon. Значение clientId

ozon_apiKey
string

Параметр для личных кабинетов Ozon. Значение apiKey

wb_token
string

Параметр для личных кабинетов WB. Токен для работы с остатками, ценами и заказами

wb_tokenForStatistics
string

Параметр для личных кабинетов WB. Токен для работы со статистикой и финансами

wb_disableRequestingCIS
boolean
Default: false

Параметр для личных кабинетов WB. Настройка отключения контроля маркировки Честный знак при упаковке заказов

yandex_campaingId
string

Параметр для личных кабинетов Яндекс Маркет. Идентификатор кампании

yandex_storeId
string

Параметр для личных кабинетов Яндекс Маркет. Номер магазина

yandex_businessId
string

Параметр для личных кабинетов Яндекс Маркет. Идентификатор кабинета

yandex_apiKey
string

Параметр для личных кабинетов Яндекс Маркет. Токен api-key

Responses

Request samples

Content type
applcation/json
{
  • "apiId": "2500ac85-f71b-4d01-b32c-62f3af3fe2c5",
  • "name": "string",
  • "marketplace": "Ozon",
  • "fbs": false,
  • "fbo": false,
  • "dbs": false,
  • "dropshipping": false,
  • "finance": false,
  • "isExchangeActive": false,
  • "isOrderExchangeActive": false,
  • "isPriceExchangeActive": false,
  • "isStockExchangeActive": false,
  • "dateStartOrderExchange": "2019-08-24",
  • "loadReservesWithoutOrder": false,
  • "useMinStock": false,
  • "minStock": 0,
  • "ozon_сlientId": "string",
  • "ozon_apiKey": "string",
  • "wb_token": "string",
  • "wb_tokenForStatistics": "string",
  • "wb_disableRequestingCIS": false,
  • "yandex_campaingId": "string",
  • "yandex_storeId": "string",
  • "yandex_businessId": "string",
  • "yandex_apiKey": "string"
}

Response samples

Content type
applcation/json
Example
{
  • "success": true
}

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

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

query Parameters
apiId
string <uuid> (apiID) <= 50 characters

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

Responses

Response samples

Content type
applcation/json
Example
{
  • "success": true
}

Получить подключения к личным кабинетам

Метод возвращает список ранее созданных подключений к личным кабинетам маркетплейсов

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Responses

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": {
    }
}

Склады

Методы работы со складами

Получить склады в личном кабинете

Метод возвращает список складов в личном кабинете маркетплейса

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
required
string <uuid> (apiID) <= 50 characters

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

apiIds
Array of strings <uuid> (apiID) [ items <uuid > <= 50 characters ]

Массив складов в личном кабинете для отбора

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "apiIds": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": [
    ]
}

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

Метод позволяет создать новое или редактировать добавленное ранее место хранения по данным складов в клиенсткой системе

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "errors": [
    ]
}

Получить места хранения

Метод возвращает список ранее добавленных мест хранения

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Responses

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": [
    ]
}

Связать места хранения и склады в личном кабинете

Метод позволяет связать места хранения со складами в личном кабинете для дальнейшей маршрутизации отправки остатков в личные кабинеты маркетплейсов

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
required
string <uuid> (apiID) <= 50 characters

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

stockWarehouseApiId
required
string <uuid> (apiID) <= 50 characters

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

accountWarehouseApiId
required
string <uuid> (apiID) <= 50 characters

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

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "stockWarehouseApiId": "6901df20-f4ee-4b83-a1c8-aa71596266a7",
  • "accountWarehouseApiId": "0dfdd94c-8bb1-4446-84ec-29d87f1f49bb"
}

Response samples

Content type
applcation/json
Example
{
  • "success": true
}

Товары продавца

Методы работы с бизнес-номенклатурой

Изменить товар продавца

Метод позволяет добавлять новые и редактировать ранее созданные товары продавца по данным бизнес-номенклатуры в клиентской системе.

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true
}

Получить товары продавца

Метод возвращает список ранее добавленных товаров продавца. Поддерживает пагинацию, листать данные необходимо с использованием параметра lastApiId

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
limit
integer
Default: 100

Количество товаров в порции ответа

lastApiId
string <uuid> (apiID) <= 50 characters

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

object

Responses

Request samples

Content type
application/json
{
  • "limit": 100,
  • "lastApiId": "ecc71882-cbf4-4916-9583-0adb51984d52",
  • "filter": {
    }
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": {
    }
}

Товары маркетплейса

Метода работы с карточками личных кабинетов

Изменить товары маркетплейса

Метод позволяет создавать новые и редактировать существующие товары маркетплейсов по данным ранее созданных в личном кабинете карточек товаров

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
required
string <uuid> (apiID) <= 50 characters

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

marketplace
required
string (marketplace)
Enum: "Ozon" "WB" "Yandex" "Mega"

Маркетплейс

updateFromMarketplace
boolean
Deprecated

Параметр устарел

required
Array of objects

Массив товаров маркетплейсов

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "marketplace": "Ozon",
  • "updateFromMarketplace": true,
  • "items": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "errors": [
    ]
}

Получить товары маркетплейса

Метод возвращает список ранее добавленных товаров маркетплейса. Поддерживает пагинацию, листать данные необходимо с использованием параметра lastApiId

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
limit
integer
Default: 100

Количество товаров в порции ответа

lastApiId
string <uuid> (apiID) <= 50 characters

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

accountApiId
required
string <uuid> (apiID) <= 50 characters

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

object

Отборы

Responses

Request samples

Content type
application/json
{
  • "limit": 100,
  • "lastApiId": "ecc71882-cbf4-4916-9583-0adb51984d52",
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "filter": {
    }
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": {
    }
}

Цены

Методы передачи цен

Получить типы цен маркетплейсов

Метод возвращает список типов цен для каждого маркетплейса

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
marketplace
required
string (marketplace)
Enum: "Ozon" "WB" "Yandex" "Mega"

Маркетплейс

apiIds
Array of strings <uuid> (apiID) [ items <uuid > <= 50 characters ]

Массив идентификатор типов цен для отбора

Responses

Request samples

Content type
application/json
{
  • "marketplace": "Ozon",
  • "apiIds": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": [
    ]
}

Установить цены товаров маркетплейсов

Метод позволяет устанавливать цены товаров маркетплейсов

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
required
Array of objects

Массив товаров маркетплейсов

Responses

Request samples

Content type
application/json
{
  • "cards": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "errors": [
    ]
}

Остатки

Методы передачи остатков

Установить остатки товаров продавца

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

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
Array of objects

Массив остатков

reserves
Array of strings <uuid> (apiID) [ items <uuid > <= 50 characters ]

Массив идентификаторов резервов

Responses

Request samples

Content type
application/json
{
  • "stocks": [
    ],
  • "reserves": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "errors": [
    ]
}

Получить резервы

Метод возвращает список резервов по заказам, которые не отражены в клиентской системе

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "filters": {
    }
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": {
    }
}

Получить резервы без заказа

Метод возвращает резервы, сформированные по даным корзины Ozon. Применим только в случае, если в личном кабинете установлен признак Загружать резервы без заказа

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
string <uuid> (apiID) <= 50 characters

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

apiIds
Array of strings <uuid> (apiID) [ items <uuid > <= 50 characters ]

Массив идентификаторов резервов без заказа

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "apiIds": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": [
    ]
}

Получить остатки на складах маркетплейсов

Метод возвращает остатки товаров на складах маркетплейсов, доступные к продаже по схеме FBM

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
required
string <uuid> (apiID) <= 50 characters

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

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413"
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": [
    ],
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413"
}

Получение изменений

Методы получения измененных объектов от сервиса

Получить список измененных объектов

Метод возвращает список измененных объектов, которые необходимо загрузить в клиентскую систему. После разбора ответа необходимо вызвать методы в соответсвии с типами измененных объектов и отбором по полученным идентификаторам

query Parameters
boundary
integer
Default: 0

Граница полученных данных

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Responses

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": [
    ]
}

Очистить очередь измененных объектов Deprecated

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
boundary
integer
Default: 0

Responses

Request samples

Content type
application/json
{
  • "boundary": 0
}

Response samples

Content type
applcation/json
Example
{
  • "success": true
}

Заказы

Методы работы с заказами

Получить заказы

Метод возвращает список заказов из личного кабинета

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
required
string <uuid> (apiID) <= 50 characters

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

dateCreateFrom
string <date>

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

dateCreateTo
string <date>

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

dateUpdateFrom
string <date>

Дата обновления заказа с

dateUpdateTo
string <date>

Дата обновления заказа по

apiIds
Array of strings <uuid> (apiID) [ items <uuid > <= 50 characters ]

Массив идентификаторов заказов

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "dateCreateFrom": "2019-08-24",
  • "dateCreateTo": "2019-08-24",
  • "dateUpdateFrom": "2019-08-24",
  • "dateUpdateTo": "2019-08-24",
  • "apiIds": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": [
    ]
}

Подтвердить заказ

Метод позволяет подтвердить заказ с этапом "Требует подтверждения"

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
orderApiId
required
string <uuid> (apiID) <= 50 characters

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

required
Array of objects

Массив позиций заказа

Responses

Request samples

Content type
application/json
{
  • "orderApiId": "a7f0ba16-00d1-4ab6-a109-b2b415c48601",
  • "positions": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true
}

Отменить заказ

Метод позволяет отменить заказ. Применим только для неупакованных заказов

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
orderApiId
required
string <uuid> (apiID) <= 50 characters

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

Responses

Request samples

Content type
application/json
{
  • "orderApiId": "a7f0ba16-00d1-4ab6-a109-b2b415c48601"
}

Response samples

Content type
applcation/json
Example
{
  • "success": true
}

Упаковать заказ

Метод позволяет упаковать заказ в грузовые места

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
orderApiId
required
string <uuid> (apiID) <= 50 characters

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

required
Array of objects

Массив грузовых мест

Responses

Request samples

Content type
application/json
{
  • "orderApiId": "a7f0ba16-00d1-4ab6-a109-b2b415c48601",
  • "cargoUnits": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": {
    }
}

Печатные формы

Методы для печати этикеток и других форм

Получить печатную форму объекта

Метод позволяет получить указанную печатную форму для объекта в заданном формате

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
printform
required
string (printform)
Enum: "label" "goodsLabel" "tempLabel" "containerLabels" "act" … 5 more

Тип печатной формы

format
required
string (printformFormat)
Enum: "mxl" "pdf"

Формат файла печатной формы

required
object (printformSubject)

Описание объекта

Responses

Request samples

Content type
application/json
{
  • "printform": "label",
  • "format": "mxl",
  • "object": {
    }
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": [
    ]
}

Получить печатные формы объектов

Метод позволяет получить указанные печатные формы для заданных объектов

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
printform
required
string (printform)
Enum: "label" "goodsLabel" "tempLabel" "containerLabels" "act" … 5 more

Тип печатной формы

format
required
string (printformFormat)
Enum: "mxl" "pdf"

Формат файла печатной формы

required
Array of objects (printformSubject)

Массив объектов

Array of objects

Responses

Request samples

Content type
application/json
{
  • "printform": "label",
  • "format": "mxl",
  • "objects": [
    ],
  • "additionalParameters": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": {
    }
}

Отгрузки FBS

Методы лоя работы с отгрузками по схеме FBS

Создать отгрузку FBS

Метод позволяет создать отгрузку FBS

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
required
string <uuid> (apiID) <= 50 characters

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

ozon_accountWarehouseApiId
string <uuid> (apiID) <= 50 characters

Параметр для отгрузок Ozon. Склад в дичном кабинете с настройкой доверительной отгрузки

ozon_containersCount
integer

Параметр для отгрузок Ozon. Количество паллет доверительной отгрузки

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "ozon_accountWarehouseApiId": "93cd9d6c-bb30-423b-97ea-d6496c8225ae",
  • "ozon_containersCount": 0
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": {
    }
}

Получить отгрузки FBS

Метод возвращает отгрузки FBS из личного кабинета

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
required
string <uuid> (apiID) <= 50 characters

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

dateCreateFrom
string <date>

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

dateCreateTo
string <date>

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

status
string (shipmentStatus)
Enum: "active" "shipped" "canceled"

Статус отгрузки

apiIds
Array of strings <uuid> (apiID) [ items <uuid > <= 50 characters ]

Массив идентификаторов отгрузок

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "dateCreateFrom": "2019-08-24",
  • "dateCreateTo": "2019-08-24",
  • "status": "active",
  • "apiIds": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": [
    ]
}

Добавить заказы в отгрузку FBS

Метод позволяет добавить заказ в отгрузку FBS

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
required
string <uuid> (apiID) <= 50 characters

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

shipmentApiId
required
string <uuid> (apiID) <= 50 characters

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

required
Array of objects

Массив заказов

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "shipmentApiId": "38ecdecf-3ea6-4fa2-8e4f-aeee8c0e0b68",
  • "content": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true
}

Удалить заказы из отгрузки FBS

Метод позволяет удалять заказы из отгрузки FBS до момент передачи в доставку. Применим только к отгрузкам WB

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
required
string <uuid> (apiID) <= 50 characters

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

shipmentApiId
required
string <uuid> (apiID) <= 50 characters

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

required
Array of objects

Массив заказов

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "shipmentApiId": "38ecdecf-3ea6-4fa2-8e4f-aeee8c0e0b68",
  • "content": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true
}

Подтвердить отгрузку FBS

Метод позволяет подтвердить отгрузку FBS

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
required
string <uuid> (apiID) <= 50 characters

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

shipmentApiId
required
string <uuid> (apiID) <= 50 characters

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

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "shipmentApiId": "38ecdecf-3ea6-4fa2-8e4f-aeee8c0e0b68"
}

Response samples

Content type
applcation/json
Example
{
  • "success": true
}

Сверить состав отгрузки FBS Deprecated

Метод не используется

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
required
string <uuid> (apiID) <= 50 characters
shipmentApiId
required
string <uuid> (apiID) <= 50 characters

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "shipmentApiId": "38ecdecf-3ea6-4fa2-8e4f-aeee8c0e0b68"
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": {
    }
}

Создать отгрузку FBS Deprecated

Метод позволяет создать отгрузку FBS. Устарел, для создания отгрузки рекомендовано перейти на метод v2

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
required
string <uuid> (apiID) <= 50 characters

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

ozon_accountWarehouseApiId
string <uuid> (apiID) <= 50 characters

Параметр для отгрузок Ozon. Склад в дичном кабинете с настройкой доверительной отгрузки

ozon_containersCount
integer

Параметр для отгрузок Ozon. Количество паллет доверительной отгрузки

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "ozon_accountWarehouseApiId": "93cd9d6c-bb30-423b-97ea-d6496c8225ae",
  • "ozon_containersCount": 0
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": {
    }
}

Поставки FBM

Методы для работы с поставками FBM

Получить склады маркетплейсов

Метод возвращает список складов маркетплейсов для поставок FBM

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
apiId
required
string <uuid> (apiID) <= 50 characters

Идентификатор склада маркетплейса

Responses

Request samples

Content type
application/json
{
  • "apiId": "2500ac85-f71b-4d01-b32c-62f3af3fe2c5"
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": [
    ]
}

Изменить поставку FBM

Метод позволяет создать новую или изменить не отгруженную поставку FBM

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountId
required
string <uuid> (apiID) <= 50 characters

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

apiId
required
string <uuid> (apiID) <= 50 characters

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

shipmentDate
string <date-time>

Дата отгрузки по данным личного кабинета

shipmentNumber
string

Номер поставки по данным личного кабинета

stockWarehouseApiId
required
string <uuid> (apiID) <= 50 characters

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

marketplaceWarehouseApiId
required
string <uuid> (apiID) <= 50 characters

Идентификатор склада маркетплейса, на который выполняется поставка

shipmentStatus
required
string (shipmentFBOStatus)
Enum: "new" "onAssembly" "forShipment" "shipped" "accept" … 1 more

Статус поставки FBM

Array of objects

Responses

Request samples

Content type
application/json
{
  • "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
  • "apiId": "2500ac85-f71b-4d01-b32c-62f3af3fe2c5",
  • "shipmentDate": "2019-08-24T14:15:22Z",
  • "shipmentNumber": "string",
  • "stockWarehouseApiId": "6901df20-f4ee-4b83-a1c8-aa71596266a7",
  • "marketplaceWarehouseApiId": "f8fd7de4-3c90-4a0d-a756-44b1e723ec12",
  • "shipmentStatus": "new",
  • "items": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "errors": [
    ]
}

Получить поставки FBM

Метод возвращает список поставок из личного кабинета

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
required
string <uuid> (apiID) <= 50 characters

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

shipmentStatus
string (shipmentFBOStatus)
Enum: "new" "onAssembly" "forShipment" "shipped" "accept" … 1 more

Статус поставок

apiIds
Array of strings <uuid> (apiID) [ items <uuid > <= 50 characters ]

Массив идентификаторов поставок

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "shipmentStatus": "new",
  • "apiIds": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": [
    ]
}

Упаковать поставку FBM

Метод позволяет упаковать поставку в грузовые места

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
shipmentApiId
required
string <uuid> (apiID) <= 50 characters

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

required
Array of objects

Массив грузовых мест

Responses

Request samples

Content type
application/json
{
  • "shipmentApiId": "38ecdecf-3ea6-4fa2-8e4f-aeee8c0e0b68",
  • "cargoUnits": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true
}

Финансы

Методы для формирования агрегированных финансовых показателей по отчетным данным маркетплейсов

Получить список финансовых показателей

Метод возвращает список финансовых показателей, к которым будет приведены исходные данные от маркетплейсов

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
apiIds
Array of strings <uuid> (apiID) [ items <uuid > <= 50 characters ]

Массив идентификаторов показателей

Responses

Request samples

Content type
application/json
{
  • "apiIds": [
    ]
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": [
    ]
}

Загрузить исходные финансовые данные

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
required
string <uuid> (apiID) <= 50 characters

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

typeData
required
integer [ 1 .. 4 ]

Тип исходного файла

dateFrom
required
string <date>

Начало расчетного периода

dateTo
required
string <date>

Конец расчетного периода

file
string <base64>

Файл с исходным отчетом маркетплейса в формате base64

fileExtension
string

Тип файла с исходными данными

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "typeData": 1,
  • "dateFrom": "2019-08-24",
  • "dateTo": "2019-08-24",
  • "file": "string",
  • "fileExtension": "string"
}

Response samples

Content type
applcation/json
Example
{
  • "success": true
}

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

Метод возвращает таблицу значений финансовых показателей, расчитанную на основании переданных исходных данных

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
required
string <uuid> (apiID) <= 50 characters

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

dateFrom
required
string <date>

Начало расчетного периода

dateTo
required
string <date>

Конец расчетного периода

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "dateFrom": "2019-08-24",
  • "dateTo": "2019-08-24"
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": [
    ],
  • "salesAnalytics": [
    ],
  • "typeDataStatus": {
    }
}

Получить агрегированные финансовые показатели Deprecated

Метод устарел и не используется

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
string <uuid> (apiID) <= 50 characters
dateFrom
string <date>
dateTo
string <date>

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "dateFrom": "2019-08-24",
  • "dateTo": "2019-08-24"
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": [
    ]
}

Агрегированные фин. показатели Deprecated

Метод устарел и не используется

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
string <uuid> (apiID) <= 50 characters
dateFrom
string <date>
dateTo
string <date>

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "dateFrom": "2019-08-24",
  • "dateTo": "2019-08-24"
}

Response samples

Content type
applcation/json
Example
{
  • "success": true,
  • "data": [
    ]
}

Загрузить исходные финансовые данных Deprecated

Метод устарел и не используется

header Parameters
token
required
string <= 100 characters

Токен подключения к сервису

clientKey
required
string (clientKey) <= 100 characters

Идентификатор клиентской системы

Request Body schema: application/json
accountApiId
string <uuid> (apiID) <= 50 characters
dateFrom
string <date>
dateTo
string <date>
file
string <base64>
fileExtension
string

Responses

Request samples

Content type
application/json
{
  • "accountApiId": "395f34b2-4811-4de1-82e2-cdafd4651413",
  • "dateFrom": "2019-08-24",
  • "dateTo": "2019-08-24",
  • "file": "string",
  • "fileExtension": "string"
}

Response samples

Content type
applcation/json
Example
{
  • "success": true
}