GET api/General/Offer/GetCustOfferList?PageNo={PageNo}&PageSize={PageSize}&SearchTerm={SearchTerm}&ByDate={ByDate}&PartnerID={PartnerID}&AdminAddedOnly={AdminAddedOnly}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| PageNo | integer |
Required |
|
| PageSize | integer |
Required |
|
| SearchTerm | string |
Required |
|
| ByDate | date |
Required |
|
| PartnerID | string |
Required |
|
| AdminAddedOnly | boolean |
Required |
Body Parameters
None.
Response Information
Resource Description
CustomerOfferApiVM| Name | Description | Type | Additional information |
|---|---|---|---|
| CustOfferDetailList | Collection of CustomerOfferModel |
None. |
|
| TotalRecords | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"CustOfferDetailList": [
{
"CouponID": "sample string 1",
"Title": "sample string 2",
"Description": "sample string 3",
"LongDesc": "sample string 4",
"OfferCode": "sample string 5",
"OfferPercent": 1,
"OfferMaxAmt": 6.0,
"MinTransAmt": 7.0,
"OfferType": "sample string 8",
"ValidFrom": "2025-12-07T09:58:49.8058554+05:30",
"ValidUpto": "2025-12-07T09:58:49.8058554+05:30",
"IsCustomerSpecific": true,
"OfferedByPartner": true,
"PartnerID": "sample string 13",
"UserID": "sample string 14",
"TransDate": "2025-12-07T09:58:49.8058554+05:30",
"IsRedeemed": true,
"CustList": [
"sample string 1",
"sample string 2"
]
},
{
"CouponID": "sample string 1",
"Title": "sample string 2",
"Description": "sample string 3",
"LongDesc": "sample string 4",
"OfferCode": "sample string 5",
"OfferPercent": 1,
"OfferMaxAmt": 6.0,
"MinTransAmt": 7.0,
"OfferType": "sample string 8",
"ValidFrom": "2025-12-07T09:58:49.8058554+05:30",
"ValidUpto": "2025-12-07T09:58:49.8058554+05:30",
"IsCustomerSpecific": true,
"OfferedByPartner": true,
"PartnerID": "sample string 13",
"UserID": "sample string 14",
"TransDate": "2025-12-07T09:58:49.8058554+05:30",
"IsRedeemed": true,
"CustList": [
"sample string 1",
"sample string 2"
]
}
],
"TotalRecords": 1
}
application/xml, text/xml
Sample:
<CustomerOfferApiVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/General.Operations.CustomModels">
<CustOfferDetailList>
<CustomerOfferModel>
<CouponID>sample string 1</CouponID>
<CustList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</CustList>
<Description>sample string 3</Description>
<IsCustomerSpecific>true</IsCustomerSpecific>
<IsRedeemed>true</IsRedeemed>
<LongDesc>sample string 4</LongDesc>
<MinTransAmt>7</MinTransAmt>
<OfferCode>sample string 5</OfferCode>
<OfferMaxAmt>6</OfferMaxAmt>
<OfferPercent>1</OfferPercent>
<OfferType>sample string 8</OfferType>
<OfferedByPartner>true</OfferedByPartner>
<PartnerID>sample string 13</PartnerID>
<Title>sample string 2</Title>
<TransDate>2025-12-07T09:58:49.8058554+05:30</TransDate>
<UserID>sample string 14</UserID>
<ValidFrom>2025-12-07T09:58:49.8058554+05:30</ValidFrom>
<ValidUpto>2025-12-07T09:58:49.8058554+05:30</ValidUpto>
</CustomerOfferModel>
<CustomerOfferModel>
<CouponID>sample string 1</CouponID>
<CustList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</CustList>
<Description>sample string 3</Description>
<IsCustomerSpecific>true</IsCustomerSpecific>
<IsRedeemed>true</IsRedeemed>
<LongDesc>sample string 4</LongDesc>
<MinTransAmt>7</MinTransAmt>
<OfferCode>sample string 5</OfferCode>
<OfferMaxAmt>6</OfferMaxAmt>
<OfferPercent>1</OfferPercent>
<OfferType>sample string 8</OfferType>
<OfferedByPartner>true</OfferedByPartner>
<PartnerID>sample string 13</PartnerID>
<Title>sample string 2</Title>
<TransDate>2025-12-07T09:58:49.8058554+05:30</TransDate>
<UserID>sample string 14</UserID>
<ValidFrom>2025-12-07T09:58:49.8058554+05:30</ValidFrom>
<ValidUpto>2025-12-07T09:58:49.8058554+05:30</ValidUpto>
</CustomerOfferModel>
</CustOfferDetailList>
<TotalRecords>1</TotalRecords>
</CustomerOfferApiVM>