API:Создание номенклатуры в справочнике товаров

Материал из Касса
Перейти к навигации Перейти к поиску

Общие сведения

API (Application Programming Interface или интерфейс программирования приложений) — совокупность инструментов и функций в виде интерфейса для создания новых приложений и интеграции с ИС. Все запросы к сервису БИФИТ Бизнес осуществляются при помощи авторотационного токена - access_token. Для генерации токена, необходимо пройти процедуру авторизации OAuth2. Для этого необходимо использовать логин/пароль зарегистрированной учетной записи.


Создание номенклатурной позиции в справочнике товаров

Запрос POST

URL: https://kassa.bifit.com/cashdesk-api/v1/protected/nomenclatures
https://kassa.bifit.com/cashdesk-api/v1/protected/nomenclatures


Note.svg Важно!
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение acces_token> .


Request HEADERS HEADERS
 
  • передача access_token
  • отключение компрессии
Authorization: "Bearer <значение acces_token>"
Accept-Encoding: "deflate"



Request Body type: raw (JSON)
 
  • organizationId: ID организации
  • barcode: Штрих код позиции (EAN-8, EAN-13)
  • vendorCode: Артикул производителя
  • name: Наименование номенклатуры
  • vatId: НДС ID
  • vatValue: НДС
  • unitCode: Код единицы измерения по ОКЕИ
  • volume: Значение объема
  • purchasePrice: Цена закупки
  • sellingPrice: Цена продажи
  • weighted: Весовой товар (true/false)
  • grouped: Группа (true/false)
  • focused: Фокусный товар (true/false)
  • container: товар типа Комплект (true/false)
  • paymentSubject: Признак предмета расчёта (Товар, Платеж, Залог, Выигрыш лотереи и др.)
  • adultsOnly: Возрастное ограничение товара
  • code: Код
  • markType: Тип маркировки номенклатуры (Алкоголь, Табак, Обувь, Парфюмерия, СИЗ, Другая)
  • gtin: Код GTIN
  • pluCode: PLU код
  • template: Шаблон
  • visible: Видимость (true/false)
  • contractorActivityType: Признак агента (Агент, Комиссионер, Платежный агент, Платежный субагент и др.)
  • contractorId: ID агента
  • custom: Наличие характеристики у номенклатуры (true/false)
  • type: Тип номенклатурной позиции( Товар, Рецепт, Комплект, Шаблон)
  • compositeGoods: Тип товара (Товар, Рецепт, Комплект, Шаблон)
  • barcodes: Штрих код позиции (EAN-8, EAN-13)
  • countryCode: Код страны
  • customsDeclaration: Таможенная декларация
  • description: Описание
  • picturesIds: ID изображения
  • application: Название приложения (KASSA)

nomenclatureFeatures: Характеристика товара

  • id: ID характеристики
  • nomenclatureId: ID номенклатуры
  • featureId: Идентификатор номенклатуры
  • value: Цена
  • organizationId : ID организации

tradeObjectRelations: Данные номенклатуры в торговом объекте

  • nomenclatureId: ID номенклатуры
  • organizationId: ID организации
  • sellingPrice: Цена продажи
  • tradeObjectId: ID торгового объекта
  • orgMemberPoints: Баллы KPI
  • blockedNomenclatureList: Номенклатура, входящая в стоп-лист
 
 {
    "item": {
        "organizationId": "ID организации",
        "barcode": null,
        "vendorCode": null,
        "name": "Наименование номенклатуры",
        "vatId": 5,
        "vatValue": 20,
        "unitCode": 796,
        "volume": null,
        "purchasePrice": null,
        "sellingPrice": 60,
        "weighted": false,
        "grouped": false,
        "focused": false,
        "container": true,
        "paymentSubject": "PRODUCT",
        "adultsOnly": false,
        "code": null,
        "markType": "UNKNOWN",
        "gtin": null,
        "pluCode": null,
        "template": null,
        "visible": true,
        "contractorActivityType": null,
        "contractorId": null,
        "custom": false,
        "type": "DEFAULT",
        "compositeGoods": [],
        "barcodes": [],
        "countryCode": null,
        "customsDeclaration": null,
        "description": null,
        "picturesIds": [],
        "application": "KASSA"
    },
    "nomenclatureFeatures": [
        {
            "id": null,
            "nomenclatureId": "ID номенклатуры",
            "featureId": "Идентификатор номенклатуры",
            "value": null
        }
    ],
    "organizationId": "ID организации",
    "tradeObjectRelations": [
        {
            "nomenclatureId": "ID номенклатуры",
            "organizationId": "ID организации",
            "sellingPrice": 60,
            "tradeObjectId": "ID торгового объекта"
        }
    ],
    "orgMemberPoints": null,
    "blockedNomenclatureList": null
}



Response

ID созданной номенклатуры
23923080


Note.svg Примечание
После получения ID созданного онлайн заказа, укажите его в поисковом запросе https://kassa.bifit.com/cashdesk/#/app_cashdesk/goods/nomenclature/edit?id= после знака равно.