PUT api/coupon/getfavoritecouponlist

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerId	integer	None.
ContactId	integer	None.
LanguageCode	string	None.
PageNumber	integer	None.
PageSize	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "ContactId": 2,
  "LanguageCode": "sample string 3",
  "PageNumber": 4,
  "PageSize": 5
}

application/xml, text/xml

Sample:

<FavoriteCouponRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <ContactId>2</ContactId>
  <CustomerId>1</CustomerId>
  <LanguageCode>sample string 3</LanguageCode>
  <PageNumber>4</PageNumber>
  <PageSize>5</PageSize>
</FavoriteCouponRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APICommonWrapperOfFavoriteCouponResponse

Name	Type	Additional information
Status	HttpStatusCode	None.
Message	string	None.
Data	FavoriteCouponResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": 100,
  "Message": "sample string 1",
  "Data": {
    "list": [
      {
        "Id": 1,
        "Title": "sample string 2",
        "Description": "sample string 3",
        "Logo": "sample string 4",
        "StartDate": "2026-01-15T20:44:58.0842088+00:00",
        "EndDate": "2026-01-15T20:44:58.0842088+00:00",
        "IsDefaultCoupon": true,
        "CouponProgramId": 6,
        "CouponProgramDescription": "sample string 7",
        "IsRedeemed": true,
        "IsFavorite": true,
        "LocationId": 10,
        "LocationTitle": "sample string 11",
        "City": "sample string 12",
        "NextCouponRedeemDate": "2026-01-15T20:44:58.0842088+00:00"
      },
      {
        "Id": 1,
        "Title": "sample string 2",
        "Description": "sample string 3",
        "Logo": "sample string 4",
        "StartDate": "2026-01-15T20:44:58.0842088+00:00",
        "EndDate": "2026-01-15T20:44:58.0842088+00:00",
        "IsDefaultCoupon": true,
        "CouponProgramId": 6,
        "CouponProgramDescription": "sample string 7",
        "IsRedeemed": true,
        "IsFavorite": true,
        "LocationId": 10,
        "LocationTitle": "sample string 11",
        "City": "sample string 12",
        "NextCouponRedeemDate": "2026-01-15T20:44:58.0842088+00:00"
      }
    ],
    "TotalRecords": 1
  }
}

application/xml, text/xml

Sample:

<APICommonWrapperOfFavoriteCouponResponseZdSfSp5S xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <Data>
    <TotalRecords>1</TotalRecords>
    <list>
      <CouponDetailAPIResponse>
        <City>sample string 12</City>
        <CouponProgramDescription>sample string 7</CouponProgramDescription>
        <CouponProgramId>6</CouponProgramId>
        <Description>sample string 3</Description>
        <EndDate>2026-01-15T20:44:58.0842088+00:00</EndDate>
        <Id>1</Id>
        <IsDefaultCoupon>true</IsDefaultCoupon>
        <IsFavorite>true</IsFavorite>
        <IsRedeemed>true</IsRedeemed>
        <LocationId>10</LocationId>
        <LocationTitle>sample string 11</LocationTitle>
        <Logo>sample string 4</Logo>
        <NextCouponRedeemDate>2026-01-15T20:44:58.0842088+00:00</NextCouponRedeemDate>
        <StartDate>2026-01-15T20:44:58.0842088+00:00</StartDate>
        <Title>sample string 2</Title>
      </CouponDetailAPIResponse>
      <CouponDetailAPIResponse>
        <City>sample string 12</City>
        <CouponProgramDescription>sample string 7</CouponProgramDescription>
        <CouponProgramId>6</CouponProgramId>
        <Description>sample string 3</Description>
        <EndDate>2026-01-15T20:44:58.0842088+00:00</EndDate>
        <Id>1</Id>
        <IsDefaultCoupon>true</IsDefaultCoupon>
        <IsFavorite>true</IsFavorite>
        <IsRedeemed>true</IsRedeemed>
        <LocationId>10</LocationId>
        <LocationTitle>sample string 11</LocationTitle>
        <Logo>sample string 4</Logo>
        <NextCouponRedeemDate>2026-01-15T20:44:58.0842088+00:00</NextCouponRedeemDate>
        <StartDate>2026-01-15T20:44:58.0842088+00:00</StartDate>
        <Title>sample string 2</Title>
      </CouponDetailAPIResponse>
    </list>
  </Data>
  <Message>sample string 1</Message>
  <Status>Continue</Status>
</APICommonWrapperOfFavoriteCouponResponseZdSfSp5S>