Get TarifItems: відмінності між версіями

Матеріал з expertsolution
Перейти до навігації Перейти до пошуку
(Створена сторінка: =='''Отримання позицій номенклатури за значенням ID групи, що отримали з метода Get_TarifItems. Також є можливість отримувати позиції за значенням ID (або зовнішньго коду) прайс-листа, чи за датою та часом зміни інформації в номенклатурі (ще не готово)'''== Розділ...)
 
Немає опису редагування
 
Рядок 1: Рядок 1:
=='''Отримання позицій номенклатури за значенням ID групи, що отримали з метода Get_TarifItems. Також є можливість отримувати позиції за значенням ID (або зовнішньго коду) прайс-листа, чи за датою та часом зміни інформації в номенклатурі (ще не готово)'''==
=='''Отримання груп меню'''==


  Розділ містить методи, необхідні для отримання позицій номенклатури
  Розділ містить методи, необхідні для отримання груп меню з вказанням вкладеності
<br>
<br>


Рядок 7: Рядок 7:
|-
|-
! style="background:#cdf; padding:0.5em; text-align:left; width:15%" id="fileinfotpl_desc" | Опис
! style="background:#cdf; padding:0.5em; text-align:left; width:15%" id="fileinfotpl_desc" | Опис
| style="background:#fff; padding:0.5em;" | Отримання позицій номенклатури.
| style="background:#fff; padding:0.5em;" | Отримання груп меню.
|-
|-
! style="background:#cdf; padding:0.5em; text-align:left;" id="fileinfotpl_src" | Метод
! style="background:#cdf; padding:0.5em; text-align:left;" id="fileinfotpl_src" | Метод
Рядок 13: Рядок 13:
|-
|-
! style="background:#cdf; padding:0.5em; text-align:left;" id="fileinfotpl_date" | URL
! style="background:#cdf; padding:0.5em; text-align:left;" id="fileinfotpl_date" | URL
| style="background:#fff; padding:0.5em;" | /POSExternal/Get_TarifItem
| style="background:#fff; padding:0.5em;" | /POSExternal/Get_TarifItems
|}
|}
<br>
<br>
Рядок 38: Рядок 38:
<syntaxhighlight lang="json">
<syntaxhighlight lang="json">
{
{
"GroupMenuID": 3864,
"WithProperties": "true",
"PriceListID":3109,
"PriceListID": 3109,
"PriceListCode2":"",
"PriceListCode2": ""
"HierarchyLevel": 1,
"WithProperties": true,
"ReceptInfoInText": true,
"DateMenu": "2021-08-15 09:00:00"
}
}


