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



Request Body type: raw (JSON)
 
  • adultsOnly: Возрастное ограничение товара
  • application: Заявка на какое приложение ссылаться Касса Розница или ЛК
  • barcode: Штрихкод
  • barcodes: Штрихкоды
  • blockedNomenclatureList: (Номенклатура, входящая в Стоп-лист)
    • created: Время создания номенклатуры
    • nomenclatureId: ID номенклатурной позиции
    • organizationId: ID организации
    • tradeObjectId: ID торгового объекта
  • changed: время изменения номенклатуры
  • code: ()
  • CompositeGood:
    • compositeType: Тип товара (Товар, Рецепт, Комплект, Шаблон)
    • extCode: Артикул
    • linkId: ()
    • nomenclatureId: ID номенклатуры
    • parentId: ID создаваемого товара
    • price: Цена
    • quantity: Количество
  • container: (Вопрос что это такое)
  • contractorActivityType: Признак агента (Агент, Комиссионер, Платежный агент, Платежный субагент и др.)
  • contractorId: ID агента
  • countryCode: Код страны
  • created: Время создание номенклатуры
  • custom: false ()
  • customsDeclaration: (Не понятно что это такое)
  • description: Описание номенклатуры
  • externalCode: Артикул
  • externalId: Внешний ID
  • focused: Фокусный товар
  • grouped: Принадлежность к группе
  • gtin: GTIN код
  • id: (Какой то ID)
  • markType: Тип маркировки номенклатуры (Алкоголь, Табак, Обувь, Парфюмерия, СИЗ, Другая)
  • name: Наименование номенклатуры
  • NomenclatureFeature (Характеристика номенклатуры)
    • created: время создания номенклатуры
    • featureId: ID особенности
    • id: Характеристики
    • nomenclatureId: ID номенклатуры
    • value: Цена
  • orgMemberPoints: Количество баллов KPI
  • organizationId: ID организации
  • parentId: ID создаваемого товара
  • paymentSubject: Предмет расчета (Товар, Платеж, Залог, Выигрыш лотереи и др.)
  • picture: Изображение номенклатуры
  • picturesIds: ID изображения
  • pluCode: Код PLU
  • purchasePrice: Цена закупки
  • sellingPrice: Цена продажи
  • tradeObjectRelations: (Принадлежность к определенному торговому объекту)
    • TradeObjectNomenclature (Номенклатура торгового объекта)
    • nomenclatureId: ID номенклатуры
    • orgMemberPoints: Количество баллов KPI
    • organizationId: ID организации
    • sellingPrice: Цена продажи
    • tradeObjectId: ID торгового объекта
  • type: Тип номенклатурной позиции( Товар, Рецепт, Комплект, Шаблон)
  • unitCode: Единица измерения
  • vatId: НДС ID
  • vatValue: НДС
  • vendorCode: Код Поставщика
  • visible: ()
  • volume: ()
  • weighted: ()
  • organizationId: ID организации
 
 {
  "item": {
    "adultsOnly": false,
    "application": "KASSA",
    "barcode": "string",
    "barcodes": [null],
    "blockedNomenclatureList": [
      {
        "created": 0,
        "nomenclatureId": 0,
        "organizationId": "ID организации",
        "tradeObjectId": "string"
      }
    ],
    "changed": 0,
    "code": "null",
    "compositeGoods": [
      {
        "compositeType": "INGREDIENT",
        "extCode": "string",
        "linkId": 0,
        "nomenclatureId": 0,
        "parentId": 0,
        "price": 0,
        "quantity": 0
      }
    ],
    "container": true,
    "contractorActivityType": "AGENT",
    "contractorId": 0,
    "countryCode": "string",
    "created": 0,
    "custom": false,
    "customsDeclaration": "string",
    "description": "string",
    "externalCode": "string",
    "externalId": "string",
    "focused": false,
    "grouped": false,
    "gtin": "null",
    "markType": "UNKNOWN",
    "name": "Наименование номенклатуры",
    "nomenclatureFeatures": [
      {
        "created": 0,
        "featureId": 0,
        "id": 0,
        "nomenclatureId": 0,
        "value": "string"
      }
    ],
    "orgMemberPoints": 0,
    "organizationId": "ID организации",
    "parentId": 0,
    "paymentSubject": "PRODUCT",
    "picture": 0,
    "picturesIds": [
      0
    ],
    "pluCode": "string",
    "purchasePrice": "Цена закупки",
    "sellingPrice": "Цена продажи",
    "template": {
      "fields": [
        {
          "available": [
            "string"
          ],
          "defaultValue": "string",
          "factor": 0,
          "forPrint": true,
          "inputName": "string",
          "mask": "string",
          "minimumValue": "string",
          "name": "string",
          "outType": "PRICE",
          "prefix": "string",
          "regexp": "string",
          "replace": true,
          "required": true,
          "type": "STRING",
          "value": "string"
        }
      ]
    },
    "tradeObjectRelations": [
      {
        "nomenclatureId": 0,
        "orgMemberPoints": 0,
        "organizationId": "ID организации",
        "sellingPrice": 0,
        "tradeObjectId": "ID торгового объекта"
      }
    ],
    "type": "DEFAULT",
    "unitCode": 796,
    "vatId": 5,
    "vatValue": 20,
    "vendorCode": null,
    "visible": true,
    "volume": null,
    "weighted": false
  },
  "organizationId": "ID организации"
 }