PUT api/coupon/getcouponlist

Request Information

URI Parameters

None.

Body Parameters

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

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<CouponRequest 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 6</LanguageCode>
  <LocationId>7</LocationId>
  <PageNumber>3</PageNumber>
  <PageSize>4</PageSize>
  <SearchText>sample string 5</SearchText>
</CouponRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APICommonWrapperOfCouponResponse

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

Response Formats

application/json, text/json

Sample:

{
  "Status": 100,
  "Message": "sample string 1",
  "Data": {
    "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-16T04:33:17.3701203+00:00",
        "EndDate": "2026-01-16T04:33:17.3701203+00:00",
        "IsDefaultCoupon": true,
        "CouponProgramId": 13,
        "CouponProgramDescription": "sample string 14",
        "NextCouponRedeemDate": "2026-01-16T04:33:17.3701203+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-16T04:33:17.3701203+00:00",
        "EndDate": "2026-01-16T04:33:17.3701203+00:00",
        "IsDefaultCoupon": true,
        "CouponProgramId": 13,
        "CouponProgramDescription": "sample string 14",
        "NextCouponRedeemDate": "2026-01-16T04:33:17.3701203+00:00"
      }
    ],
    "TotalRecords": 1
  }
}

application/xml, text/xml

Sample:

<APICommonWrapperOfCouponResponseZdSfSp5S xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <Data>
    <List>
      <CouponListResponse>
        <City i:nil="true" />
        <CouponProgramDescription>sample string 14</CouponProgramDescription>
        <CouponProgramId>13</CouponProgramId>
        <Description>sample string 10</Description>
        <EndDate>2026-01-16T04:33:17.3701203+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-16T04:33:17.3701203+00:00</NextCouponRedeemDate>
        <StartDate>2026-01-16T04:33:17.3701203+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-16T04:33:17.3701203+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-16T04:33:17.3701203+00:00</NextCouponRedeemDate>
        <StartDate>2026-01-16T04:33:17.3701203+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>
  </Data>
  <Message>sample string 1</Message>
  <Status>Continue</Status>
</APICommonWrapperOfCouponResponseZdSfSp5S>