API:Создание номенклатуры в справочнике товаров: различия между версиями
Merkulov (обсуждение | вклад) |
Mediawiki (обсуждение | вклад) |
||
(не показаны 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= | |||
* передача 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= | |content-left= | ||
* | * '''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 код | ||
* contractorActivityType: Признак агента (Агент, Комиссионер, Платежный агент, Платежный субагент и др.) | * '''template''': Шаблон | ||
* contractorId: ID агента | * '''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''': Номенклатура, входящая в стоп-лист | |||
* | |||
* | |||
* | |||
* | |||
* | |||
* | |||
* | |||
* | |||
|content-right= | |content-right= | ||
<syntaxhighlight lang="JSON"> | <syntaxhighlight lang="JSON"> | ||
{ | { | ||
"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 | |||
} | |||
</syntaxhighlight> | |||
|}}<br> | |||
{{ProductTable-2 | |||
|title-left= '''Response''' | |||
|title-right= | |||
|content-left= <br> ID созданной номенклатуры | |||
|content-right= | |||
<syntaxhighlight> | |||
23923080 | |||
</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 |
Важно!
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение acces_token> .
Request HEADERS | HEADERS |
|
Authorization: "Bearer <значение acces_token>"
Accept-Encoding: "deflate"
|
Request Body | type: raw (JSON) |
nomenclatureFeatures: Характеристика товара
tradeObjectRelations: Данные номенклатуры в торговом объекте
|
{
"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= после знака равно.