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_datestringНачальная дата
Формат dd.mm.yyyy		Да
end_datestringКонечная дата
Формат dd.mm.yyyy		Нет

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

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

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

ПараметрТипОписание
order_idstringИдентификатор заказа
order_datestringДата заказа
Формат: dd.mm.yyyy hh:mm
Структура Items
ПараметрТипОписание
idstringИдентификатор товара
namestringНаименование товара
countrystringСтрана товара (US, EU, RU, CN)
costintЦена товара

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

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

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

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

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

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

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

{
  "method": "shipments.get",
  "result": [
    {
      "shipment_id": 117897621,
      "shipment_date": "17.11.2025 13:44",
      "items": [
        {
          "order_id": 779965291,
          "id": 9988779965291,
          "name": "16 Pro Max 256 Black",
          "country": "US",
          "cost": 100000,
          "imei": "SLWXYCWFYG"
        }
      ]
    }
  ]
}

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

ПараметрТипОписание
shipment_idintИдентификатор отгрузки
shipment_datestringСтатус отгрузки
Структура items
ПараметрТипОписание
order_idintКоличество товаров в отгрузке
idstringИдентификатор заказа
namestringНаименование товара
countrystringСтрана товара (US, EU, RU, CN)
costintЦена товара
imeistringImei или серийный номер товара

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

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

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

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

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

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

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

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

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

ПараметрТипОписание
balance_startintБаланс на начало дня (до проведения операций)
balance_endintБаланс на конец (после всех проведенных операций)
Структура operations
ПараметрТипОписание
idintТочная дата и время проведения операции
datestringТочная дата и время проведения операции
typestringТип операции (Списание или Начисление)
namestringНаименование операции
amountintСумма
descriptionstringКомментарий к операции

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

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

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

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

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

{
  "method": "pricelist.get"
}

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

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

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

ПараметрТипОписание
brandstringБренд товара
categorystringКатегория товара
subcategorystringПодкатегория товара
idintИдентификатор товара
namestringНаименование товара
countrystringСтрана товара (US, EU, RU, CN)
costintСтоимость товара

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": 177863221,
              "upc": [
                "195949805042"
              ]
            },
            {
              "country": "CN",
              "id": 177863255,
              "upc": [
                "195949804809",
                "195949808043"
              ]
            },
            {
              "country": "EU",
              "id": 177863356,
              "upc": [
                "4549995536423",
                "195949805165",
                "195949805714",
                "195949924422",
                "195949805752"
              ]
            },
            {
              "country": "RU",
              "id": 177861111,
              "upc": []
            }
          ]
        }
      ]
    }
  ]
}

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

ПараметрТипОписание
brandstringБренд товара
categorystringКатегория товара
subcategorystringПодкатегория товара
namestringНаименование товара
Структура countries
ПараметрТипОписание
countrystringСтрана товара (US, EU, RU, CN)
idintИдентификатор товара
upcstringBarcode товара

Ошибки API

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

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

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

ПараметрТипОписание
request_idstringИдентификатор API
codeintКод ошибки
messagestringОписание ошибки

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

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