r_keeper Lite
API справочников
Содержание инструкции:
Товарные группы
Контрагенты
Номенклатура
Склады
Остатки по складам
Юридические лица
Заведения/рестораны
Создание/редактирование приходной накладной
Методы API доступны только для внутренних интеграций.
URL метода API (GET)
https://litepilot-api.r-keeper.ru/mixcart/v1.0/partners

Формат запроса
Тело запроса не заполняется.

Заголовок запроса
Контрагенты
Формат ответа
{
  "result": [
    {
      "id": "eb5b18f6-d3b3-4648-bb19-4e5a8a5cb696",
      "name": " ООО \"Ромашка\"",
      "inn": "313456789345",
      "kpp": "3198765432"
    }
  ],
  "error": {
    "code": "001",
    "msg": "Возникла какая-то ошибка"
  }
}
Описание параметров
URL метода API (GET)
https://litepilot-api.r-keeper.ru/mixcart/v1.0/nomenclatureGroups

Формат запроса
Тело запроса не заполняется.

Заголовок запроса
Товарные группы
Формат ответа
{
  "result": [
    {
      "id": "e450225b-02e3-4c6e-b7c1-3680438febc1", 
      "name": "Рецепты бабушки",
      "parentId": "d3774c06-aa55-4c8c-92cc-80eb241860c0"
    }
  ],
  "error": {
    "code": "001",
    "msg": "Возникла какая-то ошибка"
  }
}
Описание параметров
URL метода API (GET)
https://litepilot-api.r-keeper.ru/mixcart/v1.0/nomenclatures

Формат запроса
Тело запроса не заполняется.

Заголовок запроса
Номенклатура
Формат ответа
{
  "result": [
    {
      "id": "11bc1fb0-4cc0-4fc6-9a89-cd915c96db0c",
      "name": "Плавник акулы (заморозка)",
      "groupId": "d3774c06-aa55-4c8c-92cc-80eb241860c0",
      "unit": {
        "id": "987a3d92-7a9e-4048-96ca-0de04b7811dc",
        "name": "кг"
      },
      "price": 10
    }
  ],
  "error": {
    "code": "001",
    "msg": "Возникла какая-то ошибка"
  }
}
Описание параметров
URL метода API (GET)
https://litepilot-api.r-keeper.ru/mixcart/v1.0/stores

Формат запроса
Тело запроса не заполняется.

Заголовок запроса
Склады
Формат ответа
{
  "result": [
    {
      "id": "aa372278-ea27-4c71-a88a-233a18ec7fa5",
      "name": "Горячий цех"
    }
  ],
  "error": {
    "code": "001",
    "msg": "Возникла какая-то ошибка"
  }
}
Описание параметров
URL метода API (GET)
https://litepilot-api.r-keeper.ru/mixcart/v1.0/stocks

Формат запроса
Тело запроса не заполняется.

Заголовок запроса
Остатки по складам
Формат ответа
{
  "result": [
    {
      "productId": "11bc1fb0-4cc0-4fc6-9a89-cd915c96db0c",
      "unitId": "987a3d92-7a9e-4048-96ca-0de04b7811dc",
      "storeId": "aa372278-ea27-4c71-a88a-233a18ec7fa5",
      "amount": 20
    }
  ],
  "error": {
    "code": "001",
    "msg": "Возникла какая-то ошибка"
  }
}
Описание параметров
URL метода API (GET)
https://litepilot-api.r-keeper.ru/product-orders/v1.0/legalEntities

Формат запроса
Тело запроса не заполняется.

Заголовок запроса
Юридические лица
Формат ответа
{
  "result": [
    {
      "id": "fc2a19b5-4573-469f-b36f-187d3e6e9649",
      "name": "ООО Кафе",
      "inn": "313456789345",
      "kpp": "3198765432",
      "okpo": "12345678",
      "okved": "01",
      "legalAddress": "Большая Лубянка, 101",
      "actualAddress": "Большая Лубянка, 102",
      "email": "aaa@aaa.aa",
      "phoneNumber": "1(234)5-67-89",
      "regNumber": "1234",
      "head": "Василий Алибабаевич",
      "accountant": "Иван Иванович",
      "technologist": "Петр Петрович",
      "productionDirector": "Сергей Серегеевич",
      "paymentAccount": "12345678901234567890",
      "bik": "123456",
      "bankName": "ООО Рога и копыта",
      "bankCity": "Москва",
      "correspondentAccount": "123456789012345",
      "iban": "123456",
      "swiftBic": "123456",
      "isMain": true
    }
  ],
  "error": {
    "code": "001",
    "msg": "Возникла какая-то ошибка"
  }
}
Описание параметров
URL метода API (GET)
https://litepilot-api.r-keeper.ru/product-orders/v1.0/points

Формат запроса
Тело запроса не заполняется.

Заголовок запроса
Заведения/рестораны
Формат ответа
{
  "result": [
    {
      "id": "fc2a19b5-4573-469f-b36f-187d3e6e9649",
      "name": "Заведение на Лубянке",
      "code": 123,
      "actualAddress": "Большая Лубянка, 100",
      "email": "aaa@aaa.aa",
      "website": "https://aaa.aa/",
      "phoneNumbers": [
        "1(234)5-67-89"
      ],
      "additionalNumbers": [
        "000"
      ],
      "language": "Русский",
      "timezone": "Europe/Moscow",
      "currencyId": "4e9d964f-e797-4a85-9360-034bc1073efd",
      "workingDayStart": "08:00:00",
      "workingDayEnd": "23:30:00",
      "legalEntities": [
        "95ce9a15-9ff8-446b-9fee-001ac866e485"
      ],
      "stores": [
        "aa372278-ea27-4c71-a88a-233a18ec7fa5"
      ]
    }
  ],
  "error": {
    "code": "001",
    "msg": "Возникла какая-то ошибка"
  }
}
Описание параметров
URL метода API (POST)
https://litepilot-api.r-keeper.ru/product-orders/v1.0/receipts

Формат запроса
Тело запроса:
Создание/редактирование приходной накладной
{
  "date": "2020-08-19 10:00:00",
  "agentId": "eb5b18f6-d3b3-4648-bb19-4e5a8a5cb696",
  "storeId": "aa372278-ea27-4c71-a88a-233a18ec7fa5",
  "note": "",
  "waybillNumber": "89890",
  "invoiceNumber": "789456/22",
  "products": [
    {
      "productId": "11bc1fb0-4cc0-4fc6-9a89-cd915c96db0c",
      "unitId": "987a3d92-7a9e-4048-96ca-0de04b7811dc",
      "quantity": 100,
      "sum": 1000,
      "sumVat": 0,
      "vatRate": 0
    }
  ]
}
Заголовок запроса
Формат ответа
{
  "error": {
    "code": "001",
    "msg": "Возникла какая-то ошибка"
  }
}
Описание параметров запроса
Описание параметров ответа
Особенности метода

1. В случае успешного выполнения метод вернёт пустой json-объект.

2. Если после успешного выполнения метода отправить новый запрос с таким же waybillNumber, накладная из первого запроса будет изменена в соответствии с новым запросом.

3. Если передаваемый идентификатор единицы измерения одной из номенклатур отличается от справочного значения в RK Lite, метод вернёт ошибку «Единицы измерения в номенклатуре отличаются от справочных».