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

Материал из Касса
Перейти к навигации Перейти к поиску
Строка 18: Строка 18:
{{ProductTable-2
{{ProductTable-2
|title-left= Request Body
|title-left= Request Body
|title-right= type: '''raw'''
|title-right= type: '''raw''' (JSON)
|content-left= 
|content-left= 
* adultsOnly: Возрастное ограничение товара
* adultsOnly: Возрастное ограничение товара
Строка 98: Строка 98:
|content-right= 
|content-right= 
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">
* adultsOnly: Возрастное ограничение товара
adultsOnly: Возрастное ограничение товара
* application: Заявка на какое приложение ссылаться Касса Розница или ЛК
application: Заявка на какое приложение ссылаться Касса Розница или ЛК
* barcode: Штрихкод
barcode: Штрихкод
* barcodes: Штрихкоды  
barcodes: Штрихкоды  
* blockedNomenclatureList:  (Номенклатура, входящая в Стоп-лист)
blockedNomenclatureList:  (Номенклатура, входящая в Стоп-лист)
{
{
** created: Время создания номенклатуры
  created: Время создания номенклатуры
** nomenclatureId: ID номенклатурной позиции
  nomenclatureId: ID номенклатурной позиции
** organizationId: ID организации
  organizationId: ID организации
** tradeObjectId: ID торгового объекта
  tradeObjectId: ID торгового объекта
}
}
* changed: время изменения номенклатуры
  changed: время изменения номенклатуры
* code: null
  code: null
* [CompositeGood:
  [CompositeGood:
{
{
** compositeType: Тип товара (Товар, Рецепт, Комплект, Шаблон)  
  compositeType: Тип товара (Товар, Рецепт, Комплект, Шаблон)  
** extCode: Артикул
  extCode: Артикул
** linkId: ()
  linkId: ()
** nomenclatureId: ID номенклатуры
  nomenclatureId: ID номенклатуры
** parentId: Родительский идентификатор
  parentId: Родительский идентификатор
** price: Цена  
  price: Цена  
** quantity: Количество
  quantity: Количество
}]
}]
* container: (Вопрос что это такое)
  container: (Вопрос что это такое)
* contractorActivityType: Признак агента (Агент, Комиссионер, Платежный агент, Платежный субагент и др.)
  contractorActivityType: Признак агента (Агент, Комиссионер, Платежный агент, Платежный субагент и др.)
* contractorId: ID агента
  contractorId: ID агента
* countryCode: Код страны
  countryCode: Код страны
* created: Время создание номенклатуры  
  created: Время создание номенклатуры  
* custom: false ()
  custom: false ()
* customsDeclaration: (Не понятно что это такое)
  customsDeclaration: (Не понятно что это такое)
* description: Описание номенклатуры
  description: Описание номенклатуры
* externalCode: Артикул
  externalCode: Артикул
* externalId: Внешний ID
  externalId: Внешний ID
* focused: Фокусный товар
  focused: Фокусный товар
* grouped: Принадлежность к группе
  grouped: Принадлежность к группе
* gtin: GTIN код
  gtin: GTIN код
* id: (Какой то ID)
  id: (Какой то ID)
* markType: Тип маркировки номенклатуры (Алкоголь, Табак, Обувь, Парфюмерия, СИЗ, Другая)
  markType: Тип маркировки номенклатуры (Алкоголь, Табак, Обувь, Парфюмерия, СИЗ, Другая)
* name: Наименование номенклатуры
  name: Наименование номенклатуры
* NomenclatureFeature (Характеристика номенклатуры)
  NomenclatureFeature (Характеристика номенклатуры)
[{
[{
** created: время создания номенклатуры
  created: время создания номенклатуры
** featureId: ID особенности
  featureId: ID особенности
** id: Характеристики
  id: Характеристики
** nomenclatureId: ID номенклатуры
  nomenclatureId: ID номенклатуры
** value: Цена
  value: Цена
}]
}]
* orgMemberPoints: Количество баллов KPI
  orgMemberPoints: Количество баллов KPI
* organizationId: ID организации
  organizationId: ID организации
* parentId: ID родительской организации
  parentId: ID родительской организации
* paymentSubject: Предмет расчета (Товар, Платеж, Залог, Выигрыш лотереи и др.)
  paymentSubject: Предмет расчета (Товар, Платеж, Залог, Выигрыш лотереи и др.)
* picture: Изображение номенклатуры
  picture: Изображение номенклатуры
* picturesIds: ID изображения  
  picturesIds: ID изображения  
* pluCode: PLU код
  pluCode: PLU код
* purchasePrice: Цена закупки
  purchasePrice: Цена закупки
* sellingPrice: Цена продажи
  sellingPrice: Цена продажи
* tradeObjectRelations: (Принадлежность к определенному торговому объекту)
  tradeObjectRelations: (Принадлежность к определенному торговому объекту)
** [TradeObjectNomenclature (Номенклатура торгового объекта)
  [TradeObjectNomenclature (Номенклатура торгового объекта)
{
{
** nomenclatureId: ID номенклатуры
  nomenclatureId: ID номенклатуры
** orgMemberPoints: Количество баллов KPI
  orgMemberPoints: Количество баллов KPI
** organizationId: ID организации
  organizationId: ID организации
** sellingPrice: Цена продажи
  sellingPrice: Цена продажи
** tradeObjectId: ID торгового объекта
  tradeObjectId: ID торгового объекта
}]
}]
* type: Тип номенклатурной позиции( Товар, Рецепт, Комплект, Шаблон)
  type: Тип номенклатурной позиции( Товар, Рецепт, Комплект, Шаблон)
* unitCode: Единица измерения
  unitCode: Единица измерения
* vatId: НДС ID
  vatId: НДС ID
* vatValue: НДС
  vatValue: НДС
* vendorCode: Код Поставщика
  vendorCode: Код Поставщика
* visible: ()
  visible: ()
* volume: ()
  volume: ()
* weighted: ()
  weighted: ()
}
}
* organizationId: ID организации
  organizationId: ID организации
}
}
|}}<br>
|}}<br>

