GET api/search/generalproductsearch

Return Batch for a general product search eg. Search for 'diet' in StoreId 1. Return BatchId 97, Count 203...

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OperatorId

The OperatorId of the person currently logged in that is performing this search.

integer

None.

SearchValue

What are we searching for?

string

None.

StoreId

In what store

integer

None.

ActiveOnly

Searching products not catalogue?

boolean

None.

IncludeDeleted

Include deleted products in search

boolean

None.

IncludeSecondDescription

Include second Description in searches

boolean

None.

SupplierGuid

Optionally provide a SupplierIdentifier to limit the search results to only those products supplied by this supplier. This is likely to be used in places like Ordering where we are looking to only allow products to be added to an order that are supplied by the supplier the order is for.

globally unique identifier

None.

SupplierIdentifier

Collection of byte

None.

StartsWith

Result will only match if field begins with SearchValue. Option does not apply to description search

boolean

None.

PartialMatch

Result will match if field contains SearchValue anywhere in the string. Option does not apply to description search

boolean

None.

Skip

integer

None.

Take

integer

None.

SortBy

string

None.

SortDirection

string

None.

Body Parameters

None.

Response Information

Resource Description

Batch
NameDescriptionTypeAdditional information
Id

integer

None.

Description

string

None.

OperatorId

integer

None.

Count

integer

None.

Protected

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "description": "sample string 2",
  "operatorId": 1,
  "count": 3,
  "protected": true
}

application/xml, text/xml

Sample:
<Batch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Search">
  <Count>3</Count>
  <Description>sample string 2</Description>
  <Id>1</Id>
  <OperatorId>1</OperatorId>
  <Protected>true</Protected>
</Batch>

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Sample:
PK�4�Z�[��5xl/workbook.xml �(�����0��&�C���N\�z�^��6П�5���H�yۙ��v�����vD=�P��]EH�4'�����^���+���Y��`")(-���EeM�����a�
AD=�(͔���P�4{*�C����.&"k�����/�B�ihp�"�(;���g�|��𸔜��[/�k��V��w�PK�4�Z����	�[Content_Types].xml �(����J�0�_��*M�D��V�*��d�
�d�k��<�H���V���=
��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ
�1Z�$�8z�R��3
tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b
��%#H'�2}���e�B)��~j/F�t��PK
�4�Z�<��''_rels/.rels �(�<?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="R2361754b22a741a7" /></Relationships>PK�4�Z�
G�xl/worksheets/sheet1.xml �(���Ko�0F���������I��n��t��b�N�ϯ14/�hf�m|��ǵȞ>e�\���C��RU����`�)|*�^��pn��;��9l�ݯ2e�%3������JKf�RkQ�*�wQ��yˬ;�4bo�X�_j����d;��Lt��*���u��jC!@E��?���b�/���ǰ�U�{��?���١�o��b�Xפ�;�j�)��A ٧{Q�&�ˀD8��.�*�>�&����ɣ'�D�"�&�2I�}쇓�}%q�,n$��h���O^|>8N�$\�0�룱m��kfY�i��]�a���ߌk�qW|,p���;/s�\?��&�s"�&6s":��>e���tr�dz��z�M���r�6�rr�]t�q��[�,��NN�w�PK�4�ZK��E�Pxl/_rels/workbook.xml.rels �(���An� E����C\7
ɦ�n�\��X�i��u�#�
E����n�B���h�|���ޖ�@���Ӫ��r�dG�OI�ux���a�)߈f��'6
lR�kB�2��X96w��L�#�R���떄�����p����zR���i���W��$�2����"���T�����U�Ѫ^���
�����b:����Bf����o%Ӛ3�n*cd��9���ҩ�5���{��:��5r�/�_PK�4�ZЃc'2E
xl/styles.xml �(��S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v�F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&�
AR>��� ��im��ΑF���YO��%�}���LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK�4�Z��D��Gxl/sharedStrings.xml �(�ePAN1�J�;��CA(I�J=��< ʚn����^�'���83{<n�Qf�,�����)�1�����psF4��J���>85�J�aRm�J��D�Ԇԕ��%j�|���(���n�agK�&Յ�����e��?���4Gg58��~�'�Ĺiϻ��r��צ��k�bR���Xڌ�m�-��Z>����M�/PK-�4�Z�[��5xl/workbook.xmlPK-�4�Z����	��[Content_Types].xmlPK-
�4�Z�<��''U_rels/.relsPK-�4�Z�
G��xl/worksheets/sheet1.xmlPK-�4�ZK��E�P�xl/_rels/workbook.xml.relsPK-�4�ZЃc'2E
�xl/styles.xmlPK-�4�Z��D��Gmxl/sharedStrings.xmlPK�	

application/vnd.ms-excel

Sample:
PK�4�Z��9�5xl/workbook.xml �(�����0��&�C��B�N\�z�^�b�O�||�o�vfg�:7���F�KWa�-	�\�b�d,�y��X��{���Cc�[�$=�3�`dA텴��X�:`�A�+J1�q}< D�fO	��r6�����"�)a�ETH3nX`E��U8�ȕrIίE���-���w��d�]PK�4�Z����	�[Content_Types].xml �(����J�0�_��*M�D��V�*��d�
�d�k��<�H���V���=
��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ
�1Z�$�8z�R��3
tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b
��%#H'�2}���e�B)��~j/F�t��PK
�4�Z:G�'''_rels/.rels �(�<?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="Rcc657d2f07094c06" /></Relationships>PK�4�Z�
G�xl/worksheets/sheet1.xml �(���Ko�0F���������I��n��t��b�N�ϯ14/�hf�m|��ǵȞ>e�\���C��RU����`�)|*�^��pn��;��9l�ݯ2e�%3������JKf�RkQ�*�wQ��yˬ;�4bo�X�_j����d;��Lt��*���u��jC!@E��?���b�/���ǰ�U�{��?���١�o��b�Xפ�;�j�)��A ٧{Q�&�ˀD8��.�*�>�&����ɣ'�D�"�&�2I�}쇓�}%q�,n$��h���O^|>8N�$\�0�룱m��kfY�i��]�a���ߌk�qW|,p���;/s�\?��&�s"�&6s":��>e���tr�dz��z�M���r�6�rr�]t�q��[�,��NN�w�PK�4�Z�m���Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞81�4�i7ݰ-��3'Q;��B�Ƃ#q�"A*�`��h~OO��|�Xoߦ�������$F�L��)�l7�=�2�	��gq����'�=�4I�ؙL�h�&b�:>K<ʎ�HӒ�%n��p��?D�����x�Ȅ?��պ����t�~J�_C�D*�g��>���U�֫�r��M͇�H���;_�`Z�*|,�L���ґz	.^z�,/�D�B����*rي�����PK�4�ZЃc'2E
xl/styles.xml �(��S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v�F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&�
AR>��� ��im��ΑF���YO��%�}���LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK�4�Z��D��Gxl/sharedStrings.xml �(�ePAN1�J�;��CA(I�J=��< ʚn����^�'���83{<n�Qf�,�����)�1�����psF4��J���>85�J�aRm�J��D�Ԇԕ��%j�|���(���n�agK�&Յ�����e��?���4Gg58��~�'�Ĺiϻ��r��צ��k�bR���Xڌ�m�-��Z>����M�/PK-�4�Z��9�5xl/workbook.xmlPK-�4�Z����	�[Content_Types].xmlPK-
�4�Z:G�'''V_rels/.relsPK-�4�Z�
G��xl/worksheets/sheet1.xmlPK-�4�Z�m���P�xl/_rels/workbook.xml.relsPK-�4�ZЃc'2E
�xl/styles.xmlPK-�4�Z��D��Gnxl/sharedStrings.xmlPK��