PUT api/content/v4/getdealsandcouponlist

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerId	integer	None.
ContactId	integer	None.
PageNumber	integer	None.
SearchText	string	None.
LanguageCode	string	None.
SortBy	string	None.
SortDir	string	None.
IsTourDePearl	boolean	None.
CategoryId	integer	None.
UserUniqueId	integer	None.
LocationId	integer	None.
PromoCode	string	None.
PromoLink	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "ContactId": 2,
  "PageNumber": 3,
  "SearchText": "sample string 4",
  "LanguageCode": "sample string 5",
  "SortBy": "sample string 6",
  "SortDir": "sample string 7",
  "IsTourDePearl": true,
  "CategoryId": 9,
  "UserUniqueId": 10,
  "LocationId": 11,
  "PromoCode": "sample string 12",
  "PromoLink": "sample string 13"
}

application/xml, text/xml

Sample:

<APIGetDealsAndCouponsListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/">
  <CategoryId>9</CategoryId>
  <ContactId>2</ContactId>
  <CustomerId>1</CustomerId>
  <IsTourDePearl>true</IsTourDePearl>
  <LanguageCode>sample string 5</LanguageCode>
  <LocationId>11</LocationId>
  <PageNumber>3</PageNumber>
  <PromoCode>sample string 12</PromoCode>
  <PromoLink>sample string 13</PromoLink>
  <SearchText>sample string 4</SearchText>
  <SortBy>sample string 6</SortBy>
  <SortDir>sample string 7</SortDir>
  <UserUniqueId>10</UserUniqueId>
</APIGetDealsAndCouponsListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APICommonWrapperOfAPIGetDealsAndCouponsListResponse

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

Response Formats

application/json, text/json

Sample:

{
  "Status": 100,
  "Message": "sample string 1",
  "Data": {
    "CouponResponse": {
      "List": [
        {
          "CustomerId": 1,
          "LocationId": 2,
          "LocationTitle": "sample string 3",
          "City": "sample string 4",
          "Zip": "sample string 5",
          "IsRedeemed": true,
          "IsFavorite": true,
          "Id": 8,
          "Title": "sample string 9",
          "Description": "sample string 10",
          "Logo": "sample string 11",
          "StartDate": "2026-01-15T01:08:00.9020598+00:00",
          "EndDate": "2026-01-15T01:08:00.9020598+00:00",
          "IsDefaultCoupon": true,
          "CouponProgramId": 13,
          "CouponProgramDescription": "sample string 14",
          "NextCouponRedeemDate": "2026-01-15T01:08:00.9020598+00:00"
        },
        {
          "CustomerId": 1,
          "LocationId": 2,
          "LocationTitle": "sample string 3",
          "City": "sample string 4",
          "Zip": "sample string 5",
          "IsRedeemed": true,
          "IsFavorite": true,
          "Id": 8,
          "Title": "sample string 9",
          "Description": "sample string 10",
          "Logo": "sample string 11",
          "StartDate": "2026-01-15T01:08:00.9020598+00:00",
          "EndDate": "2026-01-15T01:08:00.9020598+00:00",
          "IsDefaultCoupon": true,
          "CouponProgramId": 13,
          "CouponProgramDescription": "sample string 14",
          "NextCouponRedeemDate": "2026-01-15T01:08:00.9020598+00:00"
        }
      ],
      "TotalRecords": 1
    },
    "DealResponse": {
      "DealList": [
        {
          "Id": 1,
          "Title": "sample string 2",
          "LocationTitle": "sample string 3",
          "Logo": "sample string 4",
          "StartDate": "2026-01-15T01:08:00.9020598+00:00",
          "EndDate": "2026-01-15T01:08:00.9020598+00:00",
          "Description": "sample string 5",
          "LocationId": 1,
          "IsFeatrureList": true,
          "Category": "sample string 7",
          "CategoryId": [
            1,
            2
          ],
          "MemberId": 1,
          "IsFavorite": true,
          "PromoLink": "sample string 9",
          "PromoCode": "sample string 10"
        },
        {
          "Id": 1,
          "Title": "sample string 2",
          "LocationTitle": "sample string 3",
          "Logo": "sample string 4",
          "StartDate": "2026-01-15T01:08:00.9020598+00:00",
          "EndDate": "2026-01-15T01:08:00.9020598+00:00",
          "Description": "sample string 5",
          "LocationId": 1,
          "IsFeatrureList": true,
          "Category": "sample string 7",
          "CategoryId": [
            1,
            2
          ],
          "MemberId": 1,
          "IsFavorite": true,
          "PromoLink": "sample string 9",
          "PromoCode": "sample string 10"
        }
      ],
      "TotalRecords": 1
    }
  }
}

application/xml, text/xml

Sample:

<APICommonWrapperOfAPIGetDealsAndCouponsListResponseMTRdQN6P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/">
    <d2p1:CouponResponse>
      <List>
        <CouponListResponse>
          <City i:nil="true" />
          <CouponProgramDescription>sample string 14</CouponProgramDescription>
          <CouponProgramId>13</CouponProgramId>
          <Description>sample string 10</Description>
          <EndDate>2026-01-15T01:08:00.9020598+00:00</EndDate>
          <Id>8</Id>
          <IsDefaultCoupon>true</IsDefaultCoupon>
          <IsFavorite>false</IsFavorite>
          <IsRedeemed>false</IsRedeemed>
          <LocationId>0</LocationId>
          <LocationTitle i:nil="true" />
          <Logo>sample string 11</Logo>
          <NextCouponRedeemDate>2026-01-15T01:08:00.9020598+00:00</NextCouponRedeemDate>
          <StartDate>2026-01-15T01:08:00.9020598+00:00</StartDate>
          <Title>sample string 9</Title>
          <City>sample string 4</City>
          <CustomerId>1</CustomerId>
          <IsFavorite>true</IsFavorite>
          <IsRedeemed>true</IsRedeemed>
          <LocationId>2</LocationId>
          <LocationTitle>sample string 3</LocationTitle>
          <Zip>sample string 5</Zip>
        </CouponListResponse>
        <CouponListResponse>
          <City i:nil="true" />
          <CouponProgramDescription>sample string 14</CouponProgramDescription>
          <CouponProgramId>13</CouponProgramId>
          <Description>sample string 10</Description>
          <EndDate>2026-01-15T01:08:00.9020598+00:00</EndDate>
          <Id>8</Id>
          <IsDefaultCoupon>true</IsDefaultCoupon>
          <IsFavorite>false</IsFavorite>
          <IsRedeemed>false</IsRedeemed>
          <LocationId>0</LocationId>
          <LocationTitle i:nil="true" />
          <Logo>sample string 11</Logo>
          <NextCouponRedeemDate>2026-01-15T01:08:00.9020598+00:00</NextCouponRedeemDate>
          <StartDate>2026-01-15T01:08:00.9020598+00:00</StartDate>
          <Title>sample string 9</Title>
          <City>sample string 4</City>
          <CustomerId>1</CustomerId>
          <IsFavorite>true</IsFavorite>
          <IsRedeemed>true</IsRedeemed>
          <LocationId>2</LocationId>
          <LocationTitle>sample string 3</LocationTitle>
          <Zip>sample string 5</Zip>
        </CouponListResponse>
      </List>
      <TotalRecords>1</TotalRecords>
    </d2p1:CouponResponse>
    <d2p1:DealResponse>
      <d2p1:DealList>
        <d2p1:APIDeal>
          <d2p1:Category>sample string 7</d2p1:Category>
          <d2p1:CategoryId xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:long>1</d6p1:long>
            <d6p1:long>2</d6p1:long>
          </d2p1:CategoryId>
          <d2p1:Description>sample string 5</d2p1:Description>
          <d2p1:EndDate>2026-01-15T01:08:00.9020598+00:00</d2p1:EndDate>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:IsFavorite>true</d2p1:IsFavorite>
          <d2p1:IsFeatrureList>true</d2p1:IsFeatrureList>
          <d2p1:LocationId>1</d2p1:LocationId>
          <d2p1:LocationTitle>sample string 3</d2p1:LocationTitle>
          <d2p1:Logo>sample string 4</d2p1:Logo>
          <d2p1:MemberId>1</d2p1:MemberId>
          <d2p1:PromoCode>sample string 10</d2p1:PromoCode>
          <d2p1:PromoLink>sample string 9</d2p1:PromoLink>
          <d2p1:StartDate>2026-01-15T01:08:00.9020598+00:00</d2p1:StartDate>
          <d2p1:Title>sample string 2</d2p1:Title>
        </d2p1:APIDeal>
        <d2p1:APIDeal>
          <d2p1:Category>sample string 7</d2p1:Category>
          <d2p1:CategoryId xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:long>1</d6p1:long>
            <d6p1:long>2</d6p1:long>
          </d2p1:CategoryId>
          <d2p1:Description>sample string 5</d2p1:Description>
          <d2p1:EndDate>2026-01-15T01:08:00.9020598+00:00</d2p1:EndDate>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:IsFavorite>true</d2p1:IsFavorite>
          <d2p1:IsFeatrureList>true</d2p1:IsFeatrureList>
          <d2p1:LocationId>1</d2p1:LocationId>
          <d2p1:LocationTitle>sample string 3</d2p1:LocationTitle>
          <d2p1:Logo>sample string 4</d2p1:Logo>
          <d2p1:MemberId>1</d2p1:MemberId>
          <d2p1:PromoCode>sample string 10</d2p1:PromoCode>
          <d2p1:PromoLink>sample string 9</d2p1:PromoLink>
          <d2p1:StartDate>2026-01-15T01:08:00.9020598+00:00</d2p1:StartDate>
          <d2p1:Title>sample string 2</d2p1:Title>
        </d2p1:APIDeal>
      </d2p1:DealList>
      <d2p1:TotalRecords>1</d2p1:TotalRecords>
    </d2p1:DealResponse>
  </Data>
  <Message>sample string 1</Message>
  <Status>Continue</Status>
</APICommonWrapperOfAPIGetDealsAndCouponsListResponseMTRdQN6P>