Версия 13:49, 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)
 
  • adultsOnly: Возрастное ограничение товара
  • application: Заявка на какое приложение ссылаться Касса Розница или ЛК
  • barcode: Штрихкод
  • barcodes: Штрихкоды
  • blockedNomenclatureList: (Номенклатура, входящая в Стоп-лист)

{

    • created: Время создания номенклатуры
    • nomenclatureId: ID номенклатурной позиции
    • organizationId: ID организации
    • tradeObjectId: ID торгового объекта

}

  • changed: время изменения номенклатуры
  • code: null
  • [CompositeGood:

{

    • compositeType: Тип товара (Товар, Рецепт, Комплект, Шаблон)
    • extCode: Артикул
    • linkId: ()
    • nomenclatureId: ID номенклатуры
    • parentId: Родительский идентификатор
    • 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 организации
}
 

<syntaxhighlight lang="JSON">

adultsOnly:	Возрастное ограничение товара
application:	Заявка на какое приложение ссылаться Касса Розница или ЛК
barcode:	Штрихкод
barcodes: Штрихкоды 
blockedNomenclatureList:  (Номенклатура, входящая в Стоп-лист)
{
 created:	Время создания номенклатуры
 nomenclatureId:	ID номенклатурной позиции
 organizationId:	ID организации
 tradeObjectId:	ID торгового объекта
}
 changed:	время изменения номенклатуры
 code:	null
 [CompositeGood:
{
 compositeType:	Тип товара (Товар, Рецепт, Комплект, Шаблон) 
 extCode:	 Артикул
 linkId:	()
 nomenclatureId:	ID номенклатуры
 parentId:	Родительский идентификатор
 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 организации
}