POST api/v2/Catalog/GetMostRedeemedProduct

Request Information

URI Parameters

None.

Body Parameters

Multisponsor.NetCommerce.API.Models.V2.RequestV2OfMultisponsor.NetCommerce.API.Models.V2.CatalogFilterV2

Name	Description	Type	Additional information
token		string	None.
ObjectRequest		Multisponsor.NetCommerce.API.Models.V2.CatalogFilterV2	None.

Request Formats

application/json, text/json

Sample:

{
  "token": "sample string 1",
  "ObjectRequest": {
    "ProgramId": 1,
    "SearchQuery": "sample string 2",
    "CategoryId": 1,
    "ProductCode": "sample string 3",
    "ProductGuid": "sample string 4",
    "SegmentId": 1,
    "BrandId": 1,
    "MinValueMoney": 1.0,
    "MaxValueMoney": 1.0,
    "MinValuePoint": 1,
    "MaxValuePoint": 1,
    "PageIndex": 5,
    "PageSize": 6,
    "Recommended": true,
    "TotalRecords": 7,
    "ReferenceId": "sample string 8",
    "PaymentRuleId": 1,
    "ShowProductsWithInventory": true,
    "Campaign": "sample string 10",
    "OrderValue": 11
  }
}

application/xml, text/xml

Sample:

<RequestV2OfCatalogFilterV2eD9PY_SAf xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Multisponsor.NetCommerce.API.Models.V2">
  <ObjectRequest>
    <BrandId>1</BrandId>
    <Campaign>sample string 10</Campaign>
    <CategoryId>1</CategoryId>
    <MaxValueMoney>1</MaxValueMoney>
    <MaxValuePoint>1</MaxValuePoint>
    <MinValueMoney>1</MinValueMoney>
    <MinValuePoint>1</MinValuePoint>
    <OrderValue>11</OrderValue>
    <PageIndex>5</PageIndex>
    <PageSize>6</PageSize>
    <PaymentRuleId>1</PaymentRuleId>
    <ProductCode>sample string 3</ProductCode>
    <ProductGuid>sample string 4</ProductGuid>
    <ProgramId>1</ProgramId>
    <Recommended>true</Recommended>
    <ReferenceId>sample string 8</ReferenceId>
    <SearchQuery>sample string 2</SearchQuery>
    <SegmentId>1</SegmentId>
    <ShowProductsWithInventory>true</ShowProductsWithInventory>
    <TotalRecords>7</TotalRecords>
  </ObjectRequest>
  <token>sample string 1</token>
</RequestV2OfCatalogFilterV2eD9PY_SAf>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Multisponsor.NetCommerce.API.Models.V2.ResponseV2OfMultisponsor.NetCommerce.API.Models.V2.CatalogFilterListResponseV2

Name	Type	Additional information
Status	boolean	None.
Message	Collection of Multisponsor.NetCommerce.API.Models.V2.MessageResultV2	None.
ObjectResponse	Multisponsor.NetCommerce.API.Models.V2.CatalogFilterListResponseV2	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": true,
  "Message": [
    {
      "Message": "sample string 1"
    },
    {
      "Message": "sample string 1"
    }
  ],
  "ObjectResponse": {
    "Data": [
      {},
      {}
    ],
    "TotalRecord": 1
  }
}

application/xml, text/xml

Sample:

<ResponseV2OfCatalogFilterListResponseV2eD9PY_SAf xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Multisponsor.NetCommerce.API.Models.V2">
  <Message>
    <MessageResultV2>
      <Message>sample string 1</Message>
    </MessageResultV2>
    <MessageResultV2>
      <Message>sample string 1</Message>
    </MessageResultV2>
  </Message>
  <ObjectResponse>
    <Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </Data>
    <TotalRecord>1</TotalRecord>
  </ObjectResponse>
  <Status>true</Status>
</ResponseV2OfCatalogFilterListResponseV2eD9PY_SAf>