RM Group Клиентский API

API документация

Варианты использования

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

С чего начать

Ознакомьтесь с документацией и примерами
Зарегистрируйте своё приложение на площадке

Доступ к API

Подключение к API и его использование является платным.

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

Взаимодействие с API

Запросы к API выполняются от имени магазина по протоколу HTTPS методом POST. Авторизационный токен и другие специальные параметры передаются в HTTP-заголовке. В каждом запросе обязательно должен передаваться авторизационный токен.

API поддерживает один формат взаимодействия: JSON. Входные и выходные структуры данных передаются в теле запроса и ответа.

Для работы используется единый адрес: https://api-c.rmgroup.website/

Пример HTTP-заголовка

Auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoidGVzdCIsImlhdCI6MTU5OTYxNjM2NywiZXhwIjoxNTk5NzAyNzU3fQ.NLJV_KwOKlfRxP09wUlrjQYxwclKxT_hiJWb4rjZMSk

Orders: получение заказов

Метод возвращает заказы, соответствующие заданным критериям.

Структура запроса

{
  "method": "orders.get",
  "params": {
    "start_date": "string",
    "end_date": "string"
  }
}

Параметры запроса

Параметр	Тип	Описание	Обязательный
start_date	string	Начальная дата Формат dd.mm.yyyy	Да
end_date	string	Конечная дата Формат dd.mm.yyyy	Нет

Структура ответа

{
  "method": "orders.get",
  "result": [
    {
      "оrder_id": "O-11789762",
      "order_date": "17.11.2025 13:44",
      "items": [
        {
          "id": "P-99887799",
          "name": "16 Pro Max 256 Black",
          "country": "US",
          "cost": 100000
        }
      ]
    }
  ]
}

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

Параметр	Тип	Описание
order_id	string	Идентификатор заказа
order_date	string	Дата заказа Формат: dd.mm.yyyy hh:mm

Структура Items

Параметр	Тип	Описание
id	string	Идентификатор товара
name	string	Наименование товара
country	string	Страна товара (US, EU, RU, CN)
cost	int	Цена товара

Orders: расчёт цены

Метод возвращает расчёт стоимости по списку товаров.

Структура запроса

{
  "method": "orders.price",
  "params": {
    "items": [
      { "product_country_id": "P-12345678" },
      { "product_country_id": "P-87654321" }
    ]
  }
}

Параметры items

Параметр	Тип	Описание	Обязательный
product_country_id	string	Идентификатор товара по стране	Да

Структура ответа

{
  "method": "orders.price",
  "result": {
    "expires_at": "2026-06-03T15:30:00.123456",
    "items": [
      {
        "key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "id": "P-12345678",
        "name": "iPhone 15 Pro",
        "country": "EU",
        "cost": 850,
        "engraving_cost": 50,
        "total_cost": 900
      },
      {
        "key": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "id": "P-87654321",
        "name": "Silicone Case",
        "country": "CN",
        "cost": 12,
        "engraving_cost": null,
        "total_cost": 12
      }
    ]
  }
}

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

Параметр	Тип	Описание
expires_at	string	Срок действия расчёта (ISO 8601)

Структура items

Параметр	Тип	Описание
key	string	Ключ расчёта для orders.add
id	string	Идентификатор товара
name	string	Наименование товара
country	string	Страна товара (US, EU, RU, CN)
cost	int	Цена товара
engraving_cost	int \| null	Стоимость гравировки; null, если недоступна
total_cost	int	Итоговая стоимость позиции

Orders: создание заказа

Метод подтверждает заказ по ключам расчёта цены. Структура ответа совпадает с orders.get.

Структура запроса

{
  "method": "orders.add",
  "params": {
    "items": [
      { "key": "a1b2c3d4-....", "quantity": 2 },
      { "key": "e5f6g7h8-....", "quantity": 5, "engraving": false }
    ]
  }
}

Параметры items

Параметр	Тип	Описание	Обязательный
key	string	Ключ из ответа orders.price	Да
quantity	int	Количество	Да
engraving	boolean	Гравировка	Нет

Структура ответа

{
  "method": "orders.add",
  "result": {
    "order_id": "O-12345678",
    "order_date": "09.06.2026 14:30",
    "items": [
      {
        "id": "P-XXXXXXXX",
        "name": "Product name",
        "country": "US",
        "cost": 150000
      }
    ]
  }
}

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

Параметр	Тип	Описание
order_id	string	Идентификатор заказа
order_date	string	Дата заказа Формат: dd.mm.yyyy hh:mm

Структура items

Параметр	Тип	Описание
id	string	Идентификатор товара
name	string	Наименование товара
country	string	Страна товара (US, EU, RU, CN)
cost	int	Цена товара

Shipments: получение отгрузок

Метод возвращает отгрузки, соответствующие заданным критериям.

Структура запроса

{
  "method": "shipments.get",
  "params": {
    "start_date": "string",
    "end_date": "string"
  }
}

Параметры запроса

Параметр	Тип	Описание	Обязательный
start_date	string	Начальная дата Формат dd.mm.yyyy	Да
end_date	string	Конечная дата Формат dd.mm.yyyy	Нет

Структура ответа

