GET,POST,PUT,DELETE | /WebCouponRequest |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long? | No | |
OrderBy | form | string[] | No | |
OrderDirections | form | SortOrders[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Data | form | List<WebCouponDto> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
Active | form | bool | No | |
LastMod | form | DateTime | No | |
LastModBy | form | string | No |
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 .csv suffix or ?format=csv
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-cdnx.greysheet.com
Accept: text/csv
Content-Type: text/csv
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: text/csv 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}