Cdn API - CPG Source

WebCouponRequests

Cdn.Api

**WebCouponRequests** Parameters:
Name	Parameter	Data Type	Required
ValidOnly	body	bool	No
FutureOnly	body	bool	No
ShowDeleted	body	bool?	No
Skip	body	int	No
Take	body	int	No
CouponName	body	string	No
CouponCode	body	string	No
FixedDiscount	body	decimal	No
PercentageDiscount	body	decimal	No
ValidStartDate	body	DateTime?	No
ValidEndDate	body	DateTime?	No
IsSingleUse	body	bool	No
AllowRecurring	body	bool	No
AllowNonRecurring	body	bool	No
ValidProductCategories	body	string	No

**BaseRequest<T>** Parameters:
Name	Parameter	Data Type	Required
Id	form	long?	No
OrderBy	form	string[]	No
OrderDirections	form	SortOrders[]	No

**WebCouponResponses** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<WebCouponDto>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
Total	form	int	No
OpCode	form	int	No
ErrorText	form	string	No
RequestTime	form	string	No
ResponseTime	form	string	No
TotalExecutionTime	form	string	No
CachedResponse	form	bool	No

**WebCouponDto** Parameters:
Name	Parameter	Data Type	Required
CouponName	form	string	No
CouponCode	form	string	No
FixedDiscount	form	decimal	No
PercentageDiscount	form	decimal	No
ValidStartDate	form	DateTime	No
ValidStartDateDisplay	form	string	No
ValidEndDate	form	DateTime	No
ValidEndDateDisplay	form	string	No
IsSingleUse	form	bool	No
AllowRecurring	form	bool	No
AllowNonRecurring	form	bool	No
ValidProductCategories	form	string	No

**DtoBase** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Active	form	bool	No
LastMod	form	DateTime	No
LastModBy	form	string	No

**WebCouponResponses** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<WebCouponDto>	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .soap11 suffix or ?format=soap11

HTTP + SOAP11

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /soap11 HTTP/1.1 
Host: cdnapidev.greysheet.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: WebCouponRequests

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<WebCouponRequests xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.RequestObjects">
  <Id>0</Id>
  <OrderBy xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OrderBy>
  <OrderDirections>
    <SortOrders>Asc</SortOrders>
  </OrderDirections>
  <AllowNonRecurring>false</AllowNonRecurring>
  <AllowRecurring>false</AllowRecurring>
  <CouponCode>String</CouponCode>
  <CouponName>String</CouponName>
  <FixedDiscount>0</FixedDiscount>
  <FutureOnly>false</FutureOnly>
  <IsSingleUse>false</IsSingleUse>
  <PercentageDiscount>0</PercentageDiscount>
  <ShowDeleted>false</ShowDeleted>
  <Skip>0</Skip>
  <Take>0</Take>
  <ValidEndDate>0001-01-01T00:00:00</ValidEndDate>
  <ValidOnly>false</ValidOnly>
  <ValidProductCategories>String</ValidProductCategories>
  <ValidStartDate>0001-01-01T00:00:00</ValidStartDate>
</WebCouponRequests>

    </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<WebCouponResponses xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.ResponseObjects">
  <CachedResponse>false</CachedResponse>
  <ErrorText>String</ErrorText>
  <OpCode>0</OpCode>
  <RequestTime>String</RequestTime>
  <ResponseTime>String</ResponseTime>
  <Total>0</Total>
  <TotalExecutionTime>String</TotalExecutionTime>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.Api.Dto">
    <d2p1:WebCouponDto>
      <d2p1:_x003C_Active_x003E_k__BackingField>false</d2p1:_x003C_Active_x003E_k__BackingField>
      <d2p1:_x003C_Id_x003E_k__BackingField>0</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_LastModBy_x003E_k__BackingField>String</d2p1:_x003C_LastModBy_x003E_k__BackingField>
      <d2p1:_x003C_LastMod_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastMod_x003E_k__BackingField>
      <d2p1:AllowNonRecurring>false</d2p1:AllowNonRecurring>
      <d2p1:AllowRecurring>false</d2p1:AllowRecurring>
      <d2p1:CouponCode>String</d2p1:CouponCode>
      <d2p1:CouponName>String</d2p1:CouponName>
      <d2p1:FixedDiscount>0</d2p1:FixedDiscount>
      <d2p1:IsSingleUse>false</d2p1:IsSingleUse>
      <d2p1:PercentageDiscount>0</d2p1:PercentageDiscount>
      <d2p1:ValidEndDate>0001-01-01T00:00:00</d2p1:ValidEndDate>
      <d2p1:ValidEndDateDisplay>String</d2p1:ValidEndDateDisplay>
      <d2p1:ValidProductCategories>String</d2p1:ValidProductCategories>
      <d2p1:ValidStartDate>0001-01-01T00:00:00</d2p1:ValidStartDate>
      <d2p1:ValidStartDateDisplay>String</d2p1:ValidStartDateDisplay>
    </d2p1:WebCouponDto>
  </Data>
</WebCouponResponses>

    </soap:Body>
</soap:Envelope>