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

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

Версия 19:08, 25 апреля 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: null,
  • 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: null
 
 { "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
 }