REST API · JSON

Управляйте магазином
из любого приложения

Подключайте CRM, учётные системы, мобильные приложения и собственные сервисы. RuMarket API открывает безопасный доступ к заказам, товарам, остаткам и клиентам.

Базовый URL
https://your-store.ru/api/v1
TLS 1.2+JSON UTF-8120 req/min
10 минутдо первого запроса
RESTпонятная архитектура
Webhooksсобытия без задержек
99,99%доступность API
01

Быстрый старт

Три шага — и интеграция готова к первому запросу.

1
Создайте приложение

Откройте «Настройки → API» и добавьте новое приложение.

2
Получите ключи

Скопируйте токен и сохраните секретный ключ в защищённом хранилище.

3
Проверьте соединение

Выполните тестовый запрос и получите статус магазина.

curl --request GET \
  --url 'https://your-store.ru/api/v1/ping' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Accept: application/json'
02

Авторизация

Каждый запрос подписывается токеном приложения.

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

◆
Храните ключи на сервере

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

ЗаголовокЗначениеОбязательный
AuthorizationBearer YOUR_TOKENДа
Content-Typeapplication/jsonДля POST/PATCH
X-RuMarket-SignatureHMAC-SHA256 тела запросаДля webhooks
СПРАВОЧНИК МЕТОДОВ

Основные операции API

Адреса, параметры и готовые примеры ответов.

GET

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

/orders
orders.read

Возвращает заказы с фильтрацией по номеру, идентификатору, email покупателя, статусу и периоду создания.

Query-параметры

pageinteger

Номер страницы, по умолчанию 1

limitinteger

От 1 до 100 записей

numberstring

Номер заказа, например RM-10482

emailstring

Email покупателя

statusstring

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

Пример запроса
curl 'https://your-store.ru/api/v1/orders?status=paid&limit=20' \
  -H 'Authorization: Bearer YOUR_TOKEN'
200 OKapplication/json
{
  "data": [{
    "id": 10482,
    "number": "RM-10482",
    "status": "paid",
    "total": 12490,
    "currency": "RUB"
  }],
  "meta": { "page": 1, "total": 86 }
}
POST

Создать заказ

/orders
orders.write

Создаёт заказ с покупателем, товарами, доставкой и способом оплаты. Возвращает полный объект заказа.

{ "customer": {…}, "items": […], "delivery": {…} }Авторизация
PATCH

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

/orders/{id}
orders.write

Обновляет только переданные поля: статус, комментарий менеджера, доставку или оплату.

{ "status": "paid", "manager_comment": "Оплата подтверждена" }200 · Обновлено
DELETE

Удалить заказ

/orders/{id}
orders.delete

Перемещает заказ в корзину. Операцию можно отменить в панели в течение 30 дней.

Внимание

Для окончательного удаления требуется отдельное право приложения.

GET

Товары

/products
catalog.read

Товары, варианты, цены, изображения, характеристики и SEO-поля с фильтрацией по SKU и категории.

skucategory_idupdated_frominclude=variants
GET

Категории

/categories
catalog.read

Возвращает дерево каталога с вложенностью, URL, SEO-метаданными и порядком сортировки.

parent_iddepthinclude=seo
PATCH

Обновить остатки

/stocks/batch
stocks.write

Пакетно синхронизирует остатки по SKU и складам — до 1 000 позиций за запрос.

{ "items": [{ "sku": "RM-001", "warehouse_id": 2, "quantity": 18 }] }До 1000 позиций
GET

Клиенты

/customers
customers.read

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

◆
Персональные данные

Запрашивайте только необходимые поля и соблюдайте требования к их защите.

03

Webhooks

Получайте события сразу после изменений.

order.createdСоздан новый заказ
order.status_changedИзменился статус
product.updatedОбновлён товар
stock.changedИзменился остаток

RuMarket подписывает webhook алгоритмом HMAC-SHA256. Сравнивайте подпись с заголовком X-RuMarket-Signature.

04

Ошибки и статусы

Единый формат упрощает обработку ответа.

200OKЗапрос успешно выполнен
201CreatedРесурс создан
400Bad RequestОшибка в параметрах
401UnauthorizedТокен недействителен
403ForbiddenНедостаточно прав
429Too Many RequestsПревышен лимит
500Server ErrorВнутренняя ошибка API
ГОТОВЫ К ИНТЕГРАЦИИ?

Создайте приложение
и отправьте первый запрос

Тестовая среда не влияет на данные рабочего магазина.

Получить API-ключ →Нужна помощь? Напишите нам
Ничего не найдено. Измените запрос.