Cdn API - CPG Source

<back to all web services

WebCouponRequests

Cdn.Api

The following routes are available for this service:
GET,POST,PUT,DELETE/WebCouponRequest
WebCouponRequests Parameters:
NameParameterData TypeRequiredDescription
ValidOnlybodyboolNo
FutureOnlybodyboolNo
ShowDeletedbodybool?No
SkipbodyintNo
TakebodyintNo
CouponNamebodystringNo
CouponCodebodystringNo
FixedDiscountbodydecimalNo
PercentageDiscountbodydecimalNo
ValidStartDatebodyDateTime?No
ValidEndDatebodyDateTime?No
IsSingleUsebodyboolNo
AllowRecurringbodyboolNo
AllowNonRecurringbodyboolNo
ValidProductCategoriesbodystringNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
WebCouponResponses Parameters:
NameParameterData TypeRequiredDescription
DataformList<WebCouponDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
WebCouponDto Parameters:
NameParameterData TypeRequiredDescription
CouponNameformstringNo
CouponCodeformstringNo
FixedDiscountformdecimalNo
PercentageDiscountformdecimalNo
ValidStartDateformDateTimeNo
ValidStartDateDisplayformstringNo
ValidEndDateformDateTimeNo
ValidEndDateDisplayformstringNo
IsSingleUseformboolNo
AllowRecurringformboolNo
AllowNonRecurringformboolNo
ValidProductCategoriesformstringNo
DtoBase Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
WebCouponResponses Parameters:
NameParameterData TypeRequiredDescription
DataformList<WebCouponDto>No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /WebCouponRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ValidOnly":false,"FutureOnly":false,"ShowDeleted":false,"Skip":0,"Take":0,"CouponName":"String","CouponCode":"String","FixedDiscount":0,"PercentageDiscount":0,"ValidStartDate":"\/Date(-62135596800000-0000)\/","ValidEndDate":"\/Date(-62135596800000-0000)\/","IsSingleUse":false,"AllowRecurring":false,"AllowNonRecurring":false,"ValidProductCategories":"String","Id":0,"OrderBy":["String"],"OrderDirections":["Asc"]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Data":[{"CouponName":"String","CouponCode":"String","FixedDiscount":0,"PercentageDiscount":0,"ValidStartDate":"\/Date(-62135596800000-0000)\/","ValidStartDateDisplay":"String","ValidEndDate":"\/Date(-62135596800000-0000)\/","ValidEndDateDisplay":"String","IsSingleUse":false,"AllowRecurring":false,"AllowNonRecurring":false,"ValidProductCategories":"String","Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"}],"Total":0,"OpCode":0,"ErrorText":"String","RequestTime":"String","ResponseTime":"String","TotalExecutionTime":"String","CachedResponse":false}