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

Текущая версия на 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

Важно!
В 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

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

@@ Строка 8: / Строка 8: @@
 |title-left='''Запрос'''
 |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=
 <syntaxhighlight>
 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>
 |}}<br>
@@ Строка 20: / Строка 37: @@
 |title-right= type: '''raw''' (JSON)
 |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''': Тип маркировки номенклатуры (Алкоголь, Табак, Обувь, Парфюмерия, СИЗ, Другая)
-* '''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 организации
-* '''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;
 <syntaxhighlight lang="JSON">
- adultsOnly: false,
- application: "KASSA",
- barcode: null,
- barcodes: [],
- blockedNomenclatureList:  (Номенклатура, входящая в Стоп-лист)
   {
-  created:	Время создания номенклатуры
+    "item": {
-  nomenclatureId: "ID номенклатурной позиции"
+        "organizationId": "ID организации",
-  organizationId: "ID организации"
+        "barcode": null,
-  tradeObjectId:	ID торгового объекта
+        "vendorCode": null,
- }
+        "name": "Наименование номенклатуры",
-  changed:	"1649688350781"
+        "vatId": 5,
-  code:	null
+        "vatValue": 20,
-  [CompositeGood:
+        "unitCode": 796,
- {
+        "volume": null,
-  compositeType: "ANALOG",
+        "purchasePrice": null,
-  extCode:	 Артикул
+        "sellingPrice": 60,
-  linkId: 21796190,
+        "weighted": false,
-  nomenclatureId: "ID номенклатуры",
+        "grouped": false,
-  parentId:	22528459,
+        "focused": false,
-  price: null,
+        "container": true,
-  quantity:	1,
+        "paymentSubject": "PRODUCT",
- }]
+        "adultsOnly": false,
-  container: true
+        "code": null,
-  contractorActivityType: null,
+        "markType": "UNKNOWN",
-  contractorId:	null,
+        "gtin": null,
-  countryCode: null,
+        "pluCode": null,
-  created:	"1646123874461"
+        "template": null,
-  custom: false,
+        "visible": true,
-  customsDeclaration: null,
+        "contractorActivityType": null,
-  description: null,
+        "contractorId": null,
-  externalCode:	"null"
+        "custom": false,
-  externalId:	"null"
+        "type": "DEFAULT",
-  focused: false
+        "compositeGoods": [],
-  grouped: false
+        "barcodes": [],
-  gtin:	null,
+        "countryCode": null,
-  id:	22528459,
+        "customsDeclaration": null,
-  markType: "UNKNOWN"
+        "description": null,
-  name: "Наименование номенклатуры"
+        "picturesIds": [],
-  NomenclatureFeature (Характеристика номенклатуры)
+        "application": "KASSA"
- [{
+    },
-   created:	время создания номенклатуры
+    "nomenclatureFeatures": [
-   featureId: "ID Характеристики",
+        {
-   id: "ID Характеристики",
+            "id": null,
-   nomenclatureId: 22528459,
+            "nomenclatureId": "ID номенклатуры",
-   value: null,
+            "featureId": "Идентификатор номенклатуры",
- }]
+            "value": null
-  orgMemberPoints:	Количество баллов KPI
+        }
-  organizationId: ID организации
+    ],
-  parentId:	null,
+    "organizationId": "ID организации",
-  paymentSubject: "PRODUCT"
+    "tradeObjectRelations": [
-  picture: null,
+        {
-  picturesIds: [],
+            "nomenclatureId": "ID номенклатуры",
-  pluCode: null,
+            "organizationId": "ID организации",
-  purchasePrice: 8200,
+            "sellingPrice": 60,
-  sellingPrice:	500,
+            "tradeObjectId": "ID торгового объекта"
-  tradeObjectRelations:	null,
+        }
-   [TradeObjectNomenclature (Номенклатура торгового объекта)
+    ],
- {
+    "orgMemberPoints": null,
-   nomenclatureId:	ID номенклатуры
+    "blockedNomenclatureList": null
-   orgMemberPoints:	Количество баллов KPI
+}
-   organizationId:	ID организации
+</syntaxhighlight>
-   sellingPrice:	Цена продажи
+|}}<br>
-   tradeObjectId:	ID торгового объекта
- }]
-  type:	"RECIPE",
-  unitCode:	"Единица измерения"
+{{ProductTable-2
-  vatId: "ID НДС"
+|title-left= '''Response'''
-  vatValue:	"20"
+|title-right=
-  vendorCode: null
+|content-left= <br> ID созданной номенклатуры
-  visible:	()
+|content-right=
-  volume: "null"
+<syntaxhighlight>
-  weighted: false
+23923080
- }
-  organizationId:	ID организации
- }
 </syntaxhighlight>
 |}}<br>
+{{Note|'''''Примечание'''''<br>
+После получения ID созданного онлайн заказа, укажите его в поисковом запросе https://kassa.bifit.com/cashdesk/#/app_cashdesk/goods/nomenclature/edit?id{{Знак равенства}}  после знака равно. |800}}

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

Текущая версия на 12:06, 2 июня 2022

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

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

Навигация

Поиск