Рядок 58: Рядок 54:
! scope="col"| Тип
! scope="col"| Тип
! scope="col"| Опис
! scope="col"| Опис
|-
|
| GroupMenuID
| Bool
| ID групи номенклатури
|-
|-
|
|
Рядок 73: Рядок 64:
| String  
| String  
| Код прайс-листа
| Код прайс-листа
|-
|
| HierarchyLevel
| Int
| Рівень повертаємої номенклатури. HierarchyLevel = <br>
1 – лише тарифні позиції; <br>
2 – групи модифікаторів та основи комплексів; <br>
3 – те саме 2, плюс модифікатори та інгредієнти комплексів.<br>
Якщо не передавати, то HierarchyLevel = -1, повертається вся номенклатура з модифікаторами та інгредієнтами комплекса
|-
|-
|
|
Рядок 87: Рядок 69:
| Bool  
| Bool  
| Отримання масиву ідентифікаторів характеристик груп
| Отримання масиву ідентифікаторів характеристик груп
|-
|
| ReceptInfoInText
| Bool
| Отримання опису калькуляції позиції в текстовому форматі (формат xml за замовчуванням)
|-
|
| DateMenu
| Datetime
| Дата та час останньої зміни позиції номенклатури, з якого повертати інформацію. При внесенні цього параметру GroupMenuID є не обов’язковим. Застосовується для отримання змін в прас-листі (наприклад зміна ціни)
|-
|
| ReturnResult
| Bool
| Повернення файлів для друку на Bluetooth принтер
|-
|
| DontClose
| Bool
| Hе закривати рахунок після оплати (за замовчуванням рахунок буде закрито) (необов'язковий параметр)
|-
!style="width:50%; background:#accae4;" scope="row" colspan="4"| * Позначення обов’язкового параметру
|-
|-
|}
|}
Рядок 127: Рядок 87:
<syntaxhighlight lang="json">
<syntaxhighlight lang="json">
{
{
  "Error": "",
"Error": "",
  "Success": true,
"Success": true,
  "Item": [
"Items": [
    {
{
      "ID": 3940,
"EN": null,
      "ParentID": 3864,
"HasTarifItem": false,
      "ExParentID": null,
"HierarchyLevel": 1,
      "Name": "Айріш",
"ID": 3110,
      "ShortName": "Айріш",
"Name": "Меню",
      "Description": null,
"Ordering": 1000,
      "Description_RU": null,
"ParentID": 0,
      "Price": 25,
"PhotoUrl": null,
      "DefaultModifier": 0,
"PriceListID": 3109,
      "IsModifierGroup": 0,
"PropertyIDs": [],
      "MaxCount": 0,
"RU": "Меню",
      "HierarchyLevel": 1,
"ShortName": "Меню"
      "Ordering": 0,
},
      "CategoryID": null,
{
      "PhotoUrl": null,
"EN": null,
      "Code": "000000260 ",
"HasTarifItem": true,
      "IsComplex": 0,
"HierarchyLevel": 2,
      "Weidth": 0,
"ID": 10337,
      "KCal": null,
"Name": "Десерти",
      "CpxMaxCount": null,
"Ordering": 0,
      "CpxIsDefault": null,
"ParentID": 3110,
      "SaleStatus": 1,
"PhotoUrl": null,
      "EnterpriseTaxCode": null,
"PriceListID": 3109,
      "RU": null,
"PropertyIDs": [],
      "EN": null,
"RU": "Десерти",
      "Measure": null,
"ShortName": "Десерти"
      "Measure_RU": null,
},
      "Measure_EN": null,
      "Rate": 0,
      "Fats": null,
      "Squirrels": null,
      "Carbohydrates": null,
      "ReceptInfo": null,
      "ReceptInfo_RU": null,
      "ReceptInfo_EN": null,
      "Allergen": null,
      "Allergen_RU": null,
      "Allergen_EN": null,
      "AccountingPrice": 0,
      "AccountingPrice2": 0,
      "AccountingPrice3": 0,
      "IsVegan": false,
      "IsHot": false,
      "EnterpriseID": 205,
      "PropertyIDs": [],
      "PriceListID": 3109,
      "WeidthStr": ""
    },
}
}
</syntaxhighlight>
</syntaxhighlight>
Рядок 204: Рядок 143:
|-
|-
|  
|  
| ID
| EN
| Int
| String
| ID позиції номенклатури
| Назва англійською
|-
|-
|  
|  
| ParentID
| HasTarifItem
| Int
| Bool
| ID групи, в яку входить позиція
| Ознака наявності тарифних позицій в групі
|-
|-
|  
|  
| ExParentID
| HierarchyLevel
| Int
| Int
| ID базової номенклатури, до якої відноситься модифікатор чи елемент комплекса
| Рівень ієрархії (1- початковий рівень)
|-
|-
|  
|  
| Name
| Name
| String
| String
| Назва позиції
| Назва групи меню
|-
|-
|  
|  
| ShortName
| ID
| String
| Int  
| Коротка назва позиції
| ID групи
|-
|
| Description
| String
| Опис номенклатури
|-
|
| Description_RU
| String
| Опис номенклатури російською
|-
|
| Description_EN
| String
| Опис номенклатури англійською
|-
|
| Price
| Decimal
| Ціна продажу
|-
|
| DefaultModifier
| Int
| Модифікатор за замовчуванням (1 - так, 0 - ні)
|-
|
| IsModifierGroup
| Int
| Ознака, що - номенклатура є групою модифікатора для номенклатури з множинним вибором (1) - номенклатура є групою модифікатора для номенклатури без множинного вибору (2) - номенклатура є модифікатором (5)
|-
|
| MaxCount
| Decimal
| Максимальна кількість позиції. Якщо 0, то не перевіряємо
|-
|
| HierarchyLevel
| Int
| Значення HierarchyLevel із запиту
|-
|-
|  
|  
| Ordering  
| Ordering  
| Int
| Int  
| Порядок сортування
| Порядок сортування
|-
|-
|  
|  
| CategoryID
| ParentID
| Int
| Int
| ID категорії, не групи а саме категорії (тютюн, алкоголь, кухня)
| ID групи, в яку входить
|-
|-
|  
|  
| PhotoUrl  
| PhotoUrl
| String
| String  
| Посилання на фото
| Посилання на фото
|-
|-
|  
|  
| Code
| PriceListID
| String
| Int
| Зовнішній код
| ID прайс-листа
|-
|-
|  
|  
| IsComplex
| PropertyIDs
| Int
| Array
| Ознака, що позиція є комплексом (1 - так, 0 - ні)
| Масив ID властивостей групи
|-
|-
|  
|  
| Weidth
| RU
| Decimal
| Вага
|-
|
| KCal
| Int
| ККал
|-
|
| CpxMaxCount
| Int
| Максимальна кількість інгредієнтів в позиції комплекса (наприклад не більше 3)
|-
|
| CpxIsDefault
| Int
| Основний інгредієнт в комплексі (наприклад основа в салаті - "листя салату" або "лінгвіне")
|-
|
| SaleStatus
| Int
| Статус позиції: <br>
0– не в продажу<br>
1– в продажу<br>
2–гаряча позиция<br>
3–в «стоп–листі»
|-
|
| EnterpriseTaxCode
| String
| String
| Код зведення для зв’язку підприємства позиціїї та податку
|-
|
| RU
| String
| Назва російською
| Назва російською
|-
|-
|  
|  
| EN
| ShortName
| String
| Назва англійською
|-
|
| Measure
| String
| Одиниця виміру
|-
|
| Measure_RU
| String
| Одиниця виміру російською
|-
|
| Measure_EN
| String
| Одиниця виміру англійською
|-
|
| Rate
| Decimal
| Вага
|-
|
| Fats
| Decimal
| Жири
|-
|
| Proteins
| Decimal
| Білки
|-
|
| Carbohydrates
| Decimal
| Вуглеводи
|-
|
| ReceptInfo
| String
| Калькуляція в форматі xml/txt, в залежності від параметра ReceptInfoInText у запиті
|-
|
| ReceptInfo_RU
| String
| Калькуляція російською
|-
|
| ReceptInfo_EN
| String
| Калькуляція англійською
|-
|
| Allergen
| String
| Перелік алергенів в форматі xml/txt, в залежності від параметра ReceptInfoInText у запиті
|-
|
| Allergen_RU
| String
| Перелік алергенів російскою
|-
|
| Allergen_EN
| String
| Перелік алергенів англійською
|-
|
| AccountingPrice
| Decimal
| Облікова ціна
|-
|
| AccountingPrice2
| Decimal
| Облікова ціна (значення 2)
|-
|
| AccountingPrice3
| Decimal
| Облікова ціна (значення 3)
|-
|
| IsVegan
| Bool
| Ознака веганського
|-
|
| IsHot
| Bool
| Ознака гострого
|-
|
| EnterpriseID
| Int
| ID підприємства, до якого належить позиція
|-
|
| PropertyIDs
| Array
| Масив ID властивостей групи
|-
|
| PriceListID
| Int
| ID прайс-листа
|-
|
| WeidthStr
| String  
| String  
| Вага прописом
| Коротка назва
|-
|-



Поточна версія на 11:35, 18 серпня 2022

Отримання груп меню

Розділ містить методи, необхідні для отримання груп меню з вказанням вкладеності 


Опис Отримання груп меню.
Метод POST
URL /POSExternal/Get_TarifItems



Request Headers
KEY VALUE
Content-Type application/json
AccessToken



Body raw (json)
{
"WithProperties": "true",
"PriceListID": 3109,
"PriceListCode2": ""
}



Типи даних Body
* Параметр Тип Опис
PriceListID Int ID прайс-листа
PriceListCode2 String Код прайс-листа
WithProperties Bool Отримання масиву ідентифікаторів характеристик груп
Додатковий опис вихідних параметрів



Response (json)
{
"Error": "",
"Success": true,
"Items": [
{
"EN": null,
"HasTarifItem": false,
"HierarchyLevel": 1,
"ID": 3110,
"Name": "Меню",
"Ordering": 1000,
"ParentID": 0,
"PhotoUrl": null,
"PriceListID": 3109,
"PropertyIDs": [],
"RU": "Меню",
"ShortName": "Меню"
},
{
"EN": null,
"HasTarifItem": true,
"HierarchyLevel": 2,
"ID": 10337,
"Name": "Десерти",
"Ordering": 0,
"ParentID": 3110,
"PhotoUrl": null,
"PriceListID": 3109,
"PropertyIDs": [],
"RU": "Десерти",
"ShortName": "Десерти"
},
}



Типи даних Response
* Параметр Тип Опис
Error String [] Опис помилки, що виникла
Success Bool Успіх виконання запиту
EN String Назва англійською
HasTarifItem Bool Ознака наявності тарифних позицій в групі
HierarchyLevel Int Рівень ієрархії (1- початковий рівень)
Name String Назва групи меню
ID Int ID групи
Ordering Int Порядок сортування
ParentID Int ID групи, в яку входить
PhotoUrl String Посилання на фото
PriceListID Int ID прайс-листа
PropertyIDs Array Масив ID властивостей групи
RU String Назва російською
ShortName String Коротка назва
* Позначення обов’язкового параметру
Додатковий опис вхідних параметрів