НазначениеПолучить список товарных групп
Тип запросаАсинхронный
Версия SHSH4, SH5

В sh5 запрос работает быстрее.
В sh5 не возвращаются штрихкоды (не реализовано в sh5).

2.1 Формат запросаLink to 2.1 Формат запроса

Запрос на получение всех групп блюд:

<?xml version="1.0" encoding="utf-8"?>
<RQ cmd="sh_get_goodgroups" tasktype="any_call"  callback="ya.ru" timeout="int">
  <PARAM name="object_id" val="000000000"/>
</RQ>

Запрос на получение группы блюд:

<?xml version="1.0" encoding="utf-8"?>
<RQ cmd="sh_get_goodgroups" tasktype="any_call"  callback="ya.ru" timeout="int">
  <PARAM name="object_id" val="000000000"/>
  <PARAM name="goodgroup_rid" val="int"/>
</RQ>

Запрос на получение группы блюд с товарами:

<?xml version="1.0" encoding="utf-8"?>
<RQ cmd="sh_get_goodgroups" tasktype="any_call" callback="ya.ru" timeout="int">
  <PARAM name="object_id" val="000000000"/>
  <PARAM name="goodgroup_rid" val="int"/>
  <PARAM name="include_goods" val="1"/>
</RQ>

Запрос нескольких товарных групп одним запросом:

<?xml version="1.0" encoding="utf-8"?>
 <RQ cmd="sh_get_goodgroups" tasktype = "any_call" callback="ya.ru"> 
  <PARAM name="object_id" val="000000000"/>
  <PARAM name="goodgroup_rid" val="988"/>
  <PARAM name="include_goods" val="1"/>
 <GROUPS>
    <GROUP rid="2" include_goods="1"/>
    <GROUP rid="3"/>
    <GROUP rid="4" include_goods="0"/>
  </GROUPS>
</RQ>

Описание параметров


Параметр
Тип
Обязательный
Описание
Значение по умолчанию
object_idint+Код ресторана в системе лицензирования
groupguidguid-Необязательный guid для группировки запросов в рамках одного пользовательского сценария. Если создаётся серия запросов (создан заказ, сохранён, оплачен), то лучше группировать их в один сценарий для упрощения диагностики проблем.
callbackstring+HTTP адрес, по которому WhiteServer отправит запрос после выполнения команды
goodgroup_ridint+Ссылка на родителя
include_goodint-Если значение равно единице, то группа возвращается с информацией о товарах в этой группе0


2.2 Формат ответаLink to 2.2 Формат ответа

<?xml version="1.0" encoding="utf-8"?>
<RP taskguid="6774b0bc-dd5e-4eca-a1f9-d982607feb2e" code="0" version="1.5.0.7155" />

Описание параметров

Параметр
Тип
Описание
taskguidguidУникальный код этой задачи. При отправке callback будет использован этот код, чтобы вызывающий сервис мог сопоставить запрос и ответ


2.3 Формат callback (асинхронного ответа)Link to 2.3 Формат callback (асинхронного ответа)

<RP cmdguid="d87eb27c-6220-4ff4-9d1b-0951b50447a7" posid="4D7B18F2-58CE-4F0F-A2B6-2D90A6BFCF67">
  <ITEM rid="1" name="name group" parent="3"/>
  <ITEM rid="2" name="name group1" parent="1"/>
  <ITEM rid="3" name="name group2" parent="2"/>
</RP>

Товарные группы вместе с товарами:

<RP cmdguid="d87eb27c-6220-4ff4-9d1b-0951b50447a7" posid="4D7B18F2-58CE-4F0F-A2B6-2D90A6BFCF67">
	<ITEM rid="990" name="Горячее" parent="">
		<GOODS_LIST>
			<ITEM rid="13978" name="Рис для суши (заправ) 150 г//">
				<MUNITS>
					<MUNIT rid="6" name="порция" isbase="1"/>
				</MUNITS>
			</ITEM>
			<ITEM rid="13973" name="Унайдзю (угорь на рисе)//">
				<MUNITS>
					<MUNIT rid="3" name="литр" isbase="0"/>
					<MUNIT rid="6" name="порция" isbase="1"/>
				</MUNITS>
			</ITEM>
			<ITEM rid="13972" name="Гохан (отварной рис) 150 г//">
				<MUNITS>
					<MUNIT rid="6" name="порция" isbase="1"/>
				</MUNITS>
			</ITEM>
		</GOODS_LIST>
	</ITEM>
	<ITEM rid="991" name="Суши Бар" parent="">
		<GOODS_LIST/>
	</ITEM>
</RP>

Несколько товарных групп:

<RP cmdguid="d87eb27c-6220-4ff4-9d1b-0951b50447a7" posid="4D7B18F2-58CE-4F0F-A2B6-2D90A6BFCF67">
	<ITEM rid="1012" name="Подгруппа" parent="990">
		<GOODS_LIST>
			<ITEM rid="14167" name="Мидори сарада//">
				<MUNITS>
					<MUNIT rid="6" name="порция" isbase="1"/>
				</MUNITS>
			</ITEM>
			<ITEM rid="14109" name="Киниро сарада//">
				<MUNITS>
					<MUNIT rid="6" name="порция" isbase="1"/>
				</MUNITS>
			</ITEM>
			<ITEM rid="14106" name="Цезарь-Сан с креветками//">
				<MUNITS>
					<MUNIT rid="6" name="порция" isbase="1"/>
				</MUNITS>
			</ITEM>
		</GOODS_LIST>
	</ITEM>
	<ITEM rid="1023" name="Подгруппа 2" parent="990"/>
	<ITEM rid="1024" name="Подгруппа 3" parent="990">
		<GOODS_LIST>
			<ITEM rid="14108" name="Эби Уми сарада//">
				<MUNITS>
					<MUNIT rid="6" name="порция" isbase="1">
						<BARCODE val="4607046120059"/>
					</MUNIT>
				</MUNITS>
			</ITEM>
		</GOODS_LIST>
	</ITEM>
	<ITEM rid="1025" name="Подгруппа тест" parent="1004"/>
</RP>

Описание параметров

Параметр
Тип
Описание

cmdguidguidСовпадает с taskguid в ответе
posidguidPOS id кассового сервера (можно игнорировать)
ridintRid товарной группы
namestringНазвание товарной группы
parentintRid родителя
MUNIT ridintRid единицы измерения
MUNIT namestringназвание единицы измерения

3.1 ПримерLink to 3.1 Пример

3.1.1 ЗапросLink to 3.1.1 Запрос

<?xml version="1.0" encoding="utf-8"?>
<RQ cmd="sh_get_goodgroups" tasktype="any_call" callback="ya.ru" >
  <PARAM name="object_id" val="199990106"/>
</RQ>

3.1.2 ОтветLink to 3.1.2 Ответ

<?xml version="1.0" encoding="utf-8"?>
<RP taskguid="0a85447e-f4da-4424-8c36-d20c63fe6b89" code="0" version="1.7.0.8215" />

3.1.3 Callback (асинхронный ответ)Link to 3.1.3 Callback (асинхронный ответ)

<RP cmdguid="0a85447e-f4da-4424-8c36-d20c63fe6b89" posid="797C3E3B-3C33-4D97-87F8-25578FE48BE6">
  <ITEM rid="1" name="name group" parent="3"/>
  <ITEM rid="2" name="name group1" parent="1"/>
  <ITEM rid="3" name="name group2" parent="2"/>
</RP>

Обратите внимание, что в 3.1.2 taskguid и 3.1.3 cmdguid совпадают.

V2 ShGetGoodGroupsLink to V2 ShGetGoodGroups