sh_doc_product_return
1 Описание
| Назначение | Создать документ возврата товара |
| Тип запроса | Асинхронный |
| Версия SH | SH4, SH5 |
В sh5 код документа состоит только из одной части, которая заполняется в поле textcode.
В sh5 нельзя добавить примечание к создаваемой накладной.
В sh5 активность документа определяется признаком активирован поставщиком (он и передается через api);
2 Формат запросов
2.1 Формат запроса
<RQ tasktype="any_call" cmd="sh_doc_product_return" callback="http://ya.ru"> <PARAM name="object_id" val="000000000"/> <DOC date="2017-04-05" store="int" corr="int" active="0" duedate="1" note="текст примечания" > <ITEM rid="int" quant="int" mu="int" receiving_report_record_rid="int" /> </DOC> </RQ>
Описание параметров
| Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
|---|---|---|---|---|
| object_id | int | + | Код ресторана в системе лицензирования | |
| groupguid | guid | - | Необязательный guid для группировки запросов в рамках одного пользовательского сценария. Если создаётся серия запросов (создан заказ, сохранён, оплачен), то лучше группировать их в один сценарий для упрощения диагностики проблем. | |
| callback | string | + | HTTP адрес, по которому WhiteServer отправит запрос после выполнения команды | |
| date | datetime | + | Дата накладной | |
| store | int | + | Rid склада | |
| corr | int | + | Ссылка на поставщика | |
| active | int | + | Активность дока (1 - да) | |
| note | string | + | Примечание, макс. 255 символов | |
| textcode | string | + | Tекстовая часть кода, макс 19 символов | Возможны 2 варианта задания кода накладной - автоматически и вручную. Если вручную, то нужно обязательно задать и текстовую часть и числовую, иначе код будет сгенерирован автоматически. |
| numcode | int | + | Числовая часть кода | |
| duedate | int | + | Поставить в начало даты (1 - да) | |
| rid | int | + | Ссылка на товар | |
| quant | int | + | Кол-во * 1000 | |
| mu | int | + | Ссылка на единицу измерения | |
| receiving_report_record_rid | int | + | Rid записи этого же товара с приходной накладной, см sh_get_doc_receiving_report→ITEM→record_rid |
2.2 Формат ответа
<?xml version="1.0" encoding="utf-8"?> <RP taskguid="6774b0bc-dd5e-4eca-a1f9-d982607feb2e" code="0" version="1.5.0.7155" />
Описание параметров
| Параметр | Тип | Описание |
|---|---|---|
| taskguid | guid | Уникальный код этой задачи. При отправке callback будет использован этот код, чтобы вызывающий сервис мог сопоставить запрос и ответ |
2.3 Формат callback (асинхронного ответа)
<RP cmdguid="e1761d18-6325-43d0-85a3-2610ad637f3d" posid="90EF4C1B-358E-4408-8B4D-E2BC799A0688"> <DOC rid="1528" textcode="34124п/н" numcode="11"/> </RP>
Описание параметров
| Параметр | Тип | Описание |
|---|---|---|
| cmdguid | guid | Совпадает с taskguid в ответе |
| posid | guid | POS id кассового сервера (можно игнорировать) |
| rid | int | Rid созданного документа |
| numcode | int | Код созданного документа |
| textcode | string | Tекстовый код созданного документа |
3 Примеры вызовов
3.1 Пример
3.1.1 Запрос
<?xml version="1.0" encoding="utf-8"?> <RQ tasktype="any_call" cmd="sh_doc_product_return" callback="http://ya.ru" guid="guid"> <PARAM name="object_id" val="199990106"/> <DOC date="2017-04-05" store="1423" corr="1392" active="0" duedate="1" note="текст примечания" > <ITEM rid="14108" quant="1000" mu="6" receiving_report_record_rid="44091" /> </DOC> </RQ>
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 (асинхронный ответ)
<RP cmdguid="0a85447e-f4da-4424-8c36-d20c63fe6b89" posid="90EF4C1B-358E-4408-8B4D-E2BC799A0688"> <DOC rid="1528" textcode="34124" numcode="11"/> </RP>
Обратите внимание, что в 3.1.2 taskguid и 3.1.3 cmdguid совпадают.