{
  "method": "shipments.get",
  "result": [
    {
      "shipment_id": "L-11789762",
      "shipment_date": "17.11.2025 13:44",
      "items": [
        {
          "order_id": "O-11789762",
          "id": "P-99887799",
          "name": "16 Pro Max 256 Black",
          "country": "US",
          "cost": 100000,
          "imei": "SLWXYCWFYG"
        }
      ]
    }
  ]
}

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

Параметр	Тип	Описание
shipment_id	string	Идентификатор отгрузки
shipment_date	string	Статус отгрузки

Структура items

Параметр	Тип	Описание
order_id	string	Количество товаров в отгрузке
id	string	Идентификатор заказа
name	string	Наименование товара
country	string	Страна товара (US, EU, RU, CN)
cost	int	Цена товара
imei	string	Imei или серийный номер товара

Financials: финансовые операции

Метод возвращает финансовые операции.

Структура запроса

{
  "method": "financials.get",
  "params": {
    "start_date": "string",
    "end_date": "string"
  }
}

Параметры запроса

Параметр	Тип	Описание	Обязательный
start_date	string	Начальная дата Формат dd.mm.yyyy	Да
end_date	string	Конечная дата Формат dd.mm.yyyy	Нет

Структура ответа

{
  "method": "financials.get",
  "result": [
    {
      "balance_start": 0,
      "balance_end": -500,
      "operations": [
        {
          "id": "99885527",
          "date": "17.11.2025 13:44",
          "type": "Начисление" | "Списание",
          "name": "Возмещение по браку",
          "amount": 66000,
          "description": "Компенсация за брак"
        }
      ]
    }
  ]
}

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

Параметр	Тип	Описание
balance_start	int	Баланс на начало дня (до проведения операций)
balance_end	int	Баланс на конец (после всех проведенных операций)

Структура operations

Параметр	Тип	Описание
id	string	Точная дата и время проведения операции
date	string	Точная дата и время проведения операции
type	string	Тип операции (Списание или Начисление)
name	string	Наименование операции
amount	int	Сумма
description	string	Комментарий к операции

Pricelist: получение прайс-листа

Метод возвращает список товаров с ценами. Цены и список товаров обновляется каждые 15–30 минут в течение всего рабочего времени прайс-листа.

Рабочее время прайс-листа: с 11:00 до 18:00 (МСК).

В любое другое время вы получите ошибку 425. См. описание ошибок.

Структура запроса

{
  "method": "pricelist.get"
}

Структура ответа

{
  "method": "pricelist.get",
  "result": [
    {
      "items": [
        {
          "brand": "Apple",
          "category": "iPhone",
          "subcategory": "iPhone 16 Pro Max",
          "id": "P-99887799",
          "name": "16 Pro Max 256 Black",
          "country": "US",
          "cost": 100000
        }
      ]
    }
  ]
}

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

Параметр	Тип	Описание
brand	string	Бренд товара
category	string	Категория товара
subcategory	string	Подкатегория товара
id	string	Идентификатор товара
name	string	Наименование товара
country	string	Страна товара (US, EU, RU, CN)
cost	int	Стоимость товара

Products: получение товаров

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

Структура запроса

{
  "method": "products.get"
}

Структура ответа

{
  "method": "products.get",
  "result": [
    {
      "items": [
        {
          "brand": "Apple",
          "category": "iPhone",
          "subcategory": "iPhone 16 Pro Max",
          "name": "16 Pro Max 256 Black",
          "countries": [
            {
              "country": "US",
              "id": "P-17786322",
              "upc": [
                "195949805042"
              ]
            },
            {
              "country": "CN",
              "id": "P-17786322",
              "upc": [
                "195949804809",
                "195949808043"
              ]
            },
            {
              "country": "EU",
              "id": "P-17786322",
              "upc": [
                "4549995536423",
                "195949805165",
                "195949805714",
                "195949924422",
                "195949805752"
              ]
            },
            {
              "country": "RU",
              "id": "P-17786322",
              "upc": []
            }
          ]
        }
      ]
    }
  ]
}

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

Параметр	Тип	Описание
brand	string	Бренд товара
category	string	Категория товара
subcategory	string	Подкатегория товара
name	string	Наименование товара

Структура countries

Параметр	Тип	Описание
country	string	Страна товара (US, EU, RU, CN)
id	string	Идентификатор товара
upc	string	Barcode товара

Ошибки API

Структура ответа

{
  "error": {
    "request_id": "string",
    "code": int,
    "message": "string"
  }
}

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

Параметр	Тип	Описание
request_id	string	Идентификатор API
code	int	Код ошибки
message	string	Описание ошибки

Коды и описание ошибок

Код	Сообщение	Описание
403	Нет доступа к API	У приложения отсутствуют права доступа
422	Неверные параметры	Некорректные параметры запроса
429	Превышен лимит запросов	Максимум 5 запросов в секунду Не более 100 запросов в минуту
500	Сервер временно недоступен	Повторите запрос через некоторое время
400	Некорректные данные	Проверьте корректность передаваемых данных
404	Не найдено	Запрашиваемый ресурс не найден
425	Прайс-лист не работает	Время работы прайс-листа с 11 до 18 мск