GET api/Shopper/GetAllPreferredGroups?providerId={providerId}&pfAdvSearch={pfAdvSearch}

Request Information

URI Parameters

Name	Description	Type	Additional information
providerId		integer	Required
pfAdvSearch		integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

Collection of PreferredGroupViewModel

Name	Type	Additional information
PreferredGroupID	integer	None.
GroupName	string	None.
Password	string	None.
DiscountRate	decimal number	None.
GroupView	boolean	None.
PublicView	boolean	None.
GroupLogo	string	None.
Status	boolean	None.
Grouptype	byte	None.
IsSubDomain	boolean	None.
DisplayDiscountRate	string	None.
ShoppersCount	integer	None.
GroupDisplayName	string	None.
EmbellishmentID	integer	None.
ParentGroupID	integer	None.
IsGroupStorePlus	boolean	None.
DomainURL	string	None.
SubStoreURL	string	None.

Response Formats

application/json, text/json, text/html

Sample:

[
  {
    "PreferredGroupID": 1,
    "GroupName": "sample string 2",
    "Password": "sample string 3",
    "DiscountRate": 4.1,
    "GroupView": true,
    "PublicView": true,
    "GroupLogo": "sample string 7",
    "Status": true,
    "Grouptype": 64,
    "IsSubDomain": true,
    "DisplayDiscountRate": "4.10",
    "ShoppersCount": 10,
    "GroupDisplayName": "sample string 11",
    "EmbellishmentID": 12,
    "ParentGroupID": 1,
    "IsGroupStorePlus": true,
    "DomainURL": "sample string 14",
    "SubStoreURL": "https://sample string 14"
  },
  {
    "PreferredGroupID": 1,
    "GroupName": "sample string 2",
    "Password": "sample string 3",
    "DiscountRate": 4.1,
    "GroupView": true,
    "PublicView": true,
    "GroupLogo": "sample string 7",
    "Status": true,
    "Grouptype": 64,
    "IsSubDomain": true,
    "DisplayDiscountRate": "4.10",
    "ShoppersCount": 10,
    "GroupDisplayName": "sample string 11",
    "EmbellishmentID": 12,
    "ParentGroupID": 1,
    "IsGroupStorePlus": true,
    "DomainURL": "sample string 14",
    "SubStoreURL": "https://sample string 14"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPreferredGroupViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SellersCommerce.ViewModels.Shoppers">
  <PreferredGroupViewModel>
    <DiscountRate>4.1</DiscountRate>
    <DomainURL>sample string 14</DomainURL>
    <EmbellishmentID>12</EmbellishmentID>
    <GroupDisplayName>sample string 11</GroupDisplayName>
    <GroupLogo>sample string 7</GroupLogo>
    <GroupName>sample string 2</GroupName>
    <GroupView>true</GroupView>
    <Grouptype>64</Grouptype>
    <IsGroupStorePlus>true</IsGroupStorePlus>
    <IsSubDomain>true</IsSubDomain>
    <ParentGroupID>1</ParentGroupID>
    <Password>sample string 3</Password>
    <PreferredGroupID>1</PreferredGroupID>
    <PublicView>true</PublicView>
    <ShoppersCount>10</ShoppersCount>
    <Status>true</Status>
  </PreferredGroupViewModel>
  <PreferredGroupViewModel>
    <DiscountRate>4.1</DiscountRate>
    <DomainURL>sample string 14</DomainURL>
    <EmbellishmentID>12</EmbellishmentID>
    <GroupDisplayName>sample string 11</GroupDisplayName>
    <GroupLogo>sample string 7</GroupLogo>
    <GroupName>sample string 2</GroupName>
    <GroupView>true</GroupView>
    <Grouptype>64</Grouptype>
    <IsGroupStorePlus>true</IsGroupStorePlus>
    <IsSubDomain>true</IsSubDomain>
    <ParentGroupID>1</ParentGroupID>
    <Password>sample string 3</Password>
    <PreferredGroupID>1</PreferredGroupID>
    <PublicView>true</PublicView>
    <ShoppersCount>10</ShoppersCount>
    <Status>true</Status>
  </PreferredGroupViewModel>
</ArrayOfPreferredGroupViewModel>