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

Материал из Касса
Перейти к навигации Перейти к поиску
Строка 21: Строка 21:
|content-left= 
|content-left= 
* '''organizationId''': ID организации
* '''organizationId''': ID организации
* '''barcode''': Штрихкод,
* '''barcode''': Штрихкод
* '''vendorCode''': Код поставщика,
* '''vendorCode''': Код поставщика
* '''name''': Наименование номенклатуры,
* '''name''': Наименование номенклатуры
* '''vatId''': НДС ID,
* '''vatId''': НДС ID
* '''vatValue''': НДС,
* '''vatValue''': НДС
* '''unitCode''': Единица измерения,
* '''unitCode''': Единица измерения
* '''volume''': null,
* '''volume''': null
* '''purchasePrice''': Цена закупки,
* '''purchasePrice''': Цена закупки
* '''sellingPrice''': Цена продажи,
* '''sellingPrice''': Цена продажи
* '''weighted''':   (true/false),
* '''weighted''':   Весовой товар (true/false)
* '''grouped''': Группа (true/false),
* '''grouped''': Группа (true/false)
* '''focused''': Фокусный товар (true/false),
* '''focused''': Фокусный товар (true/false)
* '''container''': true,
* '''container''': true
* '''paymentSubject''': Предмет расчета (Товар, Платеж, Залог, Выигрыш лотереи и др.),
* '''paymentSubject''': Предмет расчета (Товар, Платеж, Залог, Выигрыш лотереи и др.)
* '''adultsOnly''': Возрастное ограничение товара,
* '''adultsOnly''': Возрастное ограничение товара
* '''code''': Код,
* '''code''': Код
* '''markType''': Тип маркировки номенклатуры (Алкоголь, Табак, Обувь, Парфюмерия, СИЗ, Другая),
* '''markType''': Тип маркировки номенклатуры (Алкоголь, Табак, Обувь, Парфюмерия, СИЗ, Другая)
* '''gtin''': Код GTIN,
* '''gtin''': Код GTIN
* '''pluCode''': PLU код,
* '''pluCode''': PLU код
* '''template''': Шаблон,
* '''template''': Шаблон
* '''visible''': Видимость (true/false),
* '''visible''': Видимость (true/false)
* '''contractorActivityType''': Признак агента (Агент, Комиссионер, Платежный агент, Платежный субагент и др.)
* '''contractorActivityType''': Признак агента (Агент, Комиссионер, Платежный агент, Платежный субагент и др.)
* '''contractorId''': ID агента,
* '''contractorId''': ID агента
* '''custom''': false,
* '''custom''': false
* '''type''': Тип номенклатурной позиции( Товар, Рецепт, Комплект, Шаблон),
* '''type''': Тип номенклатурной позиции( Товар, Рецепт, Комплект, Шаблон)
* '''compositeGoods''': Тип товара (Товар, Рецепт, Комплект, Шаблон),
* '''compositeGoods''': Тип товара (Товар, Рецепт, Комплект, Шаблон)
* '''barcodes''': Штрихкод,
* '''barcodes''': Штрихкод
* '''countryCode''': Код страны,
* '''countryCode''': Код страны
* '''customsDeclaration''': null,
* '''customsDeclaration''': Таможенная деларация
* '''description''': Описание,
* '''description''': Описание
* '''picturesIds''': ID изображения,
* '''picturesIds''': ID изображения
* '''application''': "KASSA",
* '''application''': Название приложения (KASSA)
'''nomenclatureFeatures''': Характеристика товара  
'''nomenclatureFeatures''': Характеристика товара  
** '''id''': ID характеристики,
** '''id''': ID характеристики
** '''nomenclatureId''':  "ID номенклатуры",
** '''nomenclatureId''':  ID номенклатуры
** '''featureId''': "Идентификатор номенклатуры",
** '''featureId''': Идентификатор номенклатуры
** '''value''': Цена
** '''value''': Цена
** '''organizationId''' : "ID организации",
** '''organizationId''' : ID организации
'''tradeObjectRelations''':  
'''tradeObjectRelations''': Данные номенклатуры в торговом объекте
** '''nomenclatureId''': "ID номенклатуры",
** '''nomenclatureId''': ID номенклатуры
** '''organizationId''': "ID организации",
** '''organizationId''': ID организации
** '''sellingPrice''':Цена продажи,
** '''sellingPrice''': Цена продажи
** '''tradeObjectId''': "ID торгового объекта"
** '''tradeObjectId''': ID торгового объекта
* '''orgMemberPoints''': Баллы KPI,
* '''orgMemberPoints''': Баллы KPI
* '''blockedNomenclatureList''': null
* '''blockedNomenclatureList''': Номенклатура, входящая в стоп-лист
|content-right= 
|content-right= 
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">

Версия 10:12, 26 апреля 2022

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

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



Request Body type: raw (JSON)
 
  • organizationId: ID организации
  • barcode: Штрихкод
  • vendorCode: Код поставщика
  • name: Наименование номенклатуры
  • vatId: НДС ID
  • vatValue: НДС
  • unitCode: Единица измерения
  • volume: null
  • purchasePrice: Цена закупки
  • sellingPrice: Цена продажи
  • weighted: Весовой товар (true/false)
  • grouped: Группа (true/false)
  • focused: Фокусный товар (true/false)
  • container: true
  • paymentSubject: Предмет расчета (Товар, Платеж, Залог, Выигрыш лотереи и др.)
  • adultsOnly: Возрастное ограничение товара
  • code: Код
  • markType: Тип маркировки номенклатуры (Алкоголь, Табак, Обувь, Парфюмерия, СИЗ, Другая)
  • gtin: Код GTIN
  • pluCode: PLU код
  • template: Шаблон
  • visible: Видимость (true/false)
  • contractorActivityType: Признак агента (Агент, Комиссионер, Платежный агент, Платежный субагент и др.)
  • contractorId: ID агента
  • custom: false
  • type: Тип номенклатурной позиции( Товар, Рецепт, Комплект, Шаблон)
  • compositeGoods: Тип товара (Товар, Рецепт, Комплект, Шаблон)
  • barcodes: Штрихкод
  • 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":0,
  "tradeObjectId": "ID торгового объекта"
  }],
    "orgMemberPoints": null,
    "blockedNomenclatureList": null
 }