GET api/coupon?code={code}

Request Information

URI Parameters

Name	Description	Type	Additional information
code		string	Required

Body Parameters

None.

Response Information

Resource Description

Coupon

Name	Type	Additional information
ID	integer	None.
Name	string	Required
Description	string	None.
Code	string	Required
Active	boolean	None.
CreatedDate	date	None.
TypeID	integer	Required
Type	CouponType	None.
Amount	decimal number	Required
ExpiryDate	date	None.
MaxVouchers	integer	None.
MaxUsePerVoucher	integer	Required
MinCost	decimal number	None.
CanCombine	boolean	None.
IsFishboxOrder	boolean	None.
IsProduct	boolean	None.
IsSpecialOffer	boolean	None.
ConfirmationDescription	string	Max length: 500
ConfirmationMailDescription	string	Max length: 500
IsManual	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Code": "sample string 4",
  "Active": true,
  "CreatedDate": "2025-05-11T11:57:02.0046527+00:00",
  "TypeID": 7,
  "Type": {
    "ID": 1,
    "Name": "sample string 2",
    "Active": true
  },
  "Amount": 8.0,
  "ExpiryDate": "2025-05-11T11:57:02.0046527+00:00",
  "MaxVouchers": 1,
  "MaxUsePerVoucher": 9,
  "MinCost": 1.0,
  "CanCombine": true,
  "IsFishboxOrder": true,
  "IsProduct": true,
  "IsSpecialOffer": true,
  "ConfirmationDescription": "sample string 14",
  "ConfirmationMailDescription": "sample string 15",
  "IsManual": true
}

application/xml, text/xml

Sample:

<Coupon xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/cag.Data.Coupons">
  <Active>true</Active>
  <Amount>8</Amount>
  <CanCombine>true</CanCombine>
  <Code>sample string 4</Code>
  <ConfirmationDescription>sample string 14</ConfirmationDescription>
  <ConfirmationMailDescription>sample string 15</ConfirmationMailDescription>
  <CreatedDate>2025-05-11T11:57:02.0046527+00:00</CreatedDate>
  <Description>sample string 3</Description>
  <ExpiryDate>2025-05-11T11:57:02.0046527+00:00</ExpiryDate>
  <ID>1</ID>
  <IsFishboxOrder>true</IsFishboxOrder>
  <IsManual>true</IsManual>
  <IsProduct>true</IsProduct>
  <IsSpecialOffer>true</IsSpecialOffer>
  <MaxUsePerVoucher>9</MaxUsePerVoucher>
  <MaxVouchers>1</MaxVouchers>
  <MinCost>1</MinCost>
  <Name>sample string 2</Name>
  <Type>
    <Active>true</Active>
    <ID>1</ID>
    <Name>sample string 2</Name>
  </Type>
  <TypeID>7</TypeID>
</Coupon>