Начало работы
В документе описаны методы Ozon Seller API — программного интерфейса для работы с маркетплейсом Ozon.
Основные категории методов Seller API:
Запросы выполняются по протоколу HTTP методами POST или GET. Входные и выходные структуры данных передаются в теле запроса и ответа. API поддерживает формат взаимодействия JSON. В ответе в HTTP-заголовке передается идентификатор связки запрос-ответ — Trace-ID.
Авторизация
Пример запроса:
GET / HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: <Client-Id>
Api-Key: <Api-Key>
Content-Type: application/json
Доступ к API могут получить только пользователи зарегистрированные в Ozon Seller. Для каждого запроса нужно указывать идентификатор клиента и его API-ключ:
- В личном кабинете перейдите в настройки, на вкладку API-ключи.
- Введите название для ключа и нажмите "Создать ключ" — ниже появится список ваших API-ключей.
- Вы можете создать несколько API-ключей, например, если у вас несколько магазинов на Маркетплейсе Ozon.
Тестовая среда
Пример запроса:
GET / HTTP/1.1
Host: cb-api.ozonru.me
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
Тестовая среда дублирует методы Seller API, но полностью изолирована от настоящих данных. Здесь можно пробовать вызывать методы API, получать ответы, наблюдать изменение тестовых данных. Запросы к тестовой среде не изменяют данные в Ozon Seller, созданные товары и заказы нигде не показываются.
Адрес для отправки тестовых запросов: cb-api.ozonru.me
Параметр | Описание |
---|---|
Client-Id | 836 |
Api-Key | 0296d4f2-70a1-4c09-b507-904fd05567b9 |
Рабочая среда
Пример запроса:
GET / HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: {Your Client-Id}
Api-Key: {Your API Key}
Content-Type: application/json
Запросы к API на рабочей среде меняют настоящие данные, поэтому будьте внимательны — созданные товары и заказы затрагивают реальных пользователей.
Адрес рабочей среды: api-seller.ozon.ru
Созданные товары можно посмотреть по ссылке вида
https://www.ozon.ru/context/detail/id/SKU
где вместо SKU нужно указать значение для созданного товара.
git
Атрибуты и категории товаров
На Ozon товары отличаются категориями и характеристикам — так пользователи могут найти нужный им продукт. Поэтому при создании товара, укажите подробную информацию о нем: выберите категорию и укажите характеристики. Для каждой категории товаров есть стандартный набор характеристик — можете использовать их или дополнить собственными. У категорий ниже второго уровня характеристики, как правило, одинаковые.
Список категорий и характеристик товаров на Ozon может меняться — обо всех крупных обновлениях мы делаем рассылку. Проверьте, что в личном кабинете актуальные данные.
Дерево категорий товаров
Пример запроса:
POST /v1/category/tree HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"category_id": 17036076,
"language": "EN"
}
Пример ответа:
{
"result": [
{
"category_id": 1,
"title": "Books",
"children": [
{
"category_id": 2,
"title": "Glossary",
"children": []
},
{
"category_id": 3,
"title": "Science Fiction",
"children": []
}
]
}
]
}
Чтобы документация становилась лучше, мы запустили опрос.
Получение категорий в виде дерева.
Создание товаров доступно только в категориях последнего уровня, соответственно вам необходимо сопоставить именно эти категории с категориями своей площадки.
Категории не создаются по запросу пользователя.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
category_id | int | Нет | Идентификатор категории. |
language | string | Нет | Language in which result will be returned. Possible values are: "EU" (Englush) and "RU" (Russian). By default, if key is not sent, Russian language is used |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список категорий. |
category_id | int | Идентификатор категории. |
title | string | Название категории |
children | array | Дерево подкатегорий |
Список характеристик категории
Пример запроса:
POST /v1/category/attribute HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"attribute_type": "required",
"category_id": 17036076,
"language": "EN"
}
Пример ответа:
{
"result": [
{
"id": 1,
"name": "Explosive",
"description": "Mark for product if it is explosive",
"type": "bool",
"is_collection": false,
"is_required": false,
"option": [],
"child": []
},
{
"id": 2,
"name": "Product name",
"description": "Full product name",
"type": "text",
"is_collection": false,
"is_required": true,
"option": [],
"child": []
},
{
"id": 3,
"name": "Size",
"description": "List of possible sizes",
"type": "text",
"is_collection": true,
"is_required": false,
"option": [],
"child": []
},
{
"id": 4,
"name": "Color",
"description": "Main color",
"type": "option",
"is_collection": false,
"is_required": false,
"option": [
{
"id": 1,
"value": "black"
},
{
"id": 2,
"value": "white"
}
],
"child": []
},
{
"id": 5,
"name": "Colors",
"description": "List of possible colors",
"type": "option",
"is_collection": true,
"is_required": false,
"option": [
{
"id": 1,
"value": "yellow"
},
{
"id": 2,
"value": "green"
}
],
"child": []
},
{
"id": 6,
"name": "Video",
"description": "Main video",
"type": "child",
"is_collection": false,
"is_required": false,
"option": [],
"child": [
{
"id": 10,
"name": "Name",
"description": "Name of video",
"type": "text",
"is_collection": false,
"is_required": false,
"option": []
},
{
"id": 11,
"name": "Url",
"description": "Url to video",
"type": "text",
"is_collection": false,
"is_required": false,
"option": []
}
]
},
{
"id": 7,
"name": "Videos",
"description": "List of videos",
"type": "child",
"is_collection": true,
"is_required": false,
"option": [],
"child": [
{
"id": 10,
"name": "Name",
"description": "Name of video",
"type": "text",
"is_collection": false,
"is_required": false,
"option": []
},
{
"id": 11,
"name": "Url",
"description": "Url to video",
"type": "text",
"is_collection": false,
"is_required": false,
"option": []
}
]
}
]
}
Получение характеристик для указанной категории товаров.
На каждой характеристике есть признак обязательности, если он пуст, то такую характеристику заполнять не обязательно.
Атрибуты бывают нескольких типов, в зависимости от типа меняется способ заполнения значения.
Встречаются характеристики, где нет важного значения, например для шапки нельзя указать пол: унисекс, необходимо указать два значения пол: мужской, женский.
Существуют системные характеристики, которые не будут отображаться пользователю, на основе которых происходит объединение товаров в одну группу. Примером является характеристика "Название модели" в категориях "Одежда", "Обувь".
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
category_id | int | Да | Идентификатор категории. |
attribute_type | string | Нет | Фильтр по характеристикам: required — обязательная, optional — дополнительная. |
language | string | Нет | Language in which result will be returned. Possible values are: "EU" (Englush) and "RU" (Russian). By default, if key is not sent, Russian language is used |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список характеристик категории. |
id | int | Идентификатор характеристики. |
name | string | Название товара. До 500 знаков. |
description | string | Описание характеристики. |
type | string | Тип характеристики: bool, text, option. |
is_collection | bool | Флаг, что характеристика — набор значений. |
is_required | bool | Флаг обязательной характеристики. |
option | array | Массив предустановленных значений характеристики. |
option.id | int | Идентификатор предустановленного значения характеристики. |
option.value | string | Текст для предустановленного значения характеристики. |
child | array | Массив дочерних хорактеристик. Структура дочерней и родительской характеристики должна совпадать. |
v2: Список характеристик категории
Пример запроса:
POST /v2/category/attribute HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"attribute_type": "required",
"category_id": 17036076,
"language": "EN"
}
Пример ответа:
{
"id": 1,
"name": "Explosive",
"description": "Mark for product if it is explosive",
"type": "bool",
"is_collection": false,
"is_required": false,
"group_id": 0,
"group_name": "",
"dictionary_id": 0
}
Чтобы документация становилась лучше, мы запустили опрос.
Возвращает список характеристик категории по ее идентификатору.
У некоторых категорий есть системные характеристики, которые скрыты от пользователя, но по ним товары объединяются в группы. Например, "Название модели" для категорй "Одежда" и "Обувь".
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
category_id | int | Да | Идентификатор категории. |
attribute_type | string | Нет | Фильтр по характеристикам: required — обязательная, optional — дополнительная. |
language | string | Нет | Язык текста в ответе: |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
id | int | Идентификатор характеристики. |
name | string | Название товара. До 500 знаков. |
description | string | Описание характеристики. |
type | string | Тип характеристики: bool, text, option. |
is_collection | bool | Флаг, что характеристика — набор значений. |
is_required | bool | Флаг обязательной характеристики. |
group_id | int | Идентификатор группы характеристик. |
group_name | string | Название группы характеристик. |
dictionary_id | int | Идентификатор справочника. |
Определение категории товара
Пример запроса:
POST /v1/product/classify HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"products": [
{
"offer_id": "147190464",
"shop_category_full_path": "Электроника/Телефоны и аксессуары/Смартфоны",
"shop_category": "Смартфоны",
"shop_category_id": 15502,
"vendor": "Apple, Inc",
"model": "iPhone XS 256GB Space Grey",
"name": "Смартфон Apple iPhone XS 256GB Space Grey",
"price": "100990",
"offer_url": "https://www.ozon.ru/context/detail/id/147190464/",
"img_url": "https://ozon-st.cdn.ngenix.net/multimedia/1024351473.jpg",
"vendor_code": "apple_inc",
"barcode": "190198794017"
}
]
}
Пример ответа:
{
"result": [
{
"offer_id": "147190464",
"category_id": 17039977,
"classifier_status": "CLASSIFIED"
}
]
}
Классификация товара по набору параметров в категорию на OZON. Обратите внимание, что классификатор работает в тестовом режиме, доступен только для товаров с описанием на русском языке и возвращает category_id для Production среды разработки. Возможна классификация до 100 товаров в одном запросе.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
barcode | string | Нет | Штрихкод товара. |
img_url | string | Нет | Ссылка на изображение формата http:// или https://. До 1000 знаков, форматы изображения JPEG или PNG. |
model | string | Нет | Модель товара. Например, "iPhone XS 256 GB Space Grey" - это модель, а "Apple, Inc" - производитель (vendor) |
name | string | Да | Название товара. До 500 знаков. |
offer_id | string | Да | Идентификатор товара в системе продавца. |
offer_url | string | Нет | Ссылка на товар на сайте продавца |
price | string | Нет | Цена товара с учетом скидок, отображается на карточке товара. Если на товар нет скидок — укажите значение old_price. |
shop_category | string | Нет | Категория, в которой находится товар, на сайте или в ERP системе продавца |
shop_category_full_path | string | Нет | Полный путь к категории на сайте или в ERP системе продавца |
shop_category_id | int | Нет | ID категории на сайте или в ERP системе продавца |
vendor | string | Нет | Производитель. До 100 знаков. |
vendor_code | string | Нет | Код производителя. До 100 знаков. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
offer_id | string | Идентификатор товара в системе продавца. |
category_id | int | Идентификатор категории. |
status | string | Результат обработки товара классификатором (CLASSIFIED/NOT_CLASSIFIED) |
Новые идентификаторы характеристик
Пример запроса:
POST /v2/category/attribute/value/by-option HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"options": [
{
"attribute_id": 8229,
"option_id": 400
}
],
"language": "EN"
}
Пример ответа:
{
"result": [
{
"id": 91466,
"option_id": 400,
"attribute_id": 8229,
"value": "Электрический насос"
}
]
}
Идентификаторы справочников и характеристик могут обновляться — чтобы узнать новое значение, укажите в запросе старый идентификатор.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
options | array | Нет | Массив идентификаторов. |
attribute_id | int | Нет | Старый идентификатор характеристики. |
option_id | int | Нет | Старый идентификатор справочника. |
language | string | Да | Язык текста в ответе: |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
id | int | Новый идентификатор. |
option_id | int | Старый идентификатор справочника. |
attribute_id | int | Старый идентификатор характеристики. |
value | string | Значение характеристики товара. |
Справочник характеристик
Пример запроса:
POST /v2/category/attribute/values HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"category_id": 17036076,
"attribute_id": 8229,
"language": "EN",
"last_value_id": 0,
"limit": 1
}
Пример ответа:
{
"result": [
{
"id": 115845746,
"value": "President",
"picture": "http://cdn1.ozone.ru/multimedia/1029443311.jpg",
"info": "Продукты питания"
}
]
}
Метод возвращает справочник для категории или характеристики товара.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
category_id | int | Да | Идентификатор категории. |
attribute_id | int | Да | Идентификатор характеристики. |
last_value_id | int | Нет | Идентификатор, с которого начать ответ. Например, если last_value_id = 345, то в ответе будут значения начиная c id = 346. |
limit | int | Да | Количество отправлений в ответе. Максимум — 50, минимум — 1. |
language | string | Нет | Язык текста в ответе: |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
id | int | Идентификатор характеристики товара. |
value | string | Значение характеристики товара. |
picture | string | URL изображения товара. |
info | string | Информация о категории товаров, в которой доступна характеристика. |
Управление товарами и ценами
Добавить товары на Ozon можно в личном кабинете, через XLS-шаблон или с помощью методов Seller API. Перед публикацией на Маркетплейсе товары проходят модерацию.
Для пробной интеграции рекомендуем загружать товары по одному, а не пакетами — так они быстрее пройдут проверку.
Если при добавлении товаров возникли ошибки, исправьте их и загрузите товары ещё раз. Часть данных о товаре нельзя изменить:
- код поставщика — offer_id;
- категория товара — category_id;
- если наши сотрудники измерили товар на складе — габариты товара;
- если товар уже объединен с другими в карточке, нельзя изменить данные о товаре.
Добавить товар
Пример запроса:
POST /v1/product/import HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"items": [{
"barcode": "8801643566784",
"description": "Red Samsung Galaxy S9 with 512GB",
"category_id": 17030819,
"name": "Samsung Galaxy S9",
"offer_id": "REDSGS9-512",
"price": "79990",
"old_price": "89990",
"premium_price": "75555",
"vat": "0",
"vendor": "Samsung",
"vendor_code": "SM-G960UZPAXAA",
"height": 77,
"depth": 11,
"width": 120,
"dimension_unit": "mm",
"weight": 120,
"weight_unit": "g",
"images": [
{
"file_name": "https://ozon-st.cdn.ngenix.net/multimedia/c1200/1022555115.jpg",
"default": true
},
{
"file_name": "https://ozon-st.cdn.ngenix.net/multimedia/c1200/1022555110.jpg",
"default": false
},
{
"file_name": "https://ozon-st.cdn.ngenix.net/multimedia/c1200/1022555111.jpg",
"default": false
}
],
"attributes": [
{
"id": 8229,
"value": "4747"
},
{
"id": 9048,
"value": "Samsung Galaxy S9"
},
{
"id": 4742,
"value": "512 ГБ"
},
{
"id": 4413,
"collection": ["1", "2", "13"]
},
{
"id": 4018,
"complex_collection": [
{
"collection": [
{
"id": 4068,
"value": "Additional video"
},
{
"id": 4074,
"value": "5_-NKRVn7IQ"
}
]
},
{
"collection": [
{
"id": 4068,
"value": "Another one video"
},
{
"id": 4074,
"value": "5_-NKRVn7IQ"
}
]
}
]
}
]
}]
}
Пример ответа:
{
"result": {
"task_id": 123
}
}
Позволяет создавать и обновлять товары. За один запрос можно создать до 1000 позиций. Обновление товаров через этот метод ставит товары в очередь на повторную модерацию, поэтому данный метод лучше использовать только для обновления отдельных полей у товаров.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
barcode | string | Нет | Штрихкод товара. |
description | string | Да | Описание товара. Для переноса строки в описании используйте HTML-тег br. |
category_id | int | Да | Идентификатор категории. При создании товара в выбранной категории не должно быть других вложенных категорий. |
name | string | Да | Название товара. До 500 знаков. |
offer_id | string | Да | Идентификатор товара в системе продавца. |
price | string | Да | Цена товара с учетом скидок, отображается на карточке товара. Если на товар нет скидок — укажите значение old_price. |
old_price | string | Нет | Цена до скидок (будет зачеркнута на карточке товара). Указывается в рублях. Разделитель дробной части — точка, до двух знаков после точки. |
premium_price | string | Нет | Цена для клиентов с подпиской Ozon Premium. |
vat | string | Да | Ставка НДС для товара:
|
vendor | string | Нет | Производитель. До 100 знаков. |
vendor_code | string | Нет | Код производителя. До 100 знаков. |
attributes | array | Да | Массив характеристик товара. Чтобы узнать какие характеристики есть у категории товара, используйте метод Список характеристик категории. |
attributes.id | int | Да | Идентификатор характеристики. |
attributes.value | string | Нет | Значение характеристики. |
attributes.collection | array | Нет | Массив значений характеристики. Например, характеристика Цвет может принимать два значения: черный и белый. |
attributes.complex | array | Нет | Массив характеристик, которые поддерживают вложенные свойства. Например, у характеристики Процессор есть вложенные характеристики Производитель, L2 Cache, и другие. У каждой из вложенных характеристик может быть несколько вариантов значений. |
attributes.complex_collection | array | Нет | Массив характеристик с одинаковым названием, но разными значениями. Например, у CD диска с аудиокнигой может быть несколько характеристик Аудио дорожка, каждая из который будет иметь разные значения вложенных характеристик Длина дорожки, Битрейт и тому подобное. |
attributes.complex_collection. collection | array | Нет | Массив комплексных характеристик с мультивыбором. |
images | array | Да | Массив с изображениями, не больше 10. |
images.file_name | string | Да | Ссылка на изображение формата http:// или https://. До 1000 знаков, форматы изображения JPEG или PNG. |
images.default | bool | Да | Признак, позволяющий установить изображение основным. |
height | int | Да | Высота упаковки. |
depth | int | Да | Глубина упаковки. |
width | int | Да | Ширина упаковки. |
dimension_unit | string | Да | Единица измерения габаритов. Доступные варианты: mm (миллиметры), cm (сантиметры), in (дюймы). |
weight | int | Да | Вес товара в упаковке. Предельное значение - 1000 килограмм (или конвертированная величина в других единицах измерения). |
weight_unit | string | Да | Единицы измерения веса. Доступные варианты: g (граммы), kg (килограммы), lb (фунты). |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список идентификаторов заказов. |
task_id | int | Код задачи на импорт товаров. Статус выполнения задачи можно получить, используя метод Статус создания товара. |
Для того чтобы создать карточку товара с несколькими цветами/размерами, необходимо заполнить характеристику "Название модели" (8292). Товары одной модели, разных размеров и цветов должны иметь одинаковое значение в характеристике 8292.
Например, есть товар двух цветов (черный, белый) и 3 размеров (40, 42, 43). У всех этих товаров должно быть одинаковое значение характеристики 8292.
Цвет | Размер | 8292 Название модели |
---|---|---|
Черный | 40 | SAME_MODEL_NAME |
Черный | 42 | SAME_MODEL_NAME |
Черный | 43 | SAME_MODEL_NAME |
Белый | 40 | SAME_MODEL_NAME |
Белый | 42 | SAME_MODEL_NAME |
Белый | 43 | SAME_MODEL_NAME |
Все продукты с одинаковыми характеристиками 8292 будут отображаться в одной товарной карточке.
Узнать статус добавления товара
Пример запроса:
POST /v1/product/import/info HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"task_id": 33919
}
Пример ответа:
{
"result": {
"items": [
{
"offer_id": "Offer_RbtbQseqtTeBlHB8AjF9t-23",
"product_id": 5376526,
"status": "processed"
}
],
"total": 1
}
}
Позволяет получить статус создания карточки товара.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
task_id | int | Да | Код задачи на импорт товаров. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список идентификаторов заказов. |
items | array | Информация о товарах. |
items.offer_id | string | Идентификатор товара в системе продавца. |
items.product_id | int | Идентификатор товара. |
items.status | string | Статус создания товара. Информация о товаре обрабатывается очередями. Возможные значения параметра processing, moderating, processed, failed_moderation, failed_validation, failed. Актуальный статус обновления информации о товаре можно проверить методом Информация о товаре. |
Продажа по предоплате
Пример запроса:
POST /v1/product/prepayment/set HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"is_prepayment": true,
"offers_ids": [
"Offer_RbtbQseqtTeBlHB8AjF9t-23"
],
"products_ids": [
5376526
]
}
Пример ответа:
{
"result": {
"item_updated": [
{
"success": true,
"product_id": 0,
"offer_id": "Offer_RbtbQseqtTeBlHB8AjF9t-23"
},
{
"success": false,
"product_id": 5376526,
"offer_id": ""
}
]
}
}
Чтобы включить продажу товара только по предоплате, установите для него значение is_prepayment: true.
В запросе обязательно укажите один из идентификаторов товара: product_id или offer_id.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
is_prepayment | boolean | Да | Флаг обязательной предоплаты для товара:
|
offers_ids | array | Нет | Массив идентификаторов товаров в системе продавца. |
products_ids | array | Нет | Массив идентификаторов товаров в системе Ozon. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
item_updated | array | Информация об обновленных товарах. |
item_updated.offer_id | string | Идентификатор товара в системе продавца. |
item_updated.product_id | int | Идентификатор товара. |
item_updated.success | boolean | Результат запроса:
|
v2: Добавить товары
Пример запроса:
POST /v2/product/import HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"items": [
{
"attributes": [
{
"complex_id": 0,
"id": 0,
"values": [
{
"dictionary_value_id": 0,
"value": "string"
}
]
}
],
"barcode": "string",
"category_id": 0,
"complex_attributes": [
{
"attributes": [
{
"complex_id": 0,
"id": 0,
"values": [
{
"dictionary_value_id": 0,
"value": "string"
}
]
}
]
}
],
"depth": 0,
"dimension_unit": "string",
"height": 0,
"image_group_id": "string",
"images": [
"string"
],
"images360": [
"string"
],
"name": "string",
"offer_id": "string",
"old_price": "string",
"pdf_list": [
{
"index": 0,
"name": "string",
"src_url": "string"
}
],
"premium_price": "string",
"price": "string",
"vat": "string",
"weight": 0,
"weight_unit": "string",
"width": 0
}
]
}
Пример ответа:
{
"result": {
"task_id": 123
}
}
Метод для загрузки товаров. В одном запросе можно передать до 1000 товаров.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
items | string | Да | Список товаров. |
attributes | array | Да | Массив характеристик товара. Чтобы узнать какие характеристики есть у категории товара, используйте метод Список характеристик категории. |
complex_id | int | Нет | Идентификатор характеристики, которая поддерживает вложенные свойства. Например, у характеристики Процессор есть вложенные характеристики Производитель, L2 Cache, и другие. У каждой из вложенных характеристик может быть несколько вариантов значений. |
id | int | Да | Идентификатор характеристики. |
values | array | Нет | Массив вложенных значений характеристики. |
dictionary_value_id | int | Нет | Идентификатор справочника. |
value | string | Нет | Значение из справочника. |
barcode | string | Нет | Штрихкод товара. |
category_id | int | Да | Идентификатор категории. При создании товара в выбранной категории не должно быть других вложенных категорий. |
complex_attributes | array | Нет | Массив характеристик, у которых есть вложенные аттрибуты. |
depth | int | Да | Глубина упаковки. |
dimension_unit | string | Да | Единица измерения габаритов. Доступные варианты: mm (миллиметры), cm (сантиметры), in (дюймы). |
height | int | Да | Высота упаковки. |
image_group_id | string | Нет | Идентификатор для последующей пакетной загрузки изображений. |
images | array | Да | Массив с изображениями, не больше 10. |
images360 | array | Нет | Масиив изображений 360. |
file_name | string | Да | Ссылка на изображение формата http:// или https://. До 1000 знаков, форматы изображения JPEG или PNG. |
offer_id | int | Да | Идентификатор товара в системе продавца. |
old_price | string | Нет | Цена до скидок (будет зачеркнута на карточке товара). Указывается в рублях. Разделитель дробной части — точка, до двух знаков после точки. |
pdf_list | array | Нет | Список pdf-файлов. |
index | int | Нет | |
src_url | string | Нет | URL для pdf-файла. |
premium_price | string | Нет | Цена для клиентов с подпиской Ozon Premium. |
price | string | Да | Цена товара с учетом скидок, отображается на карточке товара. Если на товар нет скидок — укажите значение old_price. |
vat | string | Да | Ставка НДС для товара:
|
weight | int | Да | Вес товара в упаковке. Предельное значение - 1000 килограмм (или конвертированная величина в других единицах измерения). |
weight_unit | string | Да | Единицы измерения веса. Доступные варианты: g (граммы), kg (килограммы), lb (фунты). |
width | int | Да | Ширина упаковки. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result2 | array | Список идентификаторов товаров. |
task_id | int | Код задачи на импорт товаров. Статус выполнения задачи можно получить, используя метод Статус создания товара. |
Узнать статус добавления товара
Пример запроса:
POST /v1/product/import/info HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"task_id": 33919
}
Пример ответа:
{
"result": {
"items": [
{
"offer_id": "Offer_RbtbQseqtTeBlHB8AjF9t-23",
"product_id": 5376526,
"status": "processed"
}
],
"total": 1
}
}
Позволяет получить статус создания карточки товара.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
task_id | int | Да | Код задачи на импорт товаров. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список идентификаторов заказов. |
items | array | Информация о товарах. |
items.offer_id | string | Идентификатор товара в системе продавца. |
items.product_id | int | Идентификатор товара. |
items.status | string | Статус создания товара. Информация о товаре обрабатывается очередями. Возможные значения параметра processing, moderating, processed, failed_moderation, failed_validation, failed. Актуальный статус обновления информации о товаре можно проверить методом Информация о товаре. |
Продажа по предоплате
Пример запроса:
POST /v1/product/prepayment/set HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"is_prepayment": true,
"offers_ids": [
"Offer_RbtbQseqtTeBlHB8AjF9t-23"
],
"products_ids": [
5376526
]
}
Пример ответа:
{
"result": {
"item_updated": [
{
"success": true,
"product_id": 0,
"offer_id": "Offer_RbtbQseqtTeBlHB8AjF9t-23"
},
{
"success": false,
"product_id": 5376526,
"offer_id": ""
}
]
}
}
Чтобы включить продажу товара только по предоплате, установите для него значение is_prepayment: true.
В запросе обязательно укажите один из идентификаторов товара: product_id или offer_id.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
is_prepayment | boolean | Да | Флаг обязательной предоплаты для товара:
|
offers_ids | array | Нет | Массив идентификаторов товаров в системе продавца. |
products_ids | array | Нет | Массив идентификаторов товаров в системе Ozon. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
item_updated | array | Информация об обновленных товарах. |
item_updated.offer_id | string | Идентификатор товара в системе продавца. |
item_updated.product_id | int | Идентификатор товара. |
item_updated.success | boolean | Результат запроса:
|
Информация о товаре
Пример запроса:
POST /v1/product/info HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"offer_id": "item_6060091",
"product_id": 7154396,
"sku": 150583609
}
Пример ответа:
{
"result": {
"barcode": "",
"buybox_price": "",
"category_id": 17034461,
"created_at": "2019-11-26T10:40:44.940Z",
"id": 7154396,
"images": [
"https://cdn1.ozone.ru/multimedia/1028110514.jpg"
],
"marketing_price": "",
"min_ozon_price": "3599.0000",
"name": "Туалетная вода VALENTINO UOMO ACQUA spray 75 ml",
"offer_id": "item_6060091",
"old_price": "",
"premium_price": "",
"price": "3599.0000",
"recommended_price": " ",
"sku": 150583609,
"sources": [
{
"is_enabled": true,
"sku": 150583609,
"source": "fbo"
}
],
"state": "processed",
"stock": 120,
"stocks": {
"coming": 0,
"present": 120,
"reserved": 0
},
"validation_errors": [],
"vat": "0.2",
"visibility_details": {
"has_price": true,
"has_stock": true,
"active_product": true
},
"visible": true
}
}
Позволяет получить информацию о товаре по идентификатору.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
product_id | int | Нет | Идентификатор товара. |
sku | int | Нет | Идентификатор товара в системе Ozon. |
offer_id | string | Нет | Идентификатор товара в системе продавца. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
barcode | string | Штрихкод товара. |
buybox_price | string | Цена главного предложения на Ozon. Устаревший параметр, больше не используется. |
category_id | int | Идентификатор категории товара. |
created_at | string | Дата и время создания товара. |
id | int | Идентификатор характеристики товара. |
images | array | Массив url для изображений товара. |
marketing_price | string | Цена на товар с учетом всех акций. Это значение будет указано на витрине Ozon. |
min_ozon_price | sting | Минимальная цена на аналогичный товара на Ozon. |
name | string | Название товара. До 500 символов. |
offer_id | string | Идентификатор товара в системе продавца. |
old_price | string | Цена до учета скидок, на карточке товара отображается зачеркнутой. |
premium_price | string | Цена для клиентов с подпиской Ozon Premium. |
price | string | Информация о цене товара. |
recommended_price | string | Цена на товар, рекомендованная системой на основании схожих предложений. |
sku | int | Идентификатор товара в системе Ozon. |
sources | array | Информация о SKU Ozon. |
sources.is_enabled | bool | Видимость SKU товара в системе Ozon. |
sources.sku | int | Номер Ozon-SKU. |
sources.source | string | Тип SKU Ozon:
|
state | string | Статус добваления товара с систему:
|
stock | int | Количество товара в наличии. |
stocks | object | Информация о количестве товара. |
stocks.coming | int | Товары, которые ожидают поставки. |
stocks.present | int | Товары в наличии. |
stocks.reserved | int | Товары в резерве. |
validation_errors | array | Информация об ошибках валидации. |
validation_errors.code | string | Код ошибки. |
validation_errors.error | string | Описание ошибки. |
validation_errors.field | string | Поле, в котором возникла ошибка. |
vat | string | Ставка НДС для товара:
|
visible | bool | Товар доступен на Ozon для покупки. |
visibility_details | object | Параметры видимости товара. |
visibility_details.active_product | bool | Товар активирован. |
visibility_details.has_price | bool | У товара есть цена. |
visibility_details.has_stock | bool | Товар доступен на складе. |
v2: Информация о товаре
Пример запроса:
POST /v2/product/info HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"offer_id": "item_6060091",
"product_id": 7154396,
"sku": 150583609
}
Пример ответа:
{
"barcode": "",
"buybox_price": "",
"category_id": 17034461,
"created_at": "2019-11-26T10:40:44.940Z",
"errors": [
{
"field": "string",
"attribute_id": 0,
"code": "string",
"level": "string"
}
],
"id": 7154396,
"images": [
"https://cdn1.ozone.ru/multimedia/1028110514.jpg"
],
"marketing_price": "",
"min_ozon_price": "3599.0000",
"name": "Туалетная вода VALENTINO UOMO ACQUA spray 75 ml",
"offer_id": "item_6060091",
"old_price": "",
"premium_price": "",
"price": "3599.0000",
"recommended_price": " ",
"sources": [
{
"is_enabled": true,
"sku": 150583609,
"source": "fbo"
}
],
"state": "processed",
"stocks": {
"coming": 0,
"present": 120,
"reserved": 0
},
"vat": "0.2",
"visibility_details": {
"active_product": true,
"has_price": true,
"has_stock": true
},
"visible": true
}
Возвращает информацию о товаре по его идентификатору. Если указать только offer_id, то в результатах поиска будут только товары вашего магазина, даже если у другого продавца есть такие же артикулы.
Информация о списке товаров
Чтобы получить массив товаров по их идентификаторам, можно использовать метод POST v2/product/info/list. В теле запроса должен быть массив однотипных идентификаторов, в ответе будет массив items. Внутри items для каждого отправления поля совпадают с POST v2/product/info/.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
offer_id | string | Нет | Идентификатор товара в системе продавца — артикул. |
product_id | int | Нет | Идентификатор товара. |
sku | int | Нет | Идентификатор товара в системе Ozon — SKU. |
Пример запроса:
POST /v2/product/info/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"offer_id": [
"item_6060091"
],
"product_id": [],
"sku": []
}
Пример ответа:
{
"result": {
"items": [
{
"barcode": "",
"buybox_price": "",
"category_id": 17034461,
"created_at": "2019-11-26T10:40:44.940Z",
"errors": [
{
"attribute_id": 0,
"code": "string",
"field": "string",
"level": "string"
}
],
"id": 7154396,
"images": [
"https://cdn1.ozone.ru/multimedia/1028110514.jpg"
],
"marketing_price": "",
"min_ozon_price": "3599.0000",
"name": "Туалетная вода VALENTINO UOMO ACQUA spray 75 ml",
"offer_id": "item_6060091",
"old_price": "",
"premium_price": "",
"price": "3599.0000",
"price_index": "",
"recommended_price": "",
"sources": [
{
"is_enabled": true,
"sku": 150583609,
"source": "fbo"
}
],
"state": "processed",
"stocks": {
"coming": 0,
"present": 120,
"reserved": 0
},
"vat": "0.2",
"visibility_details": {
"active_product": true,
"has_price": true,
"has_stock": true
},
"visible": true
}
]
}
}
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
barcode | string | Штрихкод товара. |
buybox_price | string | Цена главного предложения на Ozon. Устаревший параметр, больше не используется. |
category_id | int | Идентификатор категории товара. |
created_at | string | Дата и время создания товара. |
errors | array | Информация об ошибках валидации товара. |
errors.attribute_id | int | Идентификатор параметра с ошибкой. |
errors.code | string | Код ошибки. |
errors.field | string | Поле, в котором возникла ошибка. |
errors.level | string | Тип ошибки:
|
id | int | Идентификатор характеристики товара. |
images | array | Массив url для изображений товара. |
marketing_price | string | Цена на товар с учетом всех акций. Это значение будет указано на витрине Ozon. |
min_ozon_price | sting | Минимальная цена на аналогичный товара на Ozon. |
name | string | Название товара. До 500 символов. |
offer_id | string | Идентификатор товара в системе продавца. |
old_price | string | Цена до учета скидок, на карточке товара отображается зачеркнутой. |
premium_price | string | Цена для клиентов с подпиской Ozon Premium. |
price | string | Информация о цене товара. |
price_index | string | Ценовой индекс. |
recommended_price | string | Цена на товар, рекомендованная системой на основании схожих предложений. |
sources | array | Информация о SKU Ozon. |
sources.is_enabled | bool | Видимость SKU товара в системе Ozon. |
sources.sku | int | Номер Ozon-SKU. |
sources.source | string | Тип SKU Ozon:
|
state | string | Статус добваления товара с систему:
|
stocks | object | Информация о количестве товара. |
stocks.coming | int | Товары, которые ожидают поставки. |
stocks.present | int | Товары в наличии. |
stocks.reserved | int | Товары в резерве. |
vat | string | Ставка НДС для товара:
|
visibility_details | object | Параметры видимости товара. |
visibility_details.active_product | bool | Товар активирован. |
visibility_details.has_price | bool | У товара есть цена. |
visibility_details.has_stock | bool | Товар доступен на складе. |
visible | bool | Товар доступен на Ozon для покупки. |
Характеристики товара
Пример запроса:
POST /v2/products/info/attributes HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"filter": {
"offer_id": [
"ABC-123"
],
"product_id": [
2346321
]
},
"page": 0,
"page_size": 0
}
Пример ответа:
{
"result": [
{
"id": 0,
"offer_id": "ABC-123",
"attributes": [
{
"attributeId": 8229,
"values": [
{
"dictionaryValueId": 93055,
"value": "Брюки"
}
]
}
],
"barcode": "9785768404994",
"category_id": 17027818,
"complex_attributes": [
{
"attributes": [
{
"attributeId": 4074,
"complexId": 4018,
"values": [
{
"dictionaryValueId": 0,
"value": "nN4OHnjB0nU"
}
]
}
]
}
],
"depth": 10,
"dimension_unit": "mm",
"height": 10,
"image_group_id": "ABC-123",
"images": [
{
"file_name": "https://cdn1.ozone.ru/s3/multimedia-a/1022555115.jpg",
"default": true,
"index": 0
}
],
"images360": [
{
"file_name": "https://cdn1.ozone.ru/s3/multimedia-a/1022555115.jpg",
"index": 0
}
],
"name": "Набор 5 ламп ST64 LED 4W Диммируемые",
"pdf_list": [
{
"file_name": "https://cdn1.ozone.ru/s3/pdf/1022555116.pdf",
"index": 0,
"name": "Инструкция"
}
],
"weight": 10,
"weight_unit": "g",
"width": 10
}
]
}
Возвращает описание характеристик товара по его идентификатору. Товар можно искать по offer_id или product_id.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
filter | Да | Фильтр для поиска товара. | |
offer_id | string | Нет | Идентификатор товара в системе продавца — артикул. |
product_id | int | Нет | Идентификатор товара. |
page | int | Нет | Номер страницы, возвращаемой в запросе. |
page_size | int | Нет | Количество элементов на странице. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
attributes | array | Массив характеристик товара. |
attributeId | int | Идентификатор характеристики. |
complexId | int | Идентификатор характеристики, которая поддерживает вложенные свойства. Например, у характеристики Процессор есть вложенные характеристики Производитель, L2 Cache, и другие. У каждой из вложенных характеристик может быть несколько вариантов значений. |
values | array | Массив значений характеристик. |
dictionaryValueId | int | Идентификатор характеристики в словаре. |
value | string | Значение характеристики товара. |
barcode | string | Штрихкод товара. |
category_id | int | Идентификатор категории товара. |
complex_attributes | array | Массив вложенных характеристик. |
depth | int | Глубина. |
dimension_unit | string | Единицы измерения. |
height | int | Высота. |
id | int | Идентификатор характеристики товара. |
image_group_id | string | Идентификатор для последующей пакетной загрузки изображений. |
images | array | Массив url для изображений товара. |
default | boolean | true, если изображение — главное. |
file_name | string | Ссылка на изображение формата http:// или https://. До 1000 знаков, форматы изображения JPEG или PNG. |
index | int | |
images360 | array | Массив изображений 360. |
name | string | Название товара. До 500 символов. |
offer_id | string | Идентификатор товара в системе продавца. |
pdf_list | array | Массив pdf-файлов. |
weight | int | Вес. |
weight_unit | string | Единица измерения веса. |
width | int | Ширина. |
Информация о стоках товаров
Пример запроса:
POST /v1/product/info/stocks HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"page": 1,
"page_size": 100
}
Пример ответа:
{
"result": {
"items":[
{
"product_id": 123,
"offer_id": "SAMSGGLXS10",
"stock": {
"coming": 0,
"present": 12,
"reserved": 0
}
},
{
"product_id": 345,
"offer_id": "SAMSGGLXS30",
"stock": {
"coming": 0,
"present": 24,
"reserved": 2
}
}
]
}
}
Позволяет получить пакетную информацию о стоках товаров
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
page | int | Нет | Количество страниц в ответе. |
page_size | int | Нет | Количество товаров на странице. По умолчанию значение 20. Максимальное значение 1000 |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
items | array | Информация о стоках товаров |
product_id | int | Идентификатор товара. |
offer_id | string | Идентификатор товара в системе продавца. |
stock | array | Количество товара в наличии. |
stock.coming | int | Количество товаров, ожидаемых к поставке |
stock.present | int | Количество товаров в наличии |
stock.reserved | int | Количество товаров в резерве |
Информация о ценах товаров
Пример запроса:
POST /v1/product/info/prices HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"page": 1,
"page_size": 100
}
Пример ответа:
{
"result": {
"items": [
{
"product_id": 253611,
"offer_id": "УТ-00007992",
"price": {
"price": "2489.0000",
"old_price": "2489.0000",
"premium_price": "",
"recommended_price": "",
"retail_price": "",
"vat": "0.000000",
"buybox_price": "",
"min_ozon_price": "2489.0000",
"marketing_price": "2489.0000"
}
}
],
"total": 5594
}
}
Позволяет получить пакетную информацию о ценах товаров
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
page | int | Нет | Количество страниц в ответе. |
page_size | int | Нет | Количество товаров на странице. По умолчанию значение 20. Максимальное значение 1000 |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
items | array | Информация о товарах. |
product_id | int | Идентификатор товара. |
offer_id | string | Идентификатор товара в системе продавца. |
price | object | Информация о цене товара. |
price.price | string | Цена товара с учетом скидок — это значение показывается на карточке товара. |
price.old_price | string | Цена до учета скидок, на карточке товара отображается зачеркнутой. |
price.premium_price | string | Цена для клиентов с подпиской Ozon Premium. |
price.recommended_price | string | Цена на товар, рекомендованная системой на основании схожих предложений. |
price.retail_price | string | Цена товара для поставщиков. |
price.vat | string | Ставка НДС для товара:
|
price.buybox_price | string | Цена главного предложения на Ozon. Устаревший параметр, больше не используется. |
price.min_ozon_price | sting | Минимальная цена на аналогичный товара на Ozon. |
price.marketing_price | string | Цена на товар с учетом всех акций. Это значение будет указано на витрине Ozon. |
price_index | string | Ценовой индекс. |
Список товаров
Пример запроса:
POST /v1/product/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"filter": {
"offer_id": [
"1255959"
],
"product_id": [
552526
],
"visibility": "ALL"
},
"page": 1,
"page_size": 100
}
Пример ответа:
{
"result": {
"items": [
{
"product_id": 124100,
"offer_id": "REDSGS10-128"
},
{
"product_id": 124201,
"offer_id": "REDSGS10-512"
}
],
"total": 4
}
}
Позволяет получить список товаров.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
filter | array | Нет | Массив фильтра по дополнительным параметрам |
filter.offer_id | string array | Нет | Фильтр по параметру offer_id. Возможно передавать список значений |
filter.product_id | int array | Нет | Фильтр по параметру product_id. Возможно передавать список значений |
filter.visibility | string | Нет | Фильтр по видимости товара, возможные значения:
|
page | int | Нет | Количество страниц в ответе. |
page_size | int | Нет | Количество товаров на странице. По умолчанию значение 20. Максимальное значение 1000 |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список идентификаторов заказов. |
product_id | int | Идентификатор товара. |
offer_id | string | Идентификатор товара в системе продавца. |
Обновить цену
Пример запроса:
POST /v1/product/import/prices HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"prices": [
{
"product_id": 120000,
"offer_id": "PRD-1",
"price": "79990",
"old_price": "89990",
"premium_price": "75555"
},
{
"product_id": 124100,
"offer_id": "PRD-2",
"price": "79990",
"old_price": "89990",
"premium_price": "75555",
},
{
"product_id": 124201,
"offer_id": "PRD-3",
"price": "89990",
"old_price": "79990",
"premium_price": "75555",
}
]
}
Пример ответа:
{
"result": [
{
"product_id": 120000,
"offer_id": "PRD-1",
"updated": false,
"errors": [
{"code": "not_found", "message": "Product not found"}
]
},
{
"product_id": 124100,
"offer_id": "PRD-2",
"updated": true,
"errors": []
},
{
"product_id": 124201,
"offer_id": "PRD-3",
"updated": true,
"errors": []
}
]
}
Позволяет изменить цену одного или нескольких товаров. За один запрос можно изменить цены для 1000 товаров. <r> Чтобы сбросить old_price или premium_price — поставьте 0 у этих параметров.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
product_id | int | Нет | Идентификатор товара. |
offer_id | string | Да | Идентификатор товара в системе продавца. |
price | string | Да | Цена товара с учетом скидок, отображается на карточке товара. Если на товар нет скидок — укажите значение old_price. |
old_price | string | Нет | Цена до скидок (будет зачеркнута на карточке товара). Указывается в рублях. Разделитель дробной части — точка, до двух знаков после точки. |
premium_price | string | Нет | Цена для клиентов с подпиской Ozon Premium. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список идентификаторов заказов. |
product_id | int | Идентификатор товара. |
offer_id | string | Идентификатор товара в системе продавца. |
updated | bool | Успешность обновления информации о товаре. |
Обновить остатки
Пример запроса:
POST /v1/product/import/stocks HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"stocks": [
{
"product_id": 120000,
"offer_id": "PRD-1",
"stock": 20
},
{
"product_id": 124100,
"offer_id": "PRD-2",
"stock": 20
}
]
}
Пример ответа:
{
"result": [
{
"product_id": 120000,
"offer_id": "PRD-1",
"updated": false,
"errors": [
{"code": "offer_id_not_found", "message": "Product not found"}
]
},
{
"product_id": 124100,
"offer_id": "PRD-2",
"updated": true,
"errors": []
}
]
}
Позволяет изменить информацию о количестве товара в наличии. За один запрос можно изменить наличие для 100 товаров
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
product_id | int | Нет | Идентификатор товара. |
offer_id | string | Да | Идентификатор товара в системе продавца. |
stock | int | Да | Количество товара в наличии. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список идентификаторов заказов. |
product_id | int | Идентификатор товара. |
offer_id | string | Идентификатор товара в системе продавца. |
updated | bool | Успешность обновления информации о товаре. |
errors | array | Информация об ошибках |
errors.code | string | Код ошибки:
|
errors.message | string | Текст ошибки |
Обновить карточку товара
Пример запроса:
POST /v1/product/update HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"product_id": 124100,
"barcode": "8801643566784",
"description": "Red Samsung Galaxy S10 with 512GB",
"name": "Samsung Galaxy S10",
"vendor": "Samsung",
"vendor_code": "SM-G960UZPAXAA",
"height": 77,
"depth": 11,
"width": 120,
"dimension_unit": "mm",
"weight": 120,
"weight_unit": "g",
"images": [
{
"file_name": "http://pic.com/1.jpg",
"default": true
},
{
"file_name": "http://pic.com/2.jpg",
"default": false
},
{
"file_name": "http://pic.com/3.jpg",
"default": false
}
],
"attributes": [
{
"id": 1,
"value": "Samsung Galaxy S10"
},
{
"id": 2,
"collection": [
"128GB",
"512GB"
]
},
{
"id": 3,
"complex": [
{
"id": 10,
"value": "Unboxing video"
},
{
"id": 11,
"value": "http://videos.com/1.mp4"
}
]
},
{
"id": 4,
"complex_collection": [
{
"collection": [
{
"id": 10,
"value": "Additional video"
},
{
"id": 11,
"value": "http://videos.com/2.mp4"
}
]
},
{
"collection": [
{
"id": 10,
"value": "Another one video"
},
{
"id": 11,
"value": "http://videos.com/3.mp4"
}
]
}
]
}
]
}
Пример ответа:
{
"result": {
"updated": true
}
}
Позволяет изменить данные в карточке товара. Обратите внимание, что через данный метод нельзя обновить информацию о ценах и остатках. Для этого необходимо использовать методы Обновить цену и Обновить остатки.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
product_id | int | Да | Идентификатор товара. |
barcode | string | Нет | Штрихкод товара. |
description | string | Нет | Описание товара. Для переноса строки в описании используйте HTML-тег br. |
name | string | Нет | Название товара. До 500 знаков. |
vendor | string | Нет | Производитель. До 100 знаков. |
vendor_code | string | Нет | Код производителя. До 100 знаков. |
attributes | array | Нет | Массив характеристик товара. Чтобы узнать какие характеристики есть у категории товара, используйте метод Список характеристик категории. |
attributes.id | int | Нет | Идентификатор характеристики. |
attributes.value | string | Нет | Массив значений характеристики. Например, характеристика Цвет может принимать два значения: черный и белый. |
attributes.collection | array | Нет | Массив значений характеристики. Например, характеристика Цвет может принимать два значения: черный и белый. |
attributes.complex | array | Нет | Массив характеристик, которые поддерживают вложенные свойства. Например, у характеристики Процессор есть вложенные характеристики Производитель, L2 Cache, и другие. У каждой из вложенных характеристик может быть несколько вариантов значений. |
attributes.complex_collection | array | Нет | Массив характеристик с одинаковым названием, но разными значениями. Например, у CD диска с аудиокнигой может быть несколько характеристик Аудио дорожка, каждая из который будет иметь разные значения вложенных характеристик Длина дорожки, Битрейт и тому подобное. |
attributes.complex_collection. collection | array | Нет | Массив комплексных характеристик с мультивыбором. |
images | array | Нет | Массив с изображениями, не больше 10. |
images.file_name | string | Нет | Ссылка на изображение формата http:// или https://. До 1000 знаков, форматы изображения JPEG или PNG. |
images.default | bool | Нет | Признак, позволяющий установить изображение основным. |
height | int | Нет | Высота упаковки. |
depth | int | Нет | Глубина упаковки. |
width | int | Нет | Ширина упаковки. |
dimension_unit | string | Нет | Единица измерения габаритов. Доступные варианты: mm (миллиметры), cm (сантиметры), in (дюймы). |
weight | int | Нет | Вес товара в упаковке. Предельное значение - 1000 килограмм (или конвертированная величина в других единицах измерения). |
weight_unit | string | Нет | Единицы измерения веса. Доступные варианты: g (граммы), kg (килограммы), lb (фунты). |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список идентификаторов заказов. |
updated | bool | Успешность обновления информации о товаре. |
Примеры характеристик товара
Для каждого товара в Ozon создается карточка товара — страница с основной информацией о товаре и характеристиками. Набор характеристик может быть разным и зависит от категории товара. Получить набор характеристик можно с помощью метода Список характеристик. Полученные значения характеристик необходимо передавать при создании или обновлении информации в карточке товара (методы Создание карточки товара и Обновление карточки товара).
Булевое значение (type=bool)
Допустимые значения для этой характеристики: "true", "false"
Пример запроса:
POST /v1/product/update HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"product_id": 124100,
"attributes": [
{
"id": 4652,
"value": "true"
}
]
}
Пример полученных значений характеристик:
Параметр | Значение |
---|---|
id | 4652 |
name | Признак 18+ |
description | - |
is_collection | false |
is_required | false |
type | bool |
option | - |
child | - |
Текстовое значение (type=text и is_collection=false)
Пример запроса:
POST /v1/product/update HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"product_id": 124100,
"attributes": [
{
"id": 9164,
"value": "Return possible only during 7 days"
}
]
}
Пример полученных значений характеристик:
Параметр | Значение |
---|---|
id | 9164 |
name | Условия возврата |
description | - |
is_collection | false |
is_required | false |
type | text |
option | - |
child | - |
Массив текстовых значений (type=text и is_collection=true)
Пример запроса:
POST /v1/product/update HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"product_id": 124100,
"attributes": [
{
"id": 4057,
"collection": [
"10",
"20"
]
}
]
}
Пример полученных значений характеристик:
Параметр | Значение |
---|---|
id | 4057 |
name | Страницы |
description | - |
is_collection | true |
is_required | false |
type | text |
option | - |
child | - |
Фиксированное значение (is_collection=false)
Пример запроса:
POST /v1/product/update HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"product_id": 124100,
"attributes": [
{
"id": 4061,
"value": "14"
}
]
}
Пример полученных значений характеристик:
Параметр | Значение |
---|---|
id | 4061 |
name | Техника изображения |
description | - |
is_collection | false |
is_required | false |
type | option |
option | |
option.id | 5 |
option.value | Акварель |
option.id | 14 |
option.value | Акватинта |
child | - |
Массив фиксированных значений (is_collection=true)
Пример запроса:
POST /v1/product/update HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"product_id": 124100,
"attributes": [
{
"id": 4061,
"collection": [
"5",
"14"
]
}
]
}
Пример полученных значений характеристик:
Параметр | Значение |
---|---|
id | 4061 |
name | Техника изображения |
description | - |
is_collection | true |
is_required | false |
type | option |
option | |
option.id | 5 |
option.value | Акварель |
option.id | 14 |
option.value | Акватинта |
child | - |
Вложенные характеристики (type=child и is_collection=false)
Пример запроса:
POST /v1/product/update HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"product_id": 124100,
"attributes": [
{
"id": 4018,
"complex": [
{
"id": 4068,
"value": "Unboxing video"
},
{
"id": 4074,
"value": "JXSibCy2-As"
}
]
}
]
}
Пример полученных значений характеристик:
Параметр | Значение |
---|---|
id | 4018 |
name | Видеоролик |
description | - |
is_collection | false |
is_required | false |
type | child |
option | - |
child | |
child.id | 4068 |
child.name | Название |
child.description | Наименование видеоролика на сайте |
child.is_collection | false |
child.is_required | false |
child.type | text |
child.id | 4074 |
child.name | Код ролика на YouTube |
child.description | Часть ссылки на ролик с сайта youtube после watch?v= |
child.is_collection | false |
child.is_required | false |
child.type | text |
Массив вложенных характеристик (type=child и is_collection=true)
Пример запроса:
POST /v1/product/update HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"product_id": 124100,
"attributes": [
{
"id": 4018,
"complex_collection": [
{
"collection": [
{
"id": 4068,
"value": "Additional video"
},
{
"id": 4074,
"value": "JXSibCy3-As"
}
]
},
{
"collection": [
{
"id": 4068,
"value": "Another one video"
},
{
"id": 4074,
"value": "JXSibCy4-As"
}
]
}
]
}
]
}
Пример полученных значений характеристик:
Параметр | Значение |
---|---|
id | 4018 |
name | Видеоролик |
description | - |
is_collection | true |
is_required | false |
type | child |
option | - |
child | |
child.id | 4068 |
child.name | Название |
child.description | Наименование видеоролика на сайте |
child.is_collection | false |
child.is_required | false |
child.type | text |
child.option | - |
child.id | 4074 |
child.name | Код ролика на YouTube |
child.description | Часть ссылки на ролик с сайта youtube после watch?v= |
child.is_collection | false |
child.is_required | false |
child.type | text |
child.option | - |
Отправления со склада продавца
Список отправлений
Пример запроса:
POST /v2/posting/fbs/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"dir": "asc",
"filter": {
"since": "2020-02-25T11:40:57.126Z",
"status": "delivering",
"to": "2020-03-25T11:40:57.126Z"
},
"limit": 1,
"offset": 0,
"with": {
"barcodes": true
}
}
Пример ответа:
{
"result": [
{
"order_id": 128903259,
"order_number": "29750371-0013",
"posting_number": "29750371-0013-1",
"status": "delivering",
"cancel_reason_id": 0,
"created_at": "2020-02-27T11:48:08Z",
"in_process_at": "2020-02-27T12:52:11Z",
"shipment_date": "2020-03-06T10:00:00Z",
"products": [
{
"sku": 147755222,
"name": "Гантель неопреновая Starfit DB-201 2.5 кг. фиолетовая",
"quantity": 2,
"offer_id": "УТ-00009071",
"price": "529.0000"
}
],
"barcodes": {
"upper_barcode": "%101%168789800",
"lower_barcode": "17736565768000"
}
}
]
}
Возвращает список отправлений за указанный период времени. Дополнительно можно отфильтровать отправления по их статусу.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
dir | str | Да | Направление сортировки:
|
filter | array | Да | Фильтр для поиска отправлений. |
since | datetime | Да | Начало периода в формате YYYY-MM-DD. |
status | str | Нет | Список статусов отправлений:
|
to | datetime | Да | Конец периода в формате YYYY-MM-DD. |
limit | int | Да | Количество отправлений в ответе. Максимум — 50, минимум — 1. |
offset | int | Нет | Количество элементов, которое будет пропущено в ответе. Например, если offset=10, то ответ начнется с 11-го найденного элемента. |
with | array | Нет | Массив дополнительных параметров. |
barcodes | bool | Да | Добавить в ответ штрихкоды отправления. |
shipment_date | datetime | Нет | translation missing: ru.in_in_shipment_date |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
order_id | int | Идентификатор заказа, к которому относится отправление. |
order_number | str | Номер заказа, к которому относится отправление. |
posting_number | str | Номер отправления. |
status | str | Статус отправления. |
cancel_reason_id | int | translation missing: ru.out_cancel_reason_id |
created_at | ddtt | Дата и время создания отправления. |
in_process_at | ddtt | Дата и время начала обработки отправления. |
shipment_date | ddtt | Дата и время, до которой необходимо собрать отправление. Если отправление не собрать к этой дате — оно автоматически отменится. |
products | array | Список товаров в отправлении. |
sku | int | Идентификатор товара в системе Ozon. |
name | str | Название товара. |
quantity | int | Количество товара в отправлении. |
offer_id | str | Артикул товара. |
price | str | Цена товара. |
barcodes | obj | Штрихкоды отправления. |
upper_barcode | string | Верхний штрихкод на маркировке. |
lower_barcode | string | Нижний штрихкод на маркировке. |
Информация об отправлении
POST /v2/posting/fbs/get HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"posting_number": "13076543-0001-1"
}
Пример ответа:
{
"result": {
"shipment_date": "2019-11-01T13:11:13.973Z",
"cancel_reason_id": 0,
"created_at": "2019-11-01T13:11:13.973Z",
"in_process_at": "2019-11-01T13:11:13.973Z",
"order_id": 86765466,
"order_number": "",
"posting_number": "13076543-0001-1",
"products": [
{
"name": "BLF ПЗУ",
"offer_id": "BLF-BM12345",
"price": "690.0000",
"quantity": 1,
"sku": 149512345
}
],
"status": "string"
}
}
Возвращает информацию об отправлении по его идентификатору.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
posting_number | str | Да | Номер отправления. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
shipment_date | ddtt | Дата и время, до которой необходимо собрать отправление. Если отправление не собрать к этой дате — оно автоматически отменится. |
cancel_reason_Id | int | Идентификатор причины отмены отправления. |
created_at | ddtt | Дата и время создания отправления. |
in_process_at | ddtt | Дата и время начала обработки отправления. |
order_id | int | Идентификатор заказа, к которому относится отправление. |
order_number | str | Номер заказа, к которому относится отправление. |
posting_number | str | Номер отправления. |
products | array | Список товаров в отправлении. |
products.name | str | Название товара. |
products.offer_id | str | Артикул товара. |
products.price | str | Цена товара. |
products.quantity | int | Количество товара в отправлении. |
products.sku | int | Идентификатор товара в системе Ozon. |
status | str | Статус отправления. |
Список необработанных отправлений
Пример запроса:
POST /v2/posting/fbs/unfulfilled/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"dir": "asc",
"limit": 1,
"offset": 0,
"status": [
"awaiting_deliver"
],
"with": {
"barcodes": true
}
}
Пример ответа:
{
"result": [
{
"order_id": 133408799,
"order_number": "34489339-0003",
"posting_number": "34489339-0003-2",
"status": "awaiting_deliver",
"cancel_reason_id": 0,
"created_at": "2020-03-18T21:56:43Z",
"in_process_at": "2020-03-18T21:58:56Z",
"shipment_date": "2020-03-26T10:00:00Z",
"products": [
{
"sku": 148633547,
"name": "Ролик для йоги и пилатеса Starfit FA-501, 15х45 см, синий/голубой",
"quantity": 1,
"offer_id": "УТ-00007263",
"price": "699.0000"
}
],
"barcodes": {
"upper_barcode": "%101%175493310",
"lower_barcode": "17906858827000"
}
}
]
}
Возвращает список необработанных отправлений: статусы awaiting_packaging, not_accepted, awaiting_deliver.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
dir | string | Да | Направление сортировки:
|
limit | int | Да | Количество отправлений в ответе. Максимум — 50, минимум — 1. |
offset | int | Нет | Количество элементов, которое будет пропущено в ответе. Например, если offset=10, то ответ начнется с 11-го найденного элемента. |
status | array | Да | Массив статусов отправлений:
|
with | array | Нет | Массив дополнительных параметров. |
barcodes | bool | Да | Добавить в ответ штрихкоды отправления. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
order_id | int | Идентификатор заказа, к которому относится отправление. |
order_number | str | Номер заказа, к которому относится отправление. |
posting_number | str | Номер отправления. |
status | str | Статус отправления. |
cancel_reason_id | int | translation missing: ru.out_cancel_reason_id |
created_at | ddtt | Дата и время создания отправления. |
in_process_at | ddtt | Дата и время начала обработки отправления. |
shipment_date | ddtt | Дата и время, до которой необходимо собрать отправление. Если отправление не собрать к этой дате — оно автоматически отменится. |
products | array | Список товаров в отправлении. |
sku | int | Идентификатор товара в системе Ozon. |
name | str | Название товара. |
quantity | int | Количество товара в отправлении. |
offer_id | str | Артикул товара. |
price | str | Цена товара. |
barcodes | obj | Штрихкоды отправления. |
upper_barcode | string | Верхний штрихкод на маркировке. |
lower_barcode | string | Нижний штрихкод на маркировке. |
Собрать заказ
POST /v2/posting/fbs/ship HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"packages": [
{
"items": [
{
"quantity": 3,
"sku": 123065
}
]
}
],
"posting_number": "13076543-0001-1"
}
Пример ответа:
{
"result": [
"29750371-0013-1"
]
}
Делит заказ на отправления и переводит его в статус awaiting_deliver.
Каждый элемент items описывает отдельное отправление в заказе. Разделить заказ нужно, если:
- товары не помещаются в одну упаковку;
- товары нельзя сложить в одну упаковку.
Подробнее про сбор заказов и требования к упаковке отправлений в Помощи для партнеров.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
packages | array | Да | Список отправлений в заказе. |
items | array | Да | Список товаров в отправлении. |
items.quantity | str | Да | Количество товара. |
items.sku | int | Да | Идентификатор товара. |
posting_number | str | Да | Номер отправления. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | str | Список идентификаторов отправлений. |
Получить передаточные документы
Формирует передаточные документы: акт приема-передачи и транспортную накладную.
Документы формируются в асинхронном режиме:
- Отправляем запрос на формирование документов через метод POST /v2/posting/fbs/act/create и получаем номер задания на формирование документа
- Опрашиваем статус формирования документов через метод POST /v2/posting/fbs/act/check-status
- После получения статуса "ready" скачиваем документы через метод POST /v2/posting/fbs/act/get-pdf
Формирование акта и накладной.
Пример запроса:
POST /v2/posting/fbs/act/create HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{}
Пример ответа:
{
"result": {
"id": 15684442104000
}
}
Запускает процедуру формирования передаточных документов: акта приема-передачи и транспортной накладной.
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result.id | int | Номер задания на формирование документов. |
error.code | string | При формировании передаточных документов возникла ошибка:
|
Статус акта и накладной
Пример запроса:
POST /v2/posting/fbs/act/check-status HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"id": 15684442104000
}
Пример ответа:
{
"result": {
"status": "ready",
"added_to_act": [
"00420000-0030-2",
"01560000-0096-4"
],
"removed_from_act": [
"03840000-0096-3"
]
}
}
Получение текущего статуса формирования акта приема-передачи и транспортной накладной
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
id | int | Да | Номер задания на формирование документов |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result.status | string | Возможные статусы
|
result.added_to_act | string array | Массив номеров отправлений, которые были добавлены в Акт приема-передачи и должны быть переданы в Ozon в тот же день |
result.removed_from_act | string array | Массив номеров отправлений, которые не попали в Акт приема-передачи. Такие отправления нужно передавать со следующей отгрузкой |
Получение акта и накладной
Пример запроса:
POST /v2/posting/fbs/act/get-pdf HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"id": 15684442104000
}
Пример ответа:
Pdf документ
Получить сформированные передаточные документы, а именно Акт приема-передачи и Транспортную накладную в формате PDF
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
id | int | Да | Номер задания на формирование документов |
Напечатать маркировку
Пример запроса:
POST /v2/posting/fbs/package-label HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"posting_number":
[
"13076543-0001-1"
]
}
Пример ответа:
Pdf документ
Генерирует PDF-файл с маркировкой для указанных отправлений. В одном запросе можно передать не больше 20 идентификаторов. Если хотя бы для одного отправления возникнет ошибка, маркировка не будет подготовлена для всех отправлений в запросе.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
posting_number | string | Да | Номера отправлений через запятую. |
Возможные ошибки:
POSTINGS_NOT_READY — отправление не готово к маркировке, повторите попытку позже.
Открыть спор по отправлению
Пример запроса:
POST /v2/posting/fbs/arbitration HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"posting_number":
[
"02898753-0009-1",
"02898753-0009-2"
]
}
Пример ответа:
{
"result": "true"
}
Если отправление передано в доставку, но не просканированно в сортировочном центре, можно открыть спор. Открытый спор переведет отправление в статус ARBITRATION.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
posting_number | array | Да | Номера отправлений через запятую. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | bool | Результат обработки запроса:
|
Передать отправление к отгрузке
Пример запроса:
POST /v2/posting/fbs/awaiting-delivery HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"posting_number":
[
"02898753-0009-1",
"02898753-0009-2"
]
}
Пример ответа:
{
"result": "true"
}
Передает спорные заказы к отгрузке. Статус отправления изменится на awaiting_deliver.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
posting_number | array | Да | Номера отправлений через запятую. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | bool | Результат обработки запроса:
|
Отменить отправление
Пример запроса:
POST /v2/posting/fbs/cancel HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"cancel_reason_id": 402,
"cancel_reason_message": "Wrong seller id",
"posting_number": 13076543-0001-1
}
Пример ответа:
{
"result": "true"
}
Меняет статус отправления на cancelled.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
cancel_reason_id | int | Да | Идентификатор причины отмены:
|
cancel_reason_message | str | Нет | Дополнительная информация по отмене. Если cancel_reason_id=402, параметр обязательный. |
posting_number | str | Да | Номера отправлений через запятую. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | bool | Результат обработки запроса:
|
Причины отмены
Пример запроса:
POST /v2/posting/fbs/cancel-reason/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
}
Пример ответа:
{
"result": [
{
"id": 123,
"title": "Error",
"type_id": "seller"
}
]
}
Возвращет список причин отмены отправлений.
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список идентификаторов отправлений. |
result.id | int | Идентификатор причины отмены отправления. |
result.title | str | Описание причины отмены отправления. |
result.type_id | str | Инициатор отмены отправления:
|
Отправления со склада Ozon
Список отправлений
Пример запроса:
POST /v2/posting/fbo/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"dir": "asc",
"filter":
{
"since": "2018-10-24T16:24:09.474Z",
"to": "2019-10-24T16:24:09.474Z"
},
"limit": 10,
"offset": 0
}
Пример ответа:
{
"result":
[
{
"order_id": 77712345,
"order_number": "",
"posting_number": "25312345-0021-2",
"status": "cancelled",
"cancel_reason_id": 76,
"created_at": "2019-03-21T14:51:01Z",
"in_process_at": "2019-03-21T14:52:07Z",
"products":
[
{
"sku": 149123456,
"name": "AUX аудиокабель 3.5мм",
"quantity": 1,
"offer_id": "DEP-12345",
"price": "270.0000"
}
]
}
]
}
Возвращает список отправлений за указанный период времени. Дополнительно можно отфильтровать отправления по их статусу.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
dir | str | Да | Направление сортировки:
|
filter | array | Да | Фильтр для поиска отправлений. |
since | datetime | Да | Начало периода в формате YYYY-MM-DD. |
to | datetime | Да | Конец периода в формате YYYY-MM-DD. |
status | str | Нет | Статус отправления:
|
limit | int | Да | Количество отправлений в ответе. Максимум — 50, минимум — 1. |
offset | int | Нет | Количество элементов, которое будет пропущено в ответе. Например, если offset=10, то ответ начнется с 11-го найденного элемента. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
cancel_reason_Id | int | Идентификатор причины отмены отправления. |
created_at | ddtt | Дата и время создания отправления. |
in_process_at | ddtt | Дата и время начала обработки отправления. |
order_id | int | Идентификатор заказа, к которому относится отправление. |
order_number | str | Номер заказа, к которому относится отправление. |
posting_number | str | Номер отправления. |
products | array | Список товаров в отправлении. |
products.name | str | Название товара. |
products.offer_id | str | Артикул товара. |
products.price | str | Цена товара. |
products.quantity | int | Количество товара в отправлении. |
products.sku | int | Идентификатор товара в системе Ozon. |
status | str | Статус отправления. |
Информация об отправлении
Пример запроса:
POST /v2/posting/fbo/get HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"posting_number": "13009555-0001-1"
}
Пример ответа:
{
"result":
{
"order_id": 86765466,
"order_number": "",
"posting_number": "13076543-0001-1",
"status": "cancelled",
"cancel_reason_id": 0,
"created_at": "2019-05-31T19:22:34Z",
"in_process_at": "2019-05-31T19:53:01Z",
"products":
[
{
"sku": 149512345,
"name": "BLF ПЗУ",
"quantity": 1,
"offer_id": "BLF-BM12345",
"price": "690.0000"
}
]
}
}
Возвращает информацию об отправлении по его идентификатору.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
posting_number | str | Да | Номер отправления. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
cancel_reason_Id | int | Идентификатор причины отмены отправления. |
created_at | ddtt | Дата и время создания отправления. |
in_process_at | ddtt | Дата и время начала обработки отправления. |
order_id | int | Идентификатор заказа, к которому относится отправление. |
order_number | str | Номер заказа, к которому относится отправление. |
posting_number | str | Номер отправления. |
products | array | Список товаров в отправлении. |
products.name | str | Название товара. |
products.offer_id | str | Артикул товара. |
products.price | str | Цена товара. |
products.quantity | int | Количество товара в отправлении. |
products.sku | int | Идентификатор товара в системе Ozon. |
status | str | Статус отправления. |
Отправления из-за рубежа
На маркетплейсе Ozon можно размещать товары магазинов, которые находятся за пределами Российской Федерации. Подробнее про схему работы см. Инструкции по работе с товарами из-за рубежа в Помощи Ozon.
Чтобы подготовить заказ к отправке покупателю, подтвердите отправление. Если какие-то товары отсутствуют, можно скорректировать заказ: отмените товары, которых нет в наличии и подтвердите только те отправления, которые будут переданы в доставку.
Список отправлений
Пример запроса:
POST /v2/posting/crossborder/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"dir": "asc",
"filter": {
"since": "2018-11-18T11:27:45.154Z",
"status": "awaiting_approve",
"to": "2019-11-18T11:27:45.154Z"
},
"limit": 10,
"offset": 0
}
Пример ответа:
{
"result": [
{
"address": {
"address_tail": "г. Москва, ул. Центральная, 1",
"addressee": "Петров Иван Владимирович",
"city": "Москва",
"comment": "",
"country": "Россия",
"district": "",
"phone": "+7 495 123-45-67",
"region": "Москва",
"zip_code": "101000"
},
"auto_cancel_date": "2019-11-18T11:30:11.571Z",
"cancel_reason_id": 76,
"created_at": "2019-11-18T11:30:11.571Z",
"customer_email": "petrov@email.com",
"customer_id": 60006,
"in_process_at": "2019-11-18T11:30:11.571Z",
"order_id": 77712345,
"order_nr": "1111444",
"posting_number": "39268230-0002-3",
"products": [
{
"name": "Фитнес-браслет",
"offer_id": "DEP-1234",
"price": "1900.00",
"quantity": 1,
"sku": 100056
}
],
"shipping_provider_id": 0,
"status": "awaiting_approve",
"tracking_number": ""
}
]
}
Возвращает список отправлений за указанный период времени. Дополнительно можно отфильтровать отправления по их статусу.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
dir | string | Да | Направление сортировки:
|
filter | object | Да | Фильтр для поиска отправлений. |
filter.since | ddtt | Нет | Начало периода в формате YYYY-MM-DD. |
filter.status | string | Нет | Статус отправления:
|
filter.to | ddtt | Нет | Конец периода в формате YYYY-MM-DD. |
limit | int | Да | Количество отправлений в ответе. Максимум — 50, минимум — 1. |
offset | int | Нет | Количество элементов, которое будет пропущено в ответе. Например, если offset=10, то ответ начнется с 11-го найденного элемента. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
address | array | Информация об адресе. |
address.address_tail | string | Адрес в текстовом формате. |
address.addressee | string | ФИО получателя. |
address.city | string | Город доставки. |
address.comment | string | Комментарий к заказу. |
address.country | string | Страна. |
address.district | string | Район. |
address.phone | string | Телефон. |
address.region | string | Регион. |
address.zip_code | string | Индекс. |
shipment_date | ddtt | Дата и время, до которой необходимо собрать отправление. Если отправление не собрать к этой дате — оно автоматически отменится. |
cancel_reason_id | int | Идентификатор причины отмены отправления. |
created_at | ddtt | Дата и время создания отправления. |
customer_email | string | Email покупателя. |
customer_id | int | Идентификатор покупателя. |
in_process_at | ddtt | Дата и время начала обработки отправления. |
order_id | int | Идентификатор заказа, к которому относится отправление. |
order_number | string | Номер заказа, к которому относится отправление. |
posting_number | string | Номер отправления. |
products | array | Список товаров в отправлении. |
products.name | string | Название товара. |
products.offer_id | string | Артикул товара. |
products.price | string | Цена товара. |
products.quantity | int | Количество товара в отправлении. |
products.sku | int | Идентификатор товара в системе Ozon. |
shipping_provider_id | int | Идентификатор службы доставки. |
status | string | Статус отправления. |
tracking_number | string | Трек-номер отправления. |
Информация об отправлении
Пример запроса:
POST /v2/posting/crossborder/get HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"posting_number": "39268230-0002-3",
}
Пример ответа:
{
"result": [
{
"address": {
"address_tail": "г. Москва, ул. Центральная, 1",
"addressee": "Петров Иван Владимирович",
"city": "Москва",
"comment": "",
"country": "Россия",
"district": "",
"phone": "+7 495 123-45-67",
"region": "Москва",
"zip_code": "101000"
},
"auto_cancel_date": "2019-11-18T11:30:11.571Z",
"cancel_reason_id": 76,
"created_at": "2019-11-18T11:30:11.571Z",
"customer_email": "petrov@email.com",
"customer_id": 60006,
"in_process_at": "2019-11-18T11:30:11.571Z",
"order_id": 77712345,
"order_nr": "1111444",
"posting_number": "39268230-0002-3",
"products": [
{
"name": "Фитнес-браслет",
"offer_id": "DEP-1234",
"price": "1900.00",
"quantity": 1,
"sku": 100056
}
],
"shipping_provider_id": 0,
"status": "awaiting_approve",
"tracking_number": ""
}
]
}
Возвращает информацию об отправлении по его идентификатору.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
posting_number | str | Да | Номер отправления. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
address | array | Информация об адресе. |
address.address_tail | string | Адрес в текстовом формате. |
address.addressee | string | ФИО получателя. |
address.city | string | Город доставки. |
address.comment | string | Комментарий к заказу. |
address.country | string | Страна. |
address.district | string | Район. |
address.phone | string | Телефон. |
address.region | string | Регион. |
address.zip_code | string | Индекс. |
shipment_date | ddtt | Дата и время, до которой необходимо собрать отправление. Если отправление не собрать к этой дате — оно автоматически отменится. |
cancel_reason_id | int | Идентификатор причины отмены отправления. |
created_at | ddtt | Дата и время создания отправления. |
customer_email | string | Email покупателя. |
customer_id | int | Идентификатор покупателя. |
in_process_at | ddtt | Дата и время начала обработки отправления. |
order_id | int | Идентификатор заказа, к которому относится отправление. |
order_number | string | Номер заказа, к которому относится отправление. |
posting_number | string | Номер отправления. |
products | array | Список товаров в отправлении. |
products.name | string | Название товара. |
products.offer_id | string | Артикул товара. |
products.price | string | Цена товара. |
products.quantity | int | Количество товара в отправлении. |
products.sku | int | Идентификатор товара в системе Ozon. |
shipping_provider_id | int | Идентификатор службы доставки. |
status | string | Статус отправления. |
tracking_number | string | Трек-номер отправления. |
Список отправлений к сборке
Пример запроса:
POST /v2/posting/crossborder/unfulfilled/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"dir": "asc",
"limit": 10,
"offset": 0,
"status": [
"awaiting_packaging"
]
}
Пример ответа:
{
"result": [
{
"address": {
"address_tail": "г. Москва, ул. Центральная, 1",
"addressee": "Петров Иван Владимирович",
"city": "Москва",
"comment": "",
"country": "Россия",
"district": "",
"phone": "+7 495 123-45-67",
"region": "Москва",
"zip_code": "101000"
},
"auto_cancel_date": "2019-11-18T11:30:11.571Z",
"cancel_reason_id": 76,
"created_at": "2019-11-18T11:30:11.571Z",
"customer_email": "petrov@email.com",
"customer_id": 60006,
"in_process_at": "2019-11-18T11:30:11.571Z",
"order_id": 77712345,
"order_nr": "1111444",
"posting_number": "39268230-0002-3",
"products": [
{
"name": "Фитнес-браслет",
"offer_id": "DEP-1234",
"price": "1900.00",
"quantity": 1,
"sku": 100056
}
],
"shipping_provider_id": 0,
"status": "awaiting_approve",
"tracking_number": ""
}
]
}
Возвращает список отправлений, которые готовы к сборке (статус awaiting_packaging).
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
dir | string | Да | Направление сортировки:
|
limit | int | Да | Количество отправлений в ответе. Максимум — 50, минимум — 1. |
offset | int | Да | Количество элементов, которое будет пропущено в ответе. Например, если offset=10, то ответ начнется с 11-го найденного элемента. |
status | array | Да | Список статусов отправлений:
|
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
address | array | Информация об адресе. |
address.address_tail | string | Адрес в текстовом формате. |
address.addressee | string | ФИО получателя. |
address.city | string | Город доставки. |
address.comment | string | Комментарий к заказу. |
address.country | string | Страна. |
address.district | string | Район. |
address.phone | string | Телефон. |
address.region | string | Регион. |
address.zip_code | string | Индекс. |
shipment_date | ddtt | Дата и время, до которой необходимо собрать отправление. Если отправление не собрать к этой дате — оно автоматически отменится. |
cancel_reason_id | int | Идентификатор причины отмены отправления. |
created_at | ddtt | Дата и время создания отправления. |
customer_email | string | Email покупателя. |
customer_id | int | Идентификатор покупателя. |
in_process_at | ddtt | Дата и время начала обработки отправления. |
order_id | int | Идентификатор заказа, к которому относится отправление. |
order_number | string | Номер заказа, к которому относится отправление. |
posting_number | string | Номер отправления. |
products | array | Список товаров в отправлении. |
products.name | string | Название товара. |
products.offer_id | string | Артикул товара. |
products.price | string | Цена товара. |
products.quantity | int | Количество товара в отправлении. |
products.sku | int | Идентификатор товара в системе Ozon. |
shipping_provider_id | int | Идентификатор службы доставки. |
status | string | Статус отправления. |
tracking_number | string | Трек-номер отправления. |
Собрать заказ
Пример запроса:
POST /v2/posting/crossborder/ship HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"items": [
{
"quantity": 2,
"sku": 100056
}
],
"posting_number": "39268230-0002-3",
"shipping_provider_id": 15109877837000,
"tracking_number": "AB123456CD"
}
Пример ответа:
{
"result": {
"package_number": "232123"
}
}
Делит заказ на отправления и переводит его в статус awaiting_deliver.
Каждый элемент items описывает отдельное отправление в заказе. Разделить заказ нужно, если:
- товары не помещаются в одну упаковку,
- товары нельзя сложить в одну упаковку.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
items | object | Да | Список товаров в отправлении. |
items.quantity | int | Да | Количество товара. |
items.sku | int | Да | Идентификатор товара. |
posting_number | string | Да | Номер отправления. |
shipping_provider_id | int | Да | Идентификатор службы доставки. |
tracking_number | string | Да | Трек-номер отправления. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | string | Результат обработки запроса. |
Список курьерских компаний
Пример запроса:
POST /v2/posting/crossborder/shipping-provider/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
}
Пример ответа:
{
"result": [
{
"id": 15109877837000,
"name": "shiptor"
},
{
"id": 15308950689000,
"name": "china-post"
}
]
}
Возвращает список курьерских компаний, которым можно передать отправление.
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список доступных служб доставки. |
id | int | Идентификатор службы доставки. |
name | string | Название службы доставки. |
Подтвердить отправление
Пример запроса:
POST /v2/posting/crossborder/approve HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"posting_number": "13009555-0001-1"
}
Пример ответа:
{
"result": true
}
Переводит отправление в статус awaiting_for_packaging — подтверждено и ожидает упаковку.
Если некоторых товаров нет в наличии, их можно убрать из отправления.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
posting_number | str | Да | Номер отправления. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | boolean | Результат обработки запроса:
|
Отменить заказ
Пример запроса:
POST /v2/posting/crossborder/cancel HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"cancel_reason_id": 361,
"cancel_reason_message": "",
"posting_number": "39268230-0002-3",
"sku": [
149123456
]
}
Пример ответа:
{
"result": true
}
Отменяет весь заказ или отдельные товары по их идентификатору.
Если отменить часть товаров из заказа, они сформируют отдельное отправление со статусом cancelled.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
cancel_reason_id | int | Да | Идентификатор причины отмены:
|
cancel_reason_message | string | Нет | Дополнительная информация по отмене. Если cancel_reason_id=402, параметр обязательный. |
posting_number | string | Да | Номер отправления. |
sku | int | Нет | Список идентификаторов товаров в отправлении. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | boolean | Результат обработки запроса:
|
Список причин отмены заказа
POST /v2/posting/crossborder/cancel-reason/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
}
Пример ответа:
{
"result": [
{
"id": 361,
"title": "Other",
"type_id": "buyer"
},
{
"id": 352,
"title": "Product is out of stock",
"type_id": "seller"
}
]
}
Возвращает список возможных причин отмены заказа.
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | boolean | Список причин для отмены отправления. |
result.id | int | Идентификатор причины отмены отправления. |
result.title | string | Описание причины отмены отправления. |
result.type_id | string | Инициатор отмены отправления:
|
Чат с покупателем
Покупатель может задавать вопросы о товаре или заказе в чате. С чатом можно работать через Seller API:
- получить список чатов и историю сообщений;
- отправить сообщение или файл;
- создать новый чат с покупателем.
Список чатов
Пример запроса:
POST /v1/chat/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"chat_id_list": [
"6639ec81-616e-480d-82b6-111dec41f674",
"3cdf5407-9f90-4752-8105-8f1d4cd427f5"
],
"page": 1,
"page_size": 100
}
Пример ответа:
{
"result": [
{
"id": "6639ec81-616e-480d-82b6-111dec41f674",
"users": [
{
"id": "501",
"type": "seller"
},
{
"id": "5mzh1lzfuhq4jcs2ufoxpnoa",
"type": "customer"
}
],
"last_message_id": "1933333401419385131"
},
{
"id": "3cdf5407-9f90-4752-8105-8f1d4cd427f5",
"users": [
{
"id": "501",
"type": "seller"
},
{
"id": "31494738",
"type": "customer"
}
],
"last_message_id": "1933404740364797568"
}
]
}
Возвращает информацию о чатах с указанными идентификаторами.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
chat_id_list | string array | Нет | Массив с идентификаторами чатов, для которых нужно вывести информацию. |
page | int | Нет | Количество страниц в ответе. |
page_size | int | Нет | Количество заказов на странице. Значение по умолчанию: 100. Максимальное значение: 1000. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
id | string | Идентификатор чата. |
users | array | Cписок участников чата. |
users.id | string | Идентификатор участника чата. |
users.type | string | Тип участника чата:
|
last_message_id | string | Идентификатор последнего сообщения в чате. |
История сообщений
Пример запроса:
POST /v1/chat/history HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"chat_id": "3cdf5407-9f90-4752-8105-8f1d4cd427f5",
"from_message_id": "986714",
"limit": 10
}
Пример ответа:
{
"result": [
{
"context": {
"item": {
"sku": 0
},
"order": {
"order_number": "123456-0001",
"postings": [
{
"delivery_schema": "fbs",
"posting_number": "13076543-0001-1",
"sku_list": [
149512345
]
}
]
}
},
"created_at": "2019-11-25T10:43:06.518Z",
"file": {
"url": "http://api-seller.ozon.ru/v1/chat/file/3cdf5407-9f90-4752-8105-8f1d4cd427f563f87e6da3651007ab96185f38772032b3918e31.jpg",
"mime": "image/jpeg",
"size": 815313,
"name": "32679625.jpg"
},
"id": "1931356687558511593",
"text": "hello",
"type": "file",
"user": {
"id": "30735682",
"type": "customer"
}
}
]
}
Возвращает историю сообщений в чате.
По умолчанию сообщения показываются от старого к новому. Чтобы получить историю сообщений от самого нового сообщения до самого старого, используйте метод /v1/chat/updates. У методов /v1/chat/history и /v1/chat/updates одинаковая структура запроса и ответа.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
chat_id | string | Да | Идентификатор чата. |
from_message_id | string | Нет | Идентификатор сообщения, с которого начать вывод истории чата. |
limit | int | Нет | Количество сообщений в ответе. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
context | object | Заказ или отдельный товар, о котором пользователь написал в чат. |
context.item | object | Информация о товаре. |
item.sku | int | Идентификатор товара в системе Ozon. |
context.order | object | Информация о заказе. |
order.order_number | string | Номер заказа, к которому относится отправление. |
order.postings | object | Информация об отправлении. |
postings.delivery_schema | string | Схема доставки заказа:
|
postings.posting_number | string | Номер отправления. |
postings.sku_list | array | Список идентификаторов товаров в отправлении. |
created_at | ddtt | Дата и время создания сообщения. |
file | object | Информация о файле в чате. Отображается только для сообщений с параметром type = file. |
file.mime | string | Тип файла. Список и примеры допустимых значений на github. |
file.name | string | Название файла. |
file.size | int | Размер файла в байтах. |
file.url | string | URL файла. |
id | string | Идентификатор сообщения в чате. |
text | string | Сообщение, только для type: text. |
type | string | Тип сообщения:
|
user | array | Информация об авторе сообщения. |
user.id | string | Идентификатор участника чата. |
user.type | string | Тип участника чата:
|
Отправить сообщение
Пример запроса:
POST /v1/chat/send/message HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"chat_id": "3cdf5407-9f90-4752-8105-8f1d4cd427f5",
"text": "Test Message"
}
Пример ответа:
{
"result": "success"
}
Отправляет сообщение в существующий чат по его идентификатору.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
chat_id | string | Да | Идентификатор чата. |
text | string | Да | Текст сообщения в формате plain text. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | string | Результат обработки запроса. |
Отправить файл
Пример запроса:
POST /v1/chat/send/file HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"chat_id": "3cdf5407-9f90-4752-8105-8f1d4cd427f5",
"base64_content": "MSwgMiwgMwo=",
"name": "test.txt"
}
Пример ответа:
{
"result": "success"
}
Отправляет файл в существующий чат по его идентификатору.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
base64_content | string | Да | Файл в виде строки base64. |
chat_id | string | Да | Идентификатор чата. |
name | string | Да | Название файла с расширением. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | string | Результат обработки запроса. |
Создать чат
Пример запроса:
POST /v1/chat/start HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"posting_number": 598586936
}
Пример ответа:
{
"result": {
"chat_id": "3cdf5407-9f90-4752-8105-8f1d4cd427f5"
}
}
Создает новый чат с покупателем по отправлению. Например, чтобы уточнить адрес или модель товара.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
posting_number | string | Да | Номер отправления. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result.chat_id | string | Идентификатор чата. |
Акции
Партнер может продвигать товары с помощью участия в акциях, которые Ozon регулярно проводит для покупателей. Добавить товары в акцию можно в личном кабинете, через XLS-шаблон или с помощью методов Seller API. Подробнее о типах акций в Помощи для партнеров.
Список акций
Пример запроса:
GET /v1/actions HTTP/1.1
Host: seller-api.ozon.ru
Accept: application/json
Пример ответа:
{
"result": [
{
"action_id": 2328,
"title": "акция пагинация",
"date_start": "2020-01-21T13:30:06Z",
"date_end": "2020-01-30T21:00:00Z",
"potential_products_count": 3,
"is_participating": false,
"participating_products_count": 0,
"action_type": "DISCOUNT",
"banned_products_count": 1,
"with_targeting": false
}
]
}
Возвращает список акций, доступных для партнера.
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
action_id | int | Идентификатор акции. |
title | string | Название акции. |
date_start | string | Дата начала акции. |
date_end | string | Дата окончания акции. |
potential_products_count | int | Количество товаров, доступных для акции. |
is_participating | bool | Участие партнера в акции. |
participating_products_count | int | Количество товаров, участвующих в акции. |
description | string | Описание акции. |
action_type | string | Тип акции:
|
banned_products_count | int | Количество заблокированных товаров. |
with_targeting | bool | Акция с целевой аудиторией. |
Список товаров, доступных для акции
Пример запроса:
POST /v1/actions/candidates HTTP/1.1
Host: seller-api.ozon.ru
Accept: application/json
Content-Type: application/json
{
"action_id": 2422,
"limit": 1,
"offset": 0
}
Пример ответа:
{
"result": {
"products": [
{
"product_id": 15323889,
"price": 1100,
"action_price": 1100,
"max_action_price": 1100
}
],
"total": 1
}
}
Возвращает список товаров, доступных для акции, по ее идентификатору.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
action_id | int | Да | Идентификатор акции. |
limit | int | Нет | Количество товаров в ответе. |
offset | int | Нет | Количество элементов, которое будет пропущено в ответе. Например, если offset=10, то ответ начнется с 11-го найденного элемента. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
products | array | Список товаров, доступных для акции. |
products.product_id | int | Идентификатор товара. |
products.price | float | Текущая цена товара без скидки. |
products.action_price | float | Цена товара по акции. |
products.max_action_price | float | Максимально возможная цена товара по акции. |
total | int | Количество товаров, доступных для акции. |
Список товаров, участвующих в акции
Пример запроса:
POST /v1/actions/products HTTP/1.1
Host: seller-api.ozon.ru
Accept: application/json
Content-Type: application/json
{
"action_id": 2422,
"limit": 1,
"offset": 0
}
Пример ответа:
{
"result": {
"products": [
{
"product_id": 15323889,
"price": 1100,
"action_price": 1100,
"max_action_price": 1100
}
],
"total": 1
}
}
Возвращает список товаров, участвующих в акции, по ее идентификатору.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
action_id | int | Да | Идентификатор акции. |
limit | int | Нет | Количество товаров в ответе. |
offset | int | Нет | Количество элементов, которое будет пропущено в ответе. Например, если offset=10, то ответ начнется с 11-го найденного элемента. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
products | array | Список товаров, участвующих в акции. |
products.product_id | int | Идентификатор товара. |
products.price | float | Текущая цена товара без скидки. |
products.action_price | float | Цена товара по акции. |
products.max_action_price | float | Максимально возможная цена товара по акции. |
total | int | Количество товаров, участвующих в акции. |
Добавить товар в акцию
Пример запроса:
POST /v1/actions/products/activate HTTP/1.1
Host: seller-api.ozon.ru
Accept: application/json
Content-Type: application/json
{
"action_id": 2422,
"products": [
{
"product_id": 15323889,
"action_price": 931.00
}
]
}
Пример ответа:
{
"result": {
"product_ids": [
15323889
]
}
}
Позволяет добавить указанные товары в доступную для партнера акцию.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
action_id | int | Да | Идентификатор акции. |
products | array | Да | Список товаров, которые нужно добавить в акцию. |
products.product_id | int | Да | Идентификатор товара. |
products.action_price | float | Да | Цена товара по акции. В рублях и с округлением до сотых. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
product_ids | array | Список идентификаторов товаров, добавленных в акцию. |
Удалить товар из акции
Пример запроса:
POST /v1/actions/products/deactivate HTTP/1.1
Host: seller-api.ozon.ru
Accept: application/json
Content-Type: application/json
{
"action_id": 2422,
"product_ids": [
15323889
]
}
Пример ответа:
{
"result": {
"product_ids": [
15323889
]
}
}
Позволяет удалить указанные товары из акции.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
action_id | int | Да | Идентификатор акции. |
product_ids | array | Да | Список товаров, которые нужно удалить из акции. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
product_ids | array | Список идентификаторов товаров, удаленных из акции. |
Отчеты
Информация о транзакциях
Информация о транзакциях за указанный период, по конкретным отправлениями или определенного типа.
Список транзакций
Возвращает подробную информацию по транзакциям для отправления. Если в запросе не указывать posting_number, в ответе будут все отправления за указанный период или определенного типа. Типы транзакций:
- all — все,
- orders — заказы,
- returns — возвраты,
- services — сервисные сборы.
Пример запроса:
POST /v2/finance/transaction/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"filter": {
"date": {
"from": "2020-03-01T07:14:11.897Z",
"to": "2020-03-31T07:14:11.897Z"
},
"posting_number": "37634761-0032-2",
"transaction_type": "all"
},
"page": 1,
"page_size": 10
}
Пример ответа:
{
"result": [
{
"transactionNumber": 11063698936370,
"orderDate": "2019-10-09T00:00:00Z",
"orderNumber": "37634761-0032-2",
"transactionType": "Возврат",
"details": "Фитнес браслет Samsung R375 GalaxyFit E black",
"orderAmount": -2980,
"discountAmount": 0,
"commissionAmount": 368.03,
"totalAmount": -2611.97,
"orderState": "",
"tranDate": "2020-03-05T00:00:00Z",
"transactionTypeSlug": "returns",
"itemDeliveryAmount": 0,
"itemReturnAmount": 0
}
]
}
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
filter | strinf | Да | Фильтр для поиска транзакций. |
date | date | Да | Период времени. |
from | ddtt | Да | Начало периода. |
to | ddtt | Да | Конец периода в формате YYYY-MM-DD. |
posting_number | string | Нет | Номер отправления. |
transaction_type | string | Да | Тип транзакции:
|
page | int | Да | Номер страницы, возвращаемой в запросе. |
page_size | int | Да | Количество элементов на странице. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
transactionNumber | int | Идентификатор транзакции. |
orderDate | string | Дата заказа. |
orderNumber | string | Номер заказа. |
transactionType | string | Тип транзакции. |
details | string | Информация о товаре в транзакции. |
orderAmount | int | Сумма заказа. |
discountAmount | int | Сумма скидки. |
commissionAmount | int | Сумма комиссии. |
totalAmount | int | Итоговый размер начислений. |
orderState | string | Статус отправления:
|
tranDate | ddtt | Дата транзакции. |
transactionTypeSlug | string | Тип транзакции в системном виде:
|
itemDeliveryAmount | int | Количество доставленных товаров. |
itemReturnAmount | int | Количество товаров к возврату. |
Сумма по транзакциям
Возвращает итоговую сумму по транзакциям за период, по статусу или отправлению.
Пример запроса:
POST /v2/finance/transaction/totals HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"filter": {
"date": {
"from": "2020-03-01T07:14:11.897Z",
"to": "2020-03-31T07:14:11.897Z"
},
"posting_number": "37634761-0032-2",
"transaction_type": "all"
},
"page": 1,
"page_size": 10
}
Пример ответа:
{
"result": {
"orderAmount": "720314.00",
"discountAmount": "0.00",
"commissionAmount": "-42661.10",
"totalAmount": "677652.88",
"item_delivery_amount": "-9597.00",
"item_return_amount": "0.00"
},
"error": null
}
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
filter | strinf | Да | Фильтр для поиска транзакций. |
date | date | Да | Период времени. |
from | ddtt | Да | Начало периода. |
to | ddtt | Да | Конец периода в формате YYYY-MM-DD. |
posting_number | string | Нет | Номер отправления. |
transaction_type | string | Да | Тип транзакции:
|
page | int | Да | Номер страницы, возвращаемой в запросе. |
page_size | int | Да | Количество элементов на странице. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
orderAmount | int | Сумма заказа. |
discountAmount | string | Сумма скидки. |
commissionAmount | string | Сумма комиссии. |
totalAmount | string | Итоговый размер начислений. |
item_delivery_amount | string | Количество доставленных товаров. |
item_return_amount | int | Количество возвратов. |
error | int | Ошибка при обработке запросв. |
Список отчетов
Пример запроса:
POST /v1/report/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"page": 1,
"page_size": 100,
"report_type": "SELLER_TRANSACTIONS"
}
Пример ответа:
{
"result": {
"reports": [
{
"code": "63d60fd4-1959-4087-89fa-2afa320eb2fb",
"status": "success",
"error": "",
"file": "http://api-seller.ozon.ru/v1/report/file/a7/76/a776a9c05f1c5e67.csv",
"report_type": "seller_transactions",
"params": {
"date_from": "2019-01-01",
"date_to": "2019-01-15",
"search": "",
"transaction_type": ""
},
"created_at": "2019-01-23T10:22:46.414747Z"
}
],
"total": 1
}
}
Возвращает список отчетов, которые были сформированы раньше.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
page | int | Нет | Количество страниц в ответе. |
page_size | int | Нет | Количество заказов на странице. Значение по умолчанию: 100. Максимальное значение: 1000. |
report_type | string | Нет | Тип отчета:
|
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
reports | array | Массив со всеми сгенерированными отчетами |
code | string | Уникальный ID отчета |
status | string | Статус генерации отчета, возможные значения "success", "failed" |
error | string | Код ошибки при генерации отчета |
file | string | Ссылка на файл формата CSV |
report_type | string | Тип отчета:
|
params | array | Массив с фильтрами, указанными при создании отчета продавцом |
created_at | string | Дата создания отчета |
total | int | Суммарное количество отчетов |
Информация об отчете
Пример запроса:
POST /v1/report/info HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"code": "63d60fd4-1959-4087-89fa-2afa320eb2fb"
}
Пример ответа:
{
"result": {
"code": "63d60fd4-1959-4087-89fa-2afa320eb2fb",
"status": "success",
"error": "",
"file": "http://api-seller.ozon.ru/v1/report/file/a7/76/a776a9c05f1c5e67.csv",
"report_type": "seller_transactions",
"params": {
"date_from": "2019-01-01",
"date_to": "2019-01-15",
"search": "",
"transaction_type": ""
},
"created_at": "2019-01-23T10:22:46.414747Z"
}
}
Возвращает информацию о запрошенном отчете по его уникальному ID
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
code | string | Нет | Уникальный ID отчета |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
code | string | Уникальный ID отчета |
status | string | Статус генерации отчета, возможные значения "success", "failed" |
error | string | Код ошибки при генерации отчета |
file | string | Ссылка на файл формата CSV |
report_type | string | Тип отчета:
|
params | array | Массив с фильтрами, указанными при создании отчета продавцом |
created_at | string | Дата создания отчета |
Отчет по товарам
Пример запроса:
POST /v1/report/products/create HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"offer_id": [
"GJ5O52T5"
],
"search": "SAMSUNG",
"sku": [
555929582
],
"visibility": "VISIBLE"
}
Пример ответа:
{
"result": {
"code": "da9af288-2724-4f0e-8b15-37cf061d4817"
}
}
Возвращает отчет по товарам, который также доступен в личном кабинете продавца
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
offer_id | string array | Нет | Идентификатор товара в системе продавца. |
search | string | Нет | Поиск по содержанию записи, проверяет наличие |
sku | int array | Нет | Идентификатор товара в системе Ozon. |
visibility | string | Нет | Фильтр по видимости товара, возможные значения:
|
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
code | string | Уникальный ID отчета |
Отчет по транзакциям
Пример запроса:
POST /v1/report/transactions/create HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"date_from": "2019-01-01",
"date_to": "2019-01-15",
"search": "MEIZU",
"transaction_type": "ORDERS"
}
Пример ответа:
{
"result": {
"code": "da9af288-2724-4f0e-8b15-37cf061d4817"
}
}
Возвращает отчет по товарам, который также доступен в личном кабинете продавца
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
date_from | string | Да | Дата с которой рассчитывается отчет по транзакциям. Формат YYYY-MM-DD |
date_to | string | Да | Дата по которую рассчитывается отчет по транзакциям. Формат YYYY-MM-DD |
search | string | Нет | Поиск по содержанию записи, проверяет наличие |
transaction_type | string | Нет | Фильтр по типу транзакции, возможные варианты: "ALL", "ORDERS", "RETURNS", "SERVICES", "OTHER", "DEPOSIT" |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
code | string | Уникальный ID отчета |
Старая версия API
Информация о заказе
Пример запроса:
GET /v1/order/123456?translit=true HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
Пример ответа:
{
"result": {
"order_id": 123456,
"order_number": "123456-0001",
"status": "delivered",
"customer_id": 122334,
"delivery_schema": "fbo",
"last_updated": "2018-09-25T12:41:48.932Z",
"order_time": "2018-09-25T12:41:48.932Z",
"address": {
"address_tail": "Vlogogradskaya st. 12 - 23",
"addressee": "Ivan Ivanov",
"city": "Moscow",
"comment": "pass code #123",
"country": "Russia",
"district": "Central",
"phone": "7903XXXXXXX",
"email": "test@ozon.ru",
"region": "Moscow",
"zip_code": "112334"
},
"items": [
{
"product_id": 124525,
"item_id": 325441,
"quantity": 1,
"offer_id": "124100",
"price": "79999",
"tracking_number": "XZY1111111",
"status": "delivered",
"cancel_reason_id": 0,
"auto_cancel_date": "2019-01-09T09:56:53.587Z",
"shipping_provider_id": 5
}
]
}
}
Возращает информацию о заказе по его идентификатору.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
order_id | int | Да | Идентификатор заказа. |
translit | bool | Нет | Транслитерация адреса из кириллицы в латиницу |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
order_id | int | Идентификатор заказа. |
order_number | string | Номер заказа. |
status | string | Статус заказа. |
customer_id | int | Идентификатор покупателя. |
delivery_schema | string | Схема доставки заказа, возможные значения: "fbo", "fbs", "crossborder" |
last_updated | string | Последнее изменение информации о заказе. |
order_time | string | Дата и время создания заказа. |
address | array | Информация об адресе. |
address.address_tail | string | Адрес в текстовом формате. |
address.addressee | string | ФИО получателя. |
address.city | string | Город доставки. |
address.comment | string | Комментарий к заказу. |
address.country | string | Страна. |
address.district | string | Район. |
address.phone | string | Телефон. |
address.email | string | E-mail. |
address.region | string | Регион. |
address.zip_code | string | Индекс. |
items | array | Информация о товарах. |
items.product_id | int | Идентификатор товара. |
items.item_id | int | Идентификатор позиции товара в заказе. |
items.quantity | int | Количество товара. |
items.offer_id | string | Идентификатор товара в системе продавца. |
items.price | string | Итоговая цена товара с учетом скидок в рублях. Разделитель дробной части — точка, до двух знаков после точки. |
items.tracking_number | string | Номер отслеживания посылки. |
items.status | string | Статус товара в заказе. |
items.cancel_reason_id | int | Код причины отмены заказа. |
items.auto_cancel_date | string | Дата автоматической отмены заказа (в будущем). |
items.shipping_provider_id | int | Идентификатор компании, которая доставляет заказ. |
Получить список заказов
Пример запроса:
POST /v1/order/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"since": "2018-12-19T14:39:46.033Z",
"to": "2018-12-19T14:39:46.033Z",
"delivery_schema": "fbs",
"statuses": ["DELIVERED"],
"page": 1,
"page_size": 100
}
Пример ответа:
{
"result": {
"orders": [
{
"order_id": 19294655,
"delivery_schema": "fbo",
"status": "cancelled",
"items": [
{
"item_id": 67696756,
"product_id": 28987,
"offer_id": "02905340-43",
"cancel_reason_id": 0,
"quantity": 1
}
]
},
{
"order_id": 19305509,
"delivery_schema": "fbo",
"status": "delivered",
"items": [
{
"item_id": 67735563,
"product_id": 29187,
"offer_id": "25605010-37",
"cancel_reason_id": 0,
"quantity": 2
}
]
}
],
"total": 121
}
}
Позволяет получить список заказов.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
since | string | Да | Дата начала периода в формате YYYY-MM-DD. |
to | string | Да | Дата окончания периода в формате YYYY-MM-DD. |
delivery_schema | string | Да | Схема доставки заказа, возможные значения: "fbs", "fbo", "crossborder" |
statuses | string array | Нет | Статус заказа, возможные значения: "awaiting_approve", "awaiting_packaging", "awaiting_deliver", "delivering", "delivered", "cancelled" |
page | int | Нет | Количество страниц в ответе. |
page_size | int | Нет | Количество заказов на странице. Значение по умолчанию: 100. Максимальное значение: 1000. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список идентификаторов заказов. |
result.total | int | Общее число позиций. |
orders.order_id | int | Идентификатор заказа. |
orders.delivery_schema | string | Схема доставки заказа, возможные значения: "fbo", "fbs", "crossborder" |
orders.status | string | Статус заказа. |
orders.items | array | Информация о товарах. |
orders.items.product_id | int | Идентификатор товара. |
orders.items.item_id | int | Идентификатор позиции товара в заказе. |
orders.items.offer_id | string | Идентификатор товара в системе продавца. |
orders.items.quantity | string | Количество товара. |
orders.items.cancel_reason_id | int | Код причины отмены заказа. |
Невыполненные заказы
Пример запроса:
POST /v1/order/unfulfilled HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"page": 1,
"page_size": 10
}
Пример ответа:
{
"result": [
{
"order_id": 123456,
"items": [
{
"item_id": 12345,
"product_id": 123456,
"offer_id": "PRD-123",
"quantity": 2
}
]
}
],
"total": 121
}
Позволяет получить список заказов, ожидающих обработки продавцом, исходя из минимальной даты и времени создания заказа.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
page | int | Нет | Количество страниц в ответе. |
page_size | int | Нет | Количество заказов на странице. Значение по умолчанию: 100. Максимальное значение: 1000. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список идентификаторов заказов. |
total | int | Общее число позиций. |
result.order_id | int | Идентификатор заказа. |
result.items | array | Информация о товарах. |
items.item_id | int | Идентификатор позиции товара в заказе. |
items.product_id | int | Идентификатор товара. |
items.offer_id | string | Идентификатор товара в системе продавца. |
items.quantity | string | Количество товара. |
Подтвердить заказ для Crossborder
Пример запроса:
POST /v1/order/approve/crossborder HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"order_id": 123456
}
Пример ответа:
{
"result": "success"
}
Позволяет подтвердить список позиций в заказе.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
order_id | int | Да | Идентификатор заказа. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | string | Результат обработки запроса. |
Курьерские компании для CB
Пример запроса:
POST /v1/order/shipping-provider/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{}
Пример ответа:
{
"result": [
{
"id": 1,
"name": "DPD"
},
{
"id": 2,
"name": "USPS"
}
]
}
Позволяет получить список компаний, которые могут доставить товар.
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список идентификаторов заказов. |
id | int | Идентификатор компании, которая доставляет заказ. |
name | string | Название товара. До 500 знаков. |
Отправка заказа для CB
Пример запроса:
POST /v1/order/ship/crossborder HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"order_id": 123456,
"shipping_provider_id": 2,
"tracking_number": "AA123456789AA",
"items": [
{
"item_id": 123,
"quantity": 1
}
]
}
Пример ответа:
{
"result": {
"package_number": "232123"
}
}
Позволяет создать посылку с заказом, пометить ее как отправленную и заполнить данные о трекинг номере.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
order_id | int | Да | Идентификатор заказа. |
tracking_number | string | Да | Номер отслеживания посылки. |
shipping_provider_id | int | Да | Идентификатор компании, которая доставляет заказ. |
items | array | Да | Информация о товарах. |
items.item_id | int | Да | Идентификатор позиции товара в заказе. |
items.quantity | int | Да | Количество товара. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список идентификаторов заказов. |
package_number | string | Номер посылки (отправления). |
Отправка заказа для FBS
Пример запроса:
POST /v1/order/ship/fbs HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"order_id": 123456,
"packages": [
{
"items": [
{
"item_id": 123,
"quantity": 1
}
]
}
]
}
Пример ответа:
{
"result": {
"package_numbers": [
"232123"
]
}
}
Позволяет создать посылку с заказом и пометить ее как отправленную. При отправке заказа необходимо указывать все item_id, которые в нем присутствуют, разбивая их на отдельные посылки при необходимости.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
order_id | int | Да | Идентификатор заказа. |
packages | array | Да | Информация о посылке. |
packages.items | array | Да | Информация о товарах в посылке и их количество. |
packages.items.item_id | int | Да | Идентификатор позиции товара в заказе. |
packages.items.quantity | int | Да | Количество товара. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список идентификаторов заказов. |
package_numbers | string array | Массив с номерами посылок (отправлений). |
Package label for FBS
Пример запроса:
POST /v1/order/package-label/fbs HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"order_ids": [
35536499
]
}
Пример ответа:
{
"result": {
"content_type": "application/pdf",
"base64_content": "dGVzdF9zdHJpbmc="
}
}
Returns an FBS package label for one or several orders
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
order_ids | int array | Да | Идентификатор заказа. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список идентификаторов заказов. |
content_type | string | Content-Type возвращаемого файла. |
base64_content | string | Файл в виде строки base64. |
Акт и накладная FBS
Отмена заказа для CB
Пример запроса:
POST /v1/order/items/cancel/crossborder HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"order_id": 123456,
"reason_code": 2,
"item_ids": [
123,
456
]
}
Пример ответа:
{
"result": "success"
}
Позволяет отменить позицию в заказе и указать причину отмены. Чтобы получить список причин отмены используйте метод Причины отмены.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
order_id | int | Да | Идентификатор заказа. |
reason_code | int | Да | Код причины отмены заказа. |
item_ids | int array | Да | Список идентификаторов позиций товара в заказе. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | string | Результат обработки запроса. |
Отмена заказа для FBS
Пример запроса:
POST /v1/order/cancel/fbs HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{
"order_id": 2563636,
"cancel_reason_id": 2
}
Пример ответа:
{
"result": "success"
}
Позволяет отменить заказ и указать причину отмены. Чтобы получить список причин отмены используйте метод Причины отмены.
Параметры запроса:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
order_id | int | Да | Идентификатор заказа. |
cancel_reason_id | int | Да | Код причины отмены заказа. |
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | string | Результат обработки запроса. |
Причины отмены
Пример запроса:
POST /v1/order/cancel-reason/list HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: 836
Api-Key: 0296d4f2-70a1-4c09-b507-904fd05567b9
Content-Type: application/json
{}
Пример ответа:
{
"result": [
{
"id": 352,
"title": "Product is out of stock"
},
{
"id": 353,
"title": "Product with wrong price"
},
{
"id": 358,
"title": "Canceled by seller"
}
]
}
Позволяет получить список причин отмены позиции в заказе.
Параметры ответа:
Параметр | Тип | Описание |
---|---|---|
result | array | Список идентификаторов заказов. |
id | int | Идентификатор компании, которая доставляет заказ. |
title | string | Название компании, которая доставляет заказ. |
Changelog
v2 (2019-11-12)
Features
- Removed v1 handlers
- Changed Client-id and API-key for sandbox
- Added v2 handlers for FBS and FBO
v1.1.1 (2019-03-19):
Features
- Updated category list and attributes handles
- Added ability to retreive package label and bill of lading PDFs for FBS scheme
- Added email in order info for crossborder orders
- Added ability to retreive import task_id status
v1.1.0 (2019-01-22):
Features
- Updated product info handle (added validation errors info)
- Updated product list handle (request type changed from GET to POST, supports multiple filters, including filter by visibility)
- New product creation handles, which allows creation in batches of up to 5000 products in 1 request
- Ability to generate reports available in Seller Center via API
v1.0.9 (2019-01-09):
Features
- Updated order info handle
v1.0.8 (2018-12-19):
Features
- Added API chat functionality
- Added pagination into /v1/order/canceled and /v1/order/unfulfilled handles
- Added handles for FBS orders (/v1/order/ship/fbs and /v1/order/cancel/fbs)
- Renamed crossborder handles (new names are: /v1/order/items/approve/crossborder, /v1/order/items/cancel/crossborder and /v1/order/ship/crossborder)
- Added a single order list handle instead of 3 old ones
v1.0.7 (2018-12-05):
Features
- Updated attribute builder, available here
- Added automatic category classifier for products, available here
- Fixed various bugs
- Updated auth credentials
v1.0.6 (2018-11-28):
Features
- Simplified creation of an item with different colors/sizes
- Added attribute_type filter in /v1/categories/category_id/attributes
- Added attribute builder, available here
- Fixed various bugs
v1.0.5 (2018-11-21):
Features
- Update /v1/products/create method to support items with multiple colors/sizes
- Update description of /v1/products/update and /v1/products/create methods
- Fixed various bugs
v1.0.4 (2018-11-06):
Features
- Added attribute type in /v1/categories/{category_id}/attributes handle
- Added description of attributes and attribute model
- Added offer_id key in /v1/products/info/{product_id} handle
v1.0.3 (2018-10-30)
Features
- Updated description of several handles
Bugs
- Fixed a bug, when item_id key was used, instead of product_id key
v1.0.2 (2018-10-22)
Bugs
- Fixed a bug with price in /v1/order/{order_id} handle
- Fixed a bug with attributes array in /v1/products/create handle
Features
- Added /v1/products/update handle, which allows updating product info
- Now requiring "weight" key in /v1/products/create and /v1/products/update handles
- Added product visibility info in /v1/products/info handle
- Increased the number of items per page up to 1000 in /v1/products/list handle
- Renamed /v1/cancel-reasons handle into /v1/order/items/cancel-reasons
- "Barcode" key added in /v1/products/info handle
- Cancellation status now returned in /v1/order/{order_id} handle response
v1.0.1 (2018-10-05)
Features
- Updated description of /v1/products/list/ handle