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

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

Версия 14:56, 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: ()
  • 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 организации
 
 adultsOnly: false,
 application: "KASSA",
 barcode: null,
 barcodes: [],
 blockedNomenclatureList:  (Номенклатура, входящая в Стоп-лист)
 {
  created:	Время создания номенклатуры
  nomenclatureId: "ID номенклатурной позиции"
  organizationId: "ID организации"
  tradeObjectId:	ID торгового объекта
 }
  changed:	"1649688350781"
  code:	null
  [CompositeGood:
 {
  compositeType: "ANALOG",
  extCode:	 Артикул
  linkId: 21796190,
  nomenclatureId: "ID номенклатуры",
  parentId:	22528459,
  price: null,
  quantity:	1,
 }]
  container: true
  contractorActivityType: null,
  contractorId:	null,
  countryCode: null,
  created:	"1646123874461"
  custom: false,
  customsDeclaration: null,
  description: null,
  externalCode:	"null"
  externalId:	"null"
  focused: false
  grouped: false
  gtin:	null,
  id:	22528459,
  markType: "UNKNOWN"
  name: "Наименование номенклатуры"
  NomenclatureFeature (Характеристика номенклатуры)
 [{
   created:	время создания номенклатуры
   featureId: "ID Характеристики",
   id: "ID Характеристики",
   nomenclatureId: 22528459,
   value: null,
 }]
  orgMemberPoints:	Количество баллов KPI
  organizationId: ID организации
  parentId:	null,
  paymentSubject: "PRODUCT"
  picture: null,
  picturesIds: [], 
  pluCode: null,
  purchasePrice: 8200,
  sellingPrice:	500,
  tradeObjectRelations:	null,
   [TradeObjectNomenclature (Номенклатура торгового объекта)
 {
   nomenclatureId:	ID номенклатуры
   orgMemberPoints:	Количество баллов KPI
   organizationId:	ID организации
   sellingPrice:	Цена продажи
   tradeObjectId:	ID торгового объекта
 }]
  type:	"RECIPE",
  unitCode:	"Единица измерения"
  vatId: "ID НДС"
  vatValue:	"20"
  vendorCode: null
  visible:	()
  volume: "null"
  weighted: false
 }
  organizationId:	ID организации
 }