Appearance
Описание API
Данное API предназначено для взаимодействия с системой со стороны интеграционных модулей, серверной части сайта, интернет-магазина либо из мобильного приложения.
Авторизация
Авторизационные данные передаются в HTTP-заголовке Authorization:
Ваш API key доступен на странице Настройки аккаунта
Если ресурс API вызван без авторизационных данных, сервер вернет HTTP-статус 403
Отправка запросов
Запросы к API передаются по протоколу HTTPS
Тип метода запросов GET
Формат ответа JSON
Все даты в запросах и ответах указаны в часовом поясе UTC
Базовый URL для запросов https://поддомен.oship.ru/api/seller/
Маркировка «Честный знак»
В объектах товаров используются два связанных поля:
cis— код маркировки. Строка содержит переданный или отсканированный код, пустая строка означает, что код ещё нужно получить,null— код отсутствует или необязательная маркировка была пропущена;cis_requirement— требование к маркировке:none— код не нужен,required— код обязателен,optional— код можно передать или пропустить.
При создании заказа для магазина с типом API рекомендуется всегда передавать cis_requirement. Если поле не передано, сохраняется обратная совместимость: cis, равный 1 или строке "1", означает обязательное сканирование; непустое скалярное значение считается переданным обязательным кодом; 0, null, пустое или отсутствующее поле cis означает отсутствие требования.
IMEI
В объектах товаров используются поля:
imei— IMEI устройства. Строка содержит переданное или отсканированное значение, пустая строка означает, что IMEI нужно получить сканированием,null— значение отсутствует или необязательный IMEI был пропущен;imei_requirement— требование к IMEI:none— значение не нужно,required— IMEI обязателен,optional— IMEI можно передать или пропустить.
IMEI должен состоять из 15 цифр и проходить проверку контрольной суммы. При создании заказа рекомендуется всегда передавать imei_requirement. Для none значение imei игнорируется и сохраняется как null. Для required отсутствие, null или пустая строка означает последующее обязательное сканирование. Для optional пустая строка или отсутствующее поле означает, что IMEI можно отсканировать либо пропустить; явно переданный imei: null означает, что необязательный IMEI уже пропущен.
Цена продажи
Поле sale_price в объекте товара содержит цену продажи одной физической единицы товара в российских копейках. Значение передаётся и возвращается целым неотрицательным числом. Если цена неизвестна, поле имеет значение null.
Для магазина с типом API поле необязательно при создании заказа в разделе «Упаковка». После создания заказа изменить цену продажи через API нельзя. Для нескольких единиц одного товара передавайте отдельный элемент массива products для каждой единицы.
Цена возвращается в объектах products подробных методов раздела «Упаковка»: GET /api/seller/orders/{shop UUID}/{order number} и GET /api/shop/orders/{order number}. В списках заказов и методах раздела «Подтверждение» это поле отсутствует.
Запросы
Получение списка магазинов
Запрос
js
GET https://поддомен.oship.ru/api/seller/shops
Authorization: **Ваш API key**Ответ
js
[
{
"uuid": UUID магазина,
"name": Название магазина,
"active": Признак активности магазина (true — активен, false — неактивен),
"prioritet": Приоритет магазина,
"shipment_window": Период для упаковки,
"source": {
"name": Название источника магазина,
"slug": slug источника магазина
}
},
...
]Подтверждение заказов
Получение списка заказов раздела Подтверждение по планируемой дате отгрузки
Запрос
js
GET https://поддомен.oship.ru/api/seller/approves?shipment_date=2025-01-27
Authorization: Ваш API keyЕсли shipment_date не указан, то по умолчанию возвращаются заказы с планируемой датой отгрузки сегодня.
Планируемая дата отгрузки для OZON это дата, в которую нужно отгрузить заказ, чтобы получить вознаграждение за быструю отгрузку. На данный момент, она равна дате поступления заказа.
Планируемая дата отгрузки для Wildberries равна дате создания заказа в oShip.
Ответ
js
[
{
"shop": {
"uuid": UUID магазина,
"name": Название магазина,
"source": {
"name": Название источника магазина,
"slug": техническое наименование источника магазина
}
},
"number": Номер заказа,
"shipment_date": Планируемая дата отгрузки,
"status": Статус заказа (возможные значения: accepted, approved, cancelled),
"accepted_at": Дата поступления заказа,
"approved_at": Дата подтверждения заказа,
"cancelled_at": Дата отмены заказа,
"products": [
{
"code": Код товара,
"name": Название товара,
"cis": Код "Честный знак",
"cis_requirement": Требование к коду (none, required или optional),
"imei": IMEI товара,
"imei_requirement": Требование к IMEI (none, required или optional),
"assigned_at": Дата сканирования товара при подтверждении,
},
...
],
},
...
]Получение списка заказов раздела Подтверждение конкретного магазина по планируемой дате отгрузки
Запрос
js
GET https://поддомен.oship.ru/api/seller/approves/{shop UUID}?shipment_date=2025-01-27
Authorization: Ваш API keyЕсли shipment_date не указан, то по умолчанию возвращаются заказы с планируемой датой отгрузки сегодня Значение для параметра shop_UUID можно узнать из запроса получения списка магазинов
Ответ
js
[
{
"number": Номер заказа,
"shipment_date": Планируемая дата отгрузки,
"status": Статус заказа (возможные значения: accepted, approved, cancelled),
"accepted_at": Дата поступления заказа,
"approved_at": Дата подтверждения заказа,
"cancelled_at": Дата отмены заказа,
"products": [
{
"code": Код товара,
"name": Название товара,
"cis": Код "Честный знак",
"cis_requirement": Требование к коду (none, required или optional),
"imei": IMEI товара,
"imei_requirement": Требование к IMEI (none, required или optional),
"assigned_at": Дата сканирования товара при подтверждении,
},
...
],
},
...
]Получение подробной информации по конкретному заказу раздела Подтверждение
Запрос
js
GET https://поддомен.oship.ru/api/seller/approves/{shop UUID}/{order number}
Authorization: **Ваш API key**Значение для параметра shop UUID можно узнать из запроса получения списка магазинов или запроса на получение списка заказов раздела Подтверждение по планируемой дате отгрузкиorder number - номер заказа
Ответ
js
{
"number": Номер заказа,
"shipment_date": Планируемая дата отгрузки,
"status": Статус заказа (возможные значения: accepted, approved, cancelled),
"accepted_at": Дата поступления заказа,
"approved_at": Дата подтверждения заказа,
"cancelled_at": Дата отмены заказа,
"products": [
{
"code": Код товара,
"name": Название товара,
"cis": Код "Честный знак",
"cis_requirement": Требование к коду (none, required или optional),
"imei": IMEI товара,
"imei_requirement": Требование к IMEI (none, required или optional),
"assigned_at": Дата сканирования товара при подтверждении,
"barcodes": ["124312345"]
},
...
]
}Упаковка заказов
Получение списка всех заказов раздела Упаковка по планируемой дате отгрузки
Запрос
js
GET https://поддомен.oship.ru/api/seller/orders?shipment_date=2025-01-27
Authorization: **Ваш API key**Если shipment_date не указан, то по умолчанию возвращаются заказы с планируемой датой отгрузки сегодня
Ответ
js
[
{
"shop": {
"uuid": UUID магазина,
"name": Название магазина,
"source": {
"name": Название источника магазина,
"slug": техническое наименование источника магазина
}
},
"number": Номер заказа,
"shipment_date": Планируемая дата отгрузки,
"status": Статус заказа (возможные значения: accepted, packaged, shipped, delivered, cancelled),
"comment": Текст комментария,
"meta": {
"client_type": Тип клиента (возможные значения: B2C, B2B)
},
"accepted_at": Дата приёма заказа,
"packaged_at": Дата упаковки заказа,
"shipped_at": Дата отгрузки заказа,
"delivered_at": Дата доставки заказа,
"cancelled_at": Дата отмены заказа
},
...
]Получение списка заказов раздела Упаковка конкретного магазина по планируемой дате отгрузки
Запрос
js
GET https://поддомен.oship.ru/api/seller/orders/{shop UUID}?shipment_date=2025-01-27
Authorization: Ваш API keyЕсли shipment_date не указан, то по умолчанию возвращаются заказы с планируемой датой отгрузки сегодня Значение для параметра shop_UUID можно узнать из запроса получения списка магазинов
Ответ
js
[
{
"number": Номер заказа,
"shipment_date": Планируемая дата отгрузки,
"status": Статус заказа (возможные значения: accepted, packaged, shipped, delivered, cancelled),
"comment": Текст комментария,
"meta": {
"client_type": Тип клиента (возможные значения: B2C, B2B)
},
"accepted_at": Дата приёма заказа,
"packaged_at": Дата упаковки заказа,
"shipped_at": Дата отгрузки заказа,
"delivered_at": Дата доставки заказа,
"cancelled_at": Дата отмены заказа
},
...
]Получение подробной информации по конкретному заказу раздела Упаковка
Запрос
js
GET https://поддомен.oship.ru/api/seller/orders/{shop UUID}/{order number}
Authorization: **Ваш API key**Значение для параметра shop UUID можно узнать из запроса получения списка магазиновorder number - номер заказа
Ответ
js
{
"number": Номер заказа,
"shipment_date": Планируемая дата отгрузки,
"status": Статус заказа (возможные значения: accepted, packaged, shipped, delivered, cancelled),
"comment": Текст комментария,
"meta": {
"client_type": Тип клиента (возможные значения: B2C, B2B)
},
"accepted_at": Дата приёма заказа,
"packaged_at": Дата упаковки заказа,
"shipped_at": Дата отгрузки заказа,
"delivered_at": Дата доставки заказа,
"cancelled_at": Дата отмены заказа,
"products": [
{
"code": Код товара,
"name": Название товара,
"sale_price": Цена продажи одной единицы в российских копейках или null,
"cis": Код "Честный знак",
"cis_requirement": Требование к коду (none, required или optional),
"imei": IMEI товара,
"imei_requirement": Требование к IMEI (none, required или optional),
"assigned_at": Дата сканирования товара при упаковке,
"barcodes": ["124312345"]
},
...
],
"packages": [
{
"number": Номер грузового места,
"barcode": Штрих-код грузового места,
"status": Статус грузового места (возможные значения: accepted,packaged,shipped),
"packaged_at": Дата упаковки грузового места,
"shipped_at": Дата отгрузки грузового места
},
...
]
}Магазины с типом API
Добавление заказа в раздел Подтверждение для магазина с типом API
Доступно только для магазинов с типом API
Запрос
js
PUT https://поддомен.oship.ru/api/shop/approves
Authorization: **API key вашего магазина oShip**
{
"number": "00001", // Номер заказа
"shipment_date": "2025-01-27", // Плановая дата отгрузки заказа
"products": [ // информация о товарах (массив)
{
"code": "111", // код товара (необязательно, если указаны barcodes)
"name": "Test", // наименование (необязательно)
"barcodes": ["2000259506566", ...], // массив штрихкодов товара (необязательно, если указан code)
"cis": null, // код «Честный знак»: строка с кодом, "" для последующего сканирования или null
"cis_requirement": "optional", // none, required или optional
"imei": "", // 15 цифр, "" для последующего сканирования или null
"imei_requirement": "required" // none, required или optional
},
...
]
}Для cis_requirement: "none" значение cis игнорируется и сохраняется как null. Для required отсутствие, null или пустая строка в cis означает, что обязательный код нужно отсканировать. Для optional пустая строка или отсутствующий cis означает, что код можно отсканировать либо пропустить; явно переданный cis: null означает, что необязательный код уже пропущен.
Правила для imei и imei_requirement описаны в разделе IMEI.
Значение API key доступно при создании магазина с типом API
Ответ
Варианты ответов:
- 200 Заказ успешно создан;
- 400 (Empty code and barcodes) - не заполнен код товара и штрихкоды;
- 400 (Product not found) - товар с переданными штрихкодами не найден;
- 400 (More than one product found) - по переданным штрихкодам найдено более 1 товара;
- 409 - заказ с таким номером уже существует у этого магазина.
Изменение заказа в разделе Подтверждение для магазина с типом API
Запрос
Доступно только для магазинов с типом API
js
POST https://поддомен.oship.ru/api/shop/approves/{номер заказа}
Authorization: **API key вашего магазина oShip**
{
// Необходимо передать один нужный параметр для изменения
"cancelled_at": "2025-03-14 09:09:22", // Дата и время отмены заказа (После изменения даты статус заказа меняется на "Отменен")
"approved_at": "2025-03-14 09:09:22", // Дата и время подтверждения заказа (После изменения даты статус заказа меняется на "Подтвержден")
"shipment_date": "2025-03-14" // Изменение даты плановой отгрузки заказа
}Ответ
Варианты ответов:
- 200 - заказ успешно изменён;
- 404 - номер заказа не найден, либо у заказа статус Подтвержден или Отменён.
Получение подробной информации по конкретному заказу из раздела Подтверждение для магазина с типом API
Доступно только для магазинов с типом API
Запрос
js
GET https://поддомен.oship.ru/api/shop/approves/{order number}
Authorization: **API key вашего магазина oShip**order number - номер заказа
Ответ
js
{
"number": Номер заказа,
"shipment_date": Планируемая дата отгрузки,
"status": Статус заказа (возможные значения: accepted, approved, cancelled),
"accepted_at": Дата поступления заказа,
"approved_at": Дата подтверждения заказа,
"cancelled_at": Дата отмены заказа,
"products": [
{
"code": Код товара,
"name": Название товара,
"cis": Код "Честный знак",
"cis_requirement": Требование к коду (none, required или optional),
"imei": IMEI товара,
"imei_requirement": Требование к IMEI (none, required или optional),
"assigned_at": Дата сканирования товара при подтверждении,
"barcodes": ["124312345"]
},
...
]
}Получение списка заказов раздела Подтверждение конкретного магазина с типом API по планируемой дате отгрузки
Запрос
js
GET https://поддомен.oship.ru/api/shop/approves?shipment_date=2025-03-22
Authorization: Ваш API keyЕсли shipment_date не указан, то по умолчанию возвращаются заказы с планируемой датой отгрузки сегодня
Значение API key доступно при создании магазина с типом API
Ответ
js
[
{
"number": Номер заказа,
"shipment_date": Планируемая дата отгрузки,
"status": Статус заказа (возможные значения: accepted, approved, cancelled),
"accepted_at": Дата поступления заказа,
"approved_at": Дата подтверждения заказа,
"cancelled_at": Дата отмены заказа,
"products": [
{
"code": Код товара,
"name": Название товара,
"cis": Код "Честный знак",
"cis_requirement": Требование к коду (none, required или optional),
"imei": IMEI товара,
"imei_requirement": Требование к IMEI (none, required или optional),
"assigned_at": Дата сканирования товара при подтверждении,
},
...
],
},
...
]Добавление заказа в раздел Упаковка для магазина с типом API
Доступно только для магазинов с типом API
Запрос
js
PUT https://поддомен.oship.ru/api/shop/orders
Authorization: **API key вашего магазина oShip**
{
"number": "00001", // Номер заказа
"alt_numbers": ["ALT-1", "ALT-2"], // Альтернативные номера заказа (необязательно)
"comment": "Текст комментария", //Комментарий к заказу.Ограничение 250 символов (необязательно)
"shipment_date": "2025-01-27", // Плановая дата отгрузки заказа
"accepted_at": "2025-01-27", // Дата подтверждения заказа
"products": [ // информация о товарах (массив)
{
"code": "111", // код товара (необязательно, если указаны barcodes)
"name": "Test", // наименование (необязательно)
"barcodes": ["2000259506566", ...], // массив штрихкодов товара (необязательно, если указан code)
"sale_price": 149900, // цена продажи одной единицы в российских копейках (необязательно)
"cis": null, // код «Честный знак»: строка с кодом, "" для последующего сканирования или null
"cis_requirement": "optional", // none, required или optional
"imei": "", // 15 цифр, "" для последующего сканирования или null
"imei_requirement": "required" // none, required или optional
},
...
],
"packages": [ // информация об упаковках (массив)
{
"number": "1212", // номер упаковки
"barcode": "1212" // штрихкод упаковки
},
...
],
"label": "" // файл с этикеткой в Base64
}Для cis_requirement: "none" значение cis игнорируется и сохраняется как null. Для required отсутствие, null или пустая строка в cis означает, что обязательный код нужно отсканировать. Для optional пустая строка или отсутствующий cis означает, что код можно отсканировать либо пропустить; явно переданный cis: null означает, что необязательный код уже пропущен.
Правила для imei и imei_requirement описаны в разделе IMEI.
sale_price указывается для одной товарной единицы целым числом в российских копейках. Поле необязательно: если оно отсутствует или имеет значение null, цена сохраняется как неизвестная. Значение 0 допустимо. Строки, дробные и отрицательные числа не принимаются.
Значение API key доступно при создании магазина с типом API
Если код товара ("code") заполнен, то происходит поиск товара в oShip, если товар с таким кодом не найден, то происходит создание товара с указанными параметрами (код товара, наименование (в этом случае наличие обязательно), штрихкоды). Если код товара ("code") не заполнен, то поиск товара в oShip осуществляется по баркоду.
Товары не привязываются к конкретным упаковкам, если для заказа передать информацию о нескольких упаковках, то при упаковке заказа будут напечатаны несколько этикеток, штрихкод с которых необходимо будет отсканировать, для завершения процесса упаковки.
Ответ
Варианты ответов:
- 200 Заказ успешно создан;
- 400 (Empty code and barcodes) - не заполнен код товара и штрихкоды;
- 400 (Product not found) - товар с переданными штрихкодами не найден;
- 400 (More than one product found) - по переданным штрихкодам найдено более 1 товара;
- 400 (
sale_pricemust be a non-negative integer in Russian kopecks or null) - цена продажи указана нецелым или отрицательным значением; - 400 (Label less 10000 bytes or mime type not "application/pdf") - этикетка заказа менее 10000 байт или тип этикетки не pdf;
- 409 - заказ с таким номером уже существует у этого магазина.
Изменение заказа в разделе Упаковка для магазина с типом API
Запрос
Доступно только для магазинов с типом API
js
POST https://поддомен.oship.ru/api/shop/orders/{номер заказа}
Authorization: **API key вашего магазина oShip**
{
// Необходимо передать один нужный параметр для изменения
"cancelled_at": "2025-01-28 09:09:22", // Дата и время отмены заказа (После изменения даты статус заказа меняется на "Отменен")
"shipped_at": "2025-01-27 09:09:22", // Дата и время отгрузки заказа (После изменения даты статус заказа меняется на "Отгружен")
"delivered_at": "2025-01-29 12:30:00", // Дата и время доставки заказа (После изменения даты статус заказа меняется на "Доставлен")
"shipment_date": "2025-01-27" // Изменение даты плановой отгрузки заказа
}delivered_at и cancelled_at нельзя передавать одновременно. Дата доставки не может быть раньше accepted_at или уже сохранённой shipped_at и не может быть более чем на 24 часа в будущем. Если shipped_at ещё не заполнено, при установке delivered_at оно автоматически получает ту же дату. Доставленный заказ нельзя отменить, а отменённый — отметить доставленным. Повторная передача доставки или отмены не изменяет уже сохранённую дату.
Ответ
Варианты ответов:
- 200 - заказ успешно изменён;
- 400 - некорректная дата или недопустимый переход между статусами;
- 404 - номер заказа не найден. Для изменения
shipment_dateилиshipped_atтакже возвращается 404, если заказ уже отгружен, доставлен или отменён.
Получение подробной информации по конкретному заказу из раздела Упаковка для магазина с типом API
Доступно только для магазинов с типом API
Запрос
js
GET https://поддомен.oship.ru/api/shop/orders/{order number}
Authorization: **API key вашего магазина oShip**order number - номер заказа
Ответ
js
{
"number": Номер заказа,
"alt_numbers": Альтернативные номера заказов,
"comment": Текст комментария,
"shipment_date": Планируемая дата отгрузки,
"status": Статус заказа (возможные значения: accepted, packaged, shipped, delivered, cancelled),
"accepted_at": Дата приёма заказа,
"packaged_at": Дата упаковки заказа,
"shipped_at": Дата отгрузки заказа,
"delivered_at": Дата доставки заказа,
"cancelled_at": Дата отмены заказа,
"products": [
{
"code": Код товара,
"name": Название товара,
"sale_price": Цена продажи одной единицы в российских копейках или null,
"cis": Код "Честный знак",
"cis_requirement": Требование к коду (none, required или optional),
"imei": IMEI товара,
"imei_requirement": Требование к IMEI (none, required или optional),
"assigned_at": Дата сканирования товара при упаковке
},
...
],
"packages": [
{
"number": Номер грузового места,
"barcode": Штрих-код грузового места,
"status": Статус грузового места (возможные значения: accepted,packaged,shipped),
"packaged_at": Дата упаковки грузового места,
"shipped_at": Дата отгрузки грузового места
},
...
]
}Получение списка заказов раздела Упаковка конкретного магазина с типом API по планируемой дате отгрузки
Запрос
js
GET https://поддомен.oship.ru/api/shop/orders?shipment_date=2025-01-27
Authorization: Ваш API keyЕсли shipment_date не указан, то по умолчанию возвращаются заказы с планируемой датой отгрузки сегодня
Значение API key доступно при создании магазина с типом API
Ответ
js
[
{
"shop": {
"uuid": UUID магазина,
"name": Название магазина,
"source": {
"name": Название источника магазина,
"slug": техническое наименование источника магазина
}
},
"number": Номер заказа,
"alt_numbers": Альтернативные номера заказов,
"shipment_date": Планируемая дата отгрузки,
"status": Статус заказа (возможные значения: accepted, packaged, shipped, delivered, cancelled),
"comment": Текст комментария,
"accepted_at": Дата приёма заказа,
"packaged_at": Дата упаковки заказа,
"shipped_at": Дата отгрузки заказа,
"delivered_at": Дата доставки заказа,
"cancelled_at": Дата отмены заказа
},
...
]Поставки FBO
Получение списка всех поставок раздела
Запрос
js
GET https://поддомен.oship.ru/api/seller/supplies
Authorization: Ваш API keyВозвращает последние 100 поставок c сортировкой по дате создания.
Ответ
js
[
{
"shop": {
"uuid": UUID магазина,
"name": Название магазина,
"source": {
"name": Название источника магазина,
"slug": техническое наименование источника магазина
}
},
"number": Номер поставки,
"warehouse": Наименование склада маркетплейса,
"shipment_date": Планируемая дата отгрузки,
"status": Статус поставки (возможные значения: accepted, packaging, shipped),
"accepted_at": Дата создания поставки,
"packaging_at": Дата начала сборки поставки,
"shipped_at": Дата окончания сборки поставки
},
...
]Получение списка поставок конкретного магазина
Запрос
js
GET https://поддомен.oship.ru/api/seller/supplies/{shop UUID}
Authorization: Ваш API keyВозвращает последние 100 поставок c сортировкой по дате создания.
Значение для параметра shop_UUID можно узнать из запроса получения списка магазинов
Ответ
js
[
{
"number": Номер поставки,
"warehouse": Наименование склада маркетплейса,
"shipment_date": Планируемая дата отгрузки,
"status": Статус поставки (возможные значения: accepted, packaging, shipped),
"accepted_at": Дата создания поставки,
"packaging_at": Дата начала сборки поставки,
"shipped_at": Дата окончания сборки поставки
},
...
]Получение подробной информации по конкретной поставке
Запрос
js
GET https://поддомен.oship.ru/api/seller/supplies/{shop UUID}/{supplie number}
Authorization: Ваш API keyЗначение для параметра shop_UUID можно узнать из запроса получения списка магазиновsupplie number - номер поставки
Ответ
js
{
"number": Номер поставки,
"warehouse": Наименование склада маркетплейса,
"shipment_date": Планируемая дата отгрузки,
"status": Статус поставки (возможные значения: accepted, packaging, shipped),
"accepted_at": Дата создания поставки,
"packaging_at": Дата начала сборки поставки,
"shipped_at": Дата окончания сборки поставки,
"products": [
{
"code": Артикул товара,
"name": Наименование товара,
"cis": Маркировка "Честный знак",
"assigned_at": Дата сканирования товара при сборке,
"barcodes": Массив штрихкодов товара в поставке,
"cargo_id": Идентификатор грузового места,
"cargo_type": Тип грузового места (возможные значения: PALLET, BOX)
},
...
]
}Важно
Ваш API key доступен на странице Настройки аккаунта