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

Материал из Касса
Перейти к навигации Перейти к поиску
 
(не показаны 53 промежуточные версии 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: null
* '''weighted''':   Весовой товар (true/false)
* CompositeGood:
* '''grouped''': Группа (true/false)
** compositeType: Тип товара (Товар, Рецепт, Комплект, Шаблон)  
* '''focused''': Фокусный товар (true/false)
** extCode: Артикул
* '''container''': товар типа Комплект (true/false)
** linkId: ()
* '''paymentSubject''': Признак предмета расчёта (Товар, Платеж, Залог, Выигрыш лотереи и др.)
** nomenclatureId: ID номенклатуры
* '''adultsOnly''': Возрастное ограничение товара
** parentId: Родительский идентификатор
* '''code''': Код
** price: Цена
* '''markType''': Тип маркировки номенклатуры (Алкоголь, Табак, Обувь, Парфюмерия, СИЗ, Другая)
** quantity: Количество
* '''gtin''': Код GTIN
* container: (Вопрос что это такое)
* '''pluCode''': PLU код
* contractorActivityType: Признак агента (Агент, Комиссионер, Платежный агент, Платежный субагент и др.)
* '''template''': Шаблон
* contractorId: ID агента
* '''visible''': Видимость (true/false)
* countryCode: Код страны
* '''contractorActivityType''': Признак агента (Агент, Комиссионер, Платежный агент, Платежный субагент и др.)
* created: Время создание номенклатуры  
* '''contractorId''': ID агента
* custom: false ()
* '''custom''': Наличие характеристики у номенклатуры (true/false)
* customsDeclaration: (Не понятно что это такое)
* '''type''': Тип номенклатурной позиции( Товар, Рецепт, Комплект, Шаблон)
* description: Описание номенклатуры
* '''compositeGoods''': Тип товара (Товар, Рецепт, Комплект, Шаблон)
* externalCode: Артикул
* '''barcodes''': Штрих код позиции (EAN-8, EAN-13)
* externalId: Внешний ID
* '''countryCode''': Код страны
* focused: Фокусный товар
* '''customsDeclaration''': Таможенная декларация
* grouped: Принадлежность к группе
* '''description''': Описание
* gtin: GTIN код
* '''picturesIds''': ID изображения
* id: (Какой то ID)
* '''application''': Название приложения (KASSA)
* markType: Тип маркировки номенклатуры (Алкоголь, Табак, Обувь, Парфюмерия, СИЗ, Другая)
'''nomenclatureFeatures''': Характеристика товара
* name: Наименование номенклатуры
* '''id''': ID характеристики
* NomenclatureFeature (Характеристика номенклатуры)
* '''nomenclatureId''': ID номенклатуры
** created: время создания номенклатуры
* '''featureId''': Идентификатор номенклатуры
** featureId: ID особенности
* '''value''': Цена
** id: Характеристики
* '''organizationId''' : ID организации
** nomenclatureId: ID номенклатуры
'''tradeObjectRelations''': Данные номенклатуры в торговом объекте
** value: Цена
* '''nomenclatureId''': ID номенклатуры
* orgMemberPoints: Количество баллов KPI
* '''organizationId''': ID организации
* organizationId: ID организации
* '''sellingPrice''': Цена продажи
* parentId: ID родительской организации
* '''tradeObjectId''': ID торгового объекта
* paymentSubject: Предмет расчета (Товар, Платеж, Залог, Выигрыш лотереи и др.)
* '''orgMemberPoints''': Баллы KPI
* picture: Изображение номенклатуры
* '''blockedNomenclatureList''': Номенклатура, входящая в стоп-лист
* 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=&nbsp;
|content-right=&nbsp;
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">
adultsOnly: Возрастное ограничение товара
application: Заявка на какое приложение ссылаться Касса Розница или ЛК
barcode: Штрихкод
barcodes: Штрихкоды
blockedNomenclatureList:  (Номенклатура, входящая в Стоп-лист)
  {
  {
  created: Время создания номенклатуры
    "item": {
  nomenclatureId: ID номенклатурной позиции
        "organizationId": "ID организации",
  organizationId: ID организации
        "barcode": null,
  tradeObjectId: ID торгового объекта
        "vendorCode": null,
}
        "name": "Наименование номенклатуры",
  changed: время изменения номенклатуры
        "vatId": 5,
  code: null
        "vatValue": 20,
  [CompositeGood:
        "unitCode": 796,
{
        "volume": null,
  compositeType: Тип товара (Товар, Рецепт, Комплект, Шаблон)
        "purchasePrice": null,
  extCode: Артикул
        "sellingPrice": 60,
  linkId: ()
        "weighted": false,
  nomenclatureId: ID номенклатуры
        "grouped": false,
  parentId: Родительский идентификатор
        "focused": false,
  price: Цена
        "container": true,
  quantity: Количество
        "paymentSubject": "PRODUCT",
}]
        "adultsOnly": false,
  container: (Вопрос что это такое)
        "code": null,
  contractorActivityType: Признак агента (Агент, Комиссионер, Платежный агент, Платежный субагент и др.)
        "markType": "UNKNOWN",
  contractorId: ID агента
        "gtin": null,
  countryCode: Код страны
        "pluCode": null,
  created: Время создание номенклатуры
        "template": null,
  custom: false ()
        "visible": true,
  customsDeclaration: (Не понятно что это такое)
        "contractorActivityType": null,
  description: Описание номенклатуры
        "contractorId": null,
  externalCode: Артикул
        "custom": false,
  externalId: Внешний ID
        "type": "DEFAULT",
  focused: Фокусный товар
        "compositeGoods": [],
  grouped: Принадлежность к группе
        "barcodes": [],
  gtin: GTIN код
        "countryCode": null,
  id: (Какой то ID)
        "customsDeclaration": null,
  markType: Тип маркировки номенклатуры (Алкоголь, Табак, Обувь, Парфюмерия, СИЗ, Другая)
        "description": null,
  name: Наименование номенклатуры
        "picturesIds": [],
  NomenclatureFeature (Характеристика номенклатуры)
        "application": "KASSA"
[{
    },
  created: время создания номенклатуры
    "nomenclatureFeatures": [
  featureId: ID особенности
        {
  id: Характеристики
            "id": null,
  nomenclatureId: ID номенклатуры
            "nomenclatureId": "ID номенклатуры",
  value: Цена
            "featureId": "Идентификатор номенклатуры",
}]
            "value": null
  orgMemberPoints: Количество баллов KPI
        }
  organizationId: ID организации
    ],
  parentId: ID родительской организации
    "organizationId": "ID организации",
  paymentSubject: Предмет расчета (Товар, Платеж, Залог, Выигрыш лотереи и др.)
    "tradeObjectRelations": [
  picture: Изображение номенклатуры
        {
  picturesIds: ID изображения
            "nomenclatureId": "ID номенклатуры",
  pluCode: PLU код
            "organizationId": "ID организации",
  purchasePrice: Цена закупки
            "sellingPrice": 60,
  sellingPrice: Цена продажи
            "tradeObjectId": "ID торгового объекта"
  tradeObjectRelations: (Принадлежность к определенному торговому объекту)
        }
  [TradeObjectNomenclature (Номенклатура торгового объекта)
    ],
{
    "orgMemberPoints": null,
  nomenclatureId: ID номенклатуры
    "blockedNomenclatureList": null
  orgMemberPoints: Количество баллов KPI
}
  organizationId: ID организации
</syntaxhighlight>
  sellingPrice: Цена продажи
|}}<br>
  tradeObjectId: ID торгового объекта
 
}]
 
  type: Тип номенклатурной позиции( Товар, Рецепт, Комплект, Шаблон)
 
  unitCode: Единица измерения
{{ProductTable-2
  vatId: НДС ID
|title-left= '''Response'''
  vatValue: НДС
|title-right=
  vendorCode: Код Поставщика
|content-left= <br> ID созданной номенклатуры
  visible: ()
|content-right=
  volume: ()
<syntaxhighlight>
  weighted: ()
23923080
}
  organizationId: ID организации
}
</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= после знака равно.