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

Материал из Касса
Перейти к навигации Перейти к поиску
 
(не показано 48 промежуточных версий 2 участников)
Строка 8: Строка 8:
|title-left='''Запрос'''
|title-left='''Запрос'''
|title-right='''POST'''
|title-right='''POST'''
|content-left= URL: https://kassa.bifit.com/cashdesk-api/v1/protected/nomenclatures
|content-left= <br>URL: https://kassa.bifit.com/cashdesk-api/v1/protected/nomenclatures
|content-right=
|content-right=
<syntaxhighlight>
<syntaxhighlight>
https://kassa.bifit.com/cashdesk-api/v1/protected/nomenclatures
https://kassa.bifit.com/cashdesk-api/v1/protected/nomenclatures
</syntaxhighlight>
|}}<br>
{{Note|'''''Важно!'''''<br>
В '''HEADERS''' укажите значение '''access_token''' согласно:'''authorization''': Bearer <значение '''acces_token'''> .|800}}
<br>
{{ProductTable-2
  |title-left= Request HEADERS
  |title-right='''HEADERS'''
|content-left=&nbsp;
* передача access_token
* отключение компрессии
|content-right=
<syntaxhighlight lang="JSON">
Authorization: "Bearer <значение acces_token>"
Accept-Encoding: "deflate"
</syntaxhighlight>
</syntaxhighlight>
|}}<br>
|}}<br>
Строка 20: Строка 37:
|title-right= type: '''raw''' (JSON)
|title-right= type: '''raw''' (JSON)
|content-left=&nbsp;
|content-left=&nbsp;
* '''adultsOnly''': Возрастное ограничение товара
* '''organizationId''': ID организации
* '''application''': Заявка на какое приложение ссылаться Касса Розница или ЛК
* '''barcode''': Штрих код позиции (EAN-8, EAN-13)
* '''barcode''': Штрихкод
* '''vendorCode''': Артикул производителя
* '''barcodes''': Штрихкоды
* '''name''': Наименование номенклатуры
* '''blockedNomenclatureList''':  (Номенклатура, входящая в Стоп-лист)
* '''vatId''': НДС ID
** '''created''': Время создания номенклатуры
* '''vatValue''': НДС
** '''nomenclatureId''': ID номенклатурной позиции
* '''unitCode''': Код единицы измерения по '''ОКЕИ'''
** '''organizationId''': ID организации
* '''volume''': Значение объема
** '''tradeObjectId''': ID торгового объекта
* '''purchasePrice''': Цена закупки
* '''changed''': время изменения номенклатуры
* '''sellingPrice''': Цена продажи
* '''code''': ()
* '''weighted''':   Весовой товар (true/false)
* '''CompositeGood''':
* '''grouped''': Группа (true/false)
** '''compositeType''': Тип товара (Товар, Рецепт, Комплект, Шаблон)
* '''focused''': Фокусный товар (true/false)
** '''extCode''': Артикул
* '''container''': товар типа Комплект (true/false)
** '''linkId''': ()
* '''paymentSubject''': Признак предмета расчёта (Товар, Платеж, Залог, Выигрыш лотереи и др.)
** '''nomenclatureId''': ID номенклатуры
* '''adultsOnly''': Возрастное ограничение товара
** '''parentId''': ID создаваемого товара
* '''code''': Код
** '''price''': Цена
** '''quantity''': Количество
* '''container''': (Вопрос что это такое)
* '''contractorActivityType''': Признак агента (Агент, Комиссионер, Платежный агент, Платежный субагент и др.)
* '''contractorId''': ID агента
* '''countryCode''': Код страны
* '''created''': Время создание номенклатуры
* '''custom''': false ()
* '''customsDeclaration''': (Не понятно что это такое)
* '''description''': Описание номенклатуры
* '''externalCode''': Артикул
* '''externalId''': Внешний ID
* '''focused''': Фокусный товар
* '''grouped''': Принадлежность к группе
* '''gtin''': GTIN код
* '''id''': (Какой то ID)
* '''markType''': Тип маркировки номенклатуры (Алкоголь, Табак, Обувь, Парфюмерия, СИЗ, Другая)
* '''markType''': Тип маркировки номенклатуры (Алкоголь, Табак, Обувь, Парфюмерия, СИЗ, Другая)
* '''name''': Наименование номенклатуры
* '''gtin''': Код GTIN
* '''NomenclatureFeature''' (Характеристика номенклатуры)
* '''pluCode''': PLU код
** '''created''': время создания номенклатуры
* '''template''': Шаблон
** '''featureId''': ID особенности
* '''visible''': Видимость (true/false)
** '''id''': Характеристики
* '''contractorActivityType''': Признак агента (Агент, Комиссионер, Платежный агент, Платежный субагент и др.)
** '''nomenclatureId''': ID номенклатуры
* '''contractorId''': ID агента
** '''value''': Цена
* '''custom''': Наличие характеристики у номенклатуры (true/false)
* '''orgMemberPoints''': Количество баллов KPI
* '''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 организации
* '''organizationId''': ID организации
* '''parentId''': ID создаваемого товара
* '''sellingPrice''': Цена продажи
* '''paymentSubject''': Предмет расчета (Товар, Платеж, Залог, Выигрыш лотереи и др.)
* '''tradeObjectId''': ID торгового объекта
* '''picture''': Изображение номенклатуры
* '''orgMemberPoints''': Баллы KPI
* '''picturesIds''': ID изображения
* '''blockedNomenclatureList''': Номенклатура, входящая в стоп-лист
* '''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 организации
|content-right=&nbsp;
|content-right=&nbsp;
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">
  {
  {
  "item": {
    "item": {
    "adultsOnly": false,
    "application": "KASSA",
    "barcode": "string",
    "barcodes": [null],
    "blockedNomenclatureList": [
      {
        "created": 0,
        "nomenclatureId": 0,
         "organizationId": "ID организации",
         "organizationId": "ID организации",
         "tradeObjectId": "string"
         "barcode": null,
      }
        "vendorCode": null,
    ],
        "name": "Наименование номенклатуры",
    "changed": 0,
        "vatId": 5,
    "code": "null",
         "vatValue": 20,
    "compositeGoods": [
        "unitCode": 796,
      {
         "volume": null,
         "compositeType": "INGREDIENT",
         "purchasePrice": null,
         "extCode": "string",
         "sellingPrice": 60,
         "linkId": 0,
         "weighted": false,
         "nomenclatureId": 0,
         "grouped": false,
         "parentId": 0,
         "focused": false,
         "price": 0,
        "container": true,
         "quantity": 0
        "paymentSubject": "PRODUCT",
      }
        "adultsOnly": false,
    ],
        "code": null,
    "container": true,
        "markType": "UNKNOWN",
    "contractorActivityType": "AGENT",
        "gtin": null,
    "contractorId": 0,
        "pluCode": null,
    "countryCode": "string",
        "template": null,
    "created": 0,
        "visible": true,
    "custom": false,
        "contractorActivityType": null,
    "customsDeclaration": "string",
        "contractorId": null,
    "description": "string",
        "custom": false,
    "externalCode": "string",
        "type": "DEFAULT",
    "externalId": "string",
        "compositeGoods": [],
    "focused": false,
        "barcodes": [],
    "grouped": false,
        "countryCode": null,
    "gtin": "null",
        "customsDeclaration": null,
    "markType": "UNKNOWN",
        "description": null,
    "name": "Наименование номенклатуры",
        "picturesIds": [],
        "application": "KASSA"
    },
     "nomenclatureFeatures": [
     "nomenclatureFeatures": [
      {
        {
        "created": 0,
            "id": null,
        "featureId": 0,
            "nomenclatureId": "ID номенклатуры",
        "id": 0,
            "featureId": "Идентификатор номенклатуры",
        "nomenclatureId": 0,
            "value": null
        "value": "string"
        }
      }
     ],
     ],
    "orgMemberPoints": 0,
     "organizationId": "ID организации",
     "organizationId": "ID организации",
     "parentId": 0,
     "tradeObjectRelations": [
    "paymentSubject": "PRODUCT",
    "picture": 0,
    "picturesIds": [
      0
    ],
    "pluCode": "string",
    "purchasePrice": "Цена закупки",
    "sellingPrice": "Цена продажи",
    "template": {
      "fields": [
         {
         {
          "available": [
             "nomenclatureId": "ID номенклатуры",
             "string"
            "organizationId": "ID организации",
          ],
            "sellingPrice": 60,
          "defaultValue": "string",
            "tradeObjectId": "ID торгового объекта"
          "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",
     "orgMemberPoints": null,
     "unitCode": 796,
     "blockedNomenclatureList": null
    "vatId": 5,
}
    "vatValue": 20,
</syntaxhighlight>
    "vendorCode": null,
|}}<br>
    "visible": true,
 
    "volume": null,
 
    "weighted": false
 
  },
{{ProductTable-2
  "organizationId": "ID организации"
|title-left= '''Response'''
}
|title-right=
|content-left= <br> ID созданной номенклатуры
|content-right=
<syntaxhighlight>
23923080
</syntaxhighlight>
</syntaxhighlight>
|}}<br>
|}}<br>
{{Note|'''''Примечание'''''<br>
После получения ID созданного онлайн заказа, укажите его в поисковом запросе https://kassa.bifit.com/cashdesk/#/app_cashdesk/goods/nomenclature/edit?id{{Знак равенства}}  после знака равно. |800}}

Текущая версия на 12:06, 2 июня 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


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= после знака равно.

Источник — http://kassa.bifit.com/wiki/index.php?title=API:Создание_номенклатуры_в_справочнике_товаров&oldid=20273