GET api/WebApiOdata/GetPreferredGroupProducts?providerID={providerID}&groupID={groupID}&searchString={searchString}&status={status}&onlyGroup={onlyGroup}&datapageSize={datapageSize}&filterDataPageSize={filterDataPageSize}

Request Information

URI Parameters

Name	Type	Additional information
providerID	integer	Required
groupID	integer	Required
searchString	string	Required
status	byte	Default value is 1
onlyGroup	boolean	Default value is False
datapageSize	integer	Default value is 0
filterDataPageSize	integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

Collection of PreferredGroupProductViewModel

Name	Type	Additional information
PreferredGroupProductID	integer	None.
PreferredGroupID	integer	None.
SCProductID	integer	None.
DiscountPercentage	decimal number	None.
GroupNames	string	None.
BrandName	string	None.
ProductID	integer	None.
Name	string	None.
Code	string	None.
ProviderID	integer	None.
SupplierName	string	None.
Subscribed	byte	None.
SupplierID	integer	None.
SmallImage	string	None.
MSRP	decimal number	None.
MAP	decimal number	None.
Image	string	None.
DiscountedPrice	decimal number	None.
SellingPrice	decimal number	None.
LockTypeID	byte	None.
DisplayMSRP	string	None.
DisplayDiscountedPrice	string	None.
DisplaySellingPrice	string	None.
PriceAfterDiscount	decimal number	None.
HideToPublic	boolean	None.
ProductPricingRuleID	integer	None.
EmbellishmentID	integer	None.
GridTotalCount	integer	None.

Response Formats

application/json, text/json, text/html

Sample:

[
  {
    "PreferredGroupProductID": 1,
    "PreferredGroupID": 2,
    "SCProductID": 3,
    "DiscountPercentage": 4.1,
    "GroupNames": "sample string 5",
    "BrandName": "sample string 6",
    "ProductID": 1,
    "Name": "sample string 7",
    "Code": "sample string 8",
    "ProviderID": 1,
    "SupplierName": "sample string 9",
    "Subscribed": 64,
    "SupplierID": 10,
    "SmallImage": "sample string 11",
    "MSRP": 12.1,
    "MAP": 13.1,
    "Image": "sample string 14",
    "DiscountedPrice": 15.1,
    "SellingPrice": 16.1,
    "LockTypeID": 64,
    "DisplayMSRP": "$12.10",
    "DisplayDiscountedPrice": "$1.00",
    "DisplaySellingPrice": "$16.10",
    "PriceAfterDiscount": 1.1,
    "HideToPublic": true,
    "ProductPricingRuleID": 17,
    "EmbellishmentID": 1,
    "GridTotalCount": 18
  },
  {
    "PreferredGroupProductID": 1,
    "PreferredGroupID": 2,
    "SCProductID": 3,
    "DiscountPercentage": 4.1,
    "GroupNames": "sample string 5",
    "BrandName": "sample string 6",
    "ProductID": 1,
    "Name": "sample string 7",
    "Code": "sample string 8",
    "ProviderID": 1,
    "SupplierName": "sample string 9",
    "Subscribed": 64,
    "SupplierID": 10,
    "SmallImage": "sample string 11",
    "MSRP": 12.1,
    "MAP": 13.1,
    "Image": "sample string 14",
    "DiscountedPrice": 15.1,
    "SellingPrice": 16.1,
    "LockTypeID": 64,
    "DisplayMSRP": "$12.10",
    "DisplayDiscountedPrice": "$1.00",
    "DisplaySellingPrice": "$16.10",
    "PriceAfterDiscount": 1.1,
    "HideToPublic": true,
    "ProductPricingRuleID": 17,
    "EmbellishmentID": 1,
    "GridTotalCount": 18
  }
]

application/xml, text/xml

Sample:

<ArrayOfPreferredGroupProductViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SellersCommerce.ViewModels.Shoppers">
  <PreferredGroupProductViewModel>
    <BrandName>sample string 6</BrandName>
    <Code>sample string 8</Code>
    <DiscountPercentage>4.1</DiscountPercentage>
    <DiscountedPrice>15.1</DiscountedPrice>
    <EmbellishmentID>1</EmbellishmentID>
    <GridTotalCount>18</GridTotalCount>
    <GroupNames>sample string 5</GroupNames>
    <HideToPublic>true</HideToPublic>
    <Image>sample string 14</Image>
    <LockTypeID>64</LockTypeID>
    <MAP>13.1</MAP>
    <MSRP>12.1</MSRP>
    <Name>sample string 7</Name>
    <PreferredGroupID>2</PreferredGroupID>
    <PreferredGroupProductID>1</PreferredGroupProductID>
    <PriceAfterDiscount>1.1</PriceAfterDiscount>
    <ProductID>1</ProductID>
    <ProductPricingRuleID>17</ProductPricingRuleID>
    <ProviderID>1</ProviderID>
    <SCProductID>3</SCProductID>
    <SellingPrice>16.1</SellingPrice>
    <SmallImage>sample string 11</SmallImage>
    <Subscribed>64</Subscribed>
    <SupplierID>10</SupplierID>
    <SupplierName>sample string 9</SupplierName>
  </PreferredGroupProductViewModel>
  <PreferredGroupProductViewModel>
    <BrandName>sample string 6</BrandName>
    <Code>sample string 8</Code>
    <DiscountPercentage>4.1</DiscountPercentage>
    <DiscountedPrice>15.1</DiscountedPrice>
    <EmbellishmentID>1</EmbellishmentID>
    <GridTotalCount>18</GridTotalCount>
    <GroupNames>sample string 5</GroupNames>
    <HideToPublic>true</HideToPublic>
    <Image>sample string 14</Image>
    <LockTypeID>64</LockTypeID>
    <MAP>13.1</MAP>
    <MSRP>12.1</MSRP>
    <Name>sample string 7</Name>
    <PreferredGroupID>2</PreferredGroupID>
    <PreferredGroupProductID>1</PreferredGroupProductID>
    <PriceAfterDiscount>1.1</PriceAfterDiscount>
    <ProductID>1</ProductID>
    <ProductPricingRuleID>17</ProductPricingRuleID>
    <ProviderID>1</ProviderID>
    <SCProductID>3</SCProductID>
    <SellingPrice>16.1</SellingPrice>
    <SmallImage>sample string 11</SmallImage>
    <Subscribed>64</Subscribed>
    <SupplierID>10</SupplierID>
    <SupplierName>sample string 9</SupplierName>
  </PreferredGroupProductViewModel>
</ArrayOfPreferredGroupProductViewModel>