Public API Set10 API Reference

Здесь представлены все задокументированные REST методы SetRetail 10. В адресе вместо "localhost" следует указать реальный адрес SetRetail 10

API Endpoint

http://localhost:8090/

Contact: setkiosk.dev@crystals.ru

Version: 1.0

Paths

SetKiosk

POST /SetKiosk-API/json/details

Получение информации о товаре (название, цена, и т.д.)

ProductRequestDTO

Объект запроса

Request Example

{
  "barcode": "2838123281399",
  "marking": "00999",
  "shop": "7188",
  "mac": "FJDO223FJFD3"
}

200 OK

AbstractResponseVO

Запрос выполнился

500 Internal Server Error

Любая другая ошибка

Response Example (200 OK)

"object"

Schema Definitions

AbstractResponseVO: object

Ответ с информацией по товару. Возвращется всегда один из наследников

Example

"object"

ErrorResponseVO:

AbstractResponseVO

Неудачный запрос информации о товаре

errorCode: string: Код ошибки
description: string: Описание ошибки

Example

{
  "errorCode": "1",
  "description": "Barcode Not Found"
}

ProductDetailsVO: object

Доп. информация о товаре

producerName: string: Изготовитель
composition: string: Состав
storageCondition: string: Условия хранения
foodValue: string: Пищевая ценность
certificationType: integer (int32): Тип сертификации. 0, NULL - нет сертификации, 1 - обязательная, сертификация, 2 - добровольная сертификация, 4 - технический регламент, 8 - EAC

Example

{
  "producerName": "Изготовитель",
  "composition": "2 мясный котлеты гриль, специальный соус-сыр, огурцы, салат и лук- всё на булочке с кунжутом",
  "storageCondition": "Хранить при температуре от +15'C до 21'C и относительной влажности воздуха не более 75%. Срок годности: 270 дней. ТУ 9125-007-4049419",
  "foodValue": "на 100г продукта: белки 5,3г, углеводы 63,5г (в т.ч.сахара 57,5г),жиры 24,0г, пищевые волокна 2,6г, натрий 0,25г. Энергическая ценность: 495 ккал.",
  "certificationType": 1
}

ProductRequestDTO: object

Запрос на получение деталей о продукте

barcode: string: ШК товара. Обязательно, если не передаётся артикул
marking: string: Артикул товара. Обязательно, если не передается ШК
shop: string: Номер магазина, для которого ищется информация (например, на разных магазин разные цены). Обязательно, если запрос отправляется на Centrum
mac: string: MAC-адрес устройства

Example

{
  "barcode": "2838123281399",
  "marking": "00999",
  "shop": "7188",
  "mac": "FJDO223FJFD3"
}

ProductResponseVO:

AbstractResponseVO

Успешный ответ с продуктом

product: ProductVO: Продукт

Example

{
  "product": {
    "title": "Бигмак",
    "barcode": "4603934000706",
    "marking": "000006",
    "details": [
      {
        "producerName": "Изготовитель",
        "composition": "2 мясный котлеты гриль, специальный соус-сыр, огурцы, салат и лук- всё на булочке с кунжутом",
        "storageCondition": "Хранить при температуре от +15'C до 21'C и относительной влажности воздуха не более 75%. Срок годности: 270 дней. ТУ 9125-007-4049419",
        "foodValue": "на 100г продукта: белки 5,3г, углеводы 63,5г (в т.ч.сахара 57,5г),жиры 24,0г, пищевые волокна 2,6г, натрий 0,25г. Энергическая ценность: 495 ккал.",
        "certificationType": 1
      }
    ],
    "grossPrice": 100.5,
    "oldGrossPrice": 105.5,
    "cardPrice": 10.5,
    "oldCardPrice": 11.5,
    "type": "WEIGHT",
    "unitPrice": 11.5,
    "count": 11.5,
    "measure": "кг."
  }
}

ProductVO: object

Продукт

title: string: Название товара
barcode: string: ШК товара
marking: string: Артикул товара
details: ProductDetailsVO: блок с доп инфо
ProductDetailsVO
grossPrice: number: Цена товара
oldGrossPrice: number: Старая цена товара
cardPrice: number: Цена товара по карте
oldCardPrice: number: Старая цена товара по карте
type: string PIECE, WEIGHT: Тип товара
unitPrice: number: Цена за целевую единицу (1кг, 100 гр. ...)
count: number: Количество весового товара (кг)
measure: string: Единица измерения

Example

{
  "title": "Бигмак",
  "barcode": "4603934000706",
  "marking": "000006",
  "details": [
    {
      "producerName": "Изготовитель",
      "composition": "2 мясный котлеты гриль, специальный соус-сыр, огурцы, салат и лук- всё на булочке с кунжутом",
      "storageCondition": "Хранить при температуре от +15'C до 21'C и относительной влажности воздуха не более 75%. Срок годности: 270 дней. ТУ 9125-007-4049419",
      "foodValue": "на 100г продукта: белки 5,3г, углеводы 63,5г (в т.ч.сахара 57,5г),жиры 24,0г, пищевые волокна 2,6г, натрий 0,25г. Энергическая ценность: 495 ккал.",
      "certificationType": 1
    }
  ],
  "grossPrice": 100.5,
  "oldGrossPrice": 105.5,
  "cardPrice": 10.5,
  "oldCardPrice": 11.5,
  "type": "WEIGHT",
  "unitPrice": 11.5,
  "count": 11.5,
  "measure": "кг."
}

Documentation by Spectacle