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

Материал из Касса
Перейти к навигации Перейти к поиску
Строка 20: Строка 20:
|title-right= type: '''raw'''
|title-right= type: '''raw'''
|content-left= 
|content-left= 
* '''username''': логин учетной записи, передается в формате '''7xxxxxxxxxx'''
* adultsOnly: Возрастное ограничение товара
* '''password''': пароль, передается в виде зашифрованного хэш -> '''SHA-256 -> base64 urlencoded'''
* application: Заявка на какое приложение ссылаться Касса Розница или ЛК
* '''client_id''': передать значение ''"cashdesk-rest-client"''
* barcode: Штрихкод
* '''client_secret''': передать значение ''"cashdesk-rest-client"''
* barcodes: Штрихкоды
* '''grant_type''': передать значение ''"password"''
* 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 организации
}
|content-right= 
|content-right= 
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">
username: "7xxxxxxxxxx"
* adultsOnly: Возрастное ограничение товара
password: "asdaldfkhj34o.......kljslkfas"
* application: Заявка на какое приложение ссылаться Касса Розница или ЛК
client_id: "cashdesk-rest-client"
* barcode: Штрихкод
client_secret: "cashdesk-rest-client"
* barcodes: Штрихкоды
grant_type: "password"
* blockedNomenclatureList:  (Номенклатура, входящая в Стоп-лист)
</syntaxhighlight>
{
** 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 организации
}
|}}<br>
|}}<br>

Версия 13:46, 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
 
  • 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 организации
}