ApexERPHost

GetCoupon

Get discount coupons

The following routes are available for this service:
GET	/Coupons/{Code}

**GetCoupon** Parameters:
Name	Parameter	Data Type	Required	Description
Code	path	string	Yes

**GetCouponResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Coupon	form	Coupon	No

**Coupon** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Code	form	string	No
CouponType	form	int	No
ExpirationDate	form	DateTime	No
Voided	form	bool	No
Used	form	bool	No
UseTime	form	DateTime?	No
Data	form	CouponData	No
CouponStatus	form	int?	No
ActivateId	form	Guid?	No
SpendId	form	Guid?	No
CheckSumFrom	form	decimal?	No
CheckSumTo	form	decimal?	No
DiscountAmountLimit	form	decimal?	No
DiscountSumLimit	form	decimal?	No
SingleCouponPerCheck	form	int?	No

**CouponData** Parameters:
Name	Parameter	Data Type	Required	Description
Prods	form	List<CouponProd>	No

**CouponProd** Parameters:
Name	Parameter	Data Type	Required
ProdId	form	string	No
IsService	form	int	No
Type	form	int	No
SCount	form	decimal	No
ValueType	form	int	No
Value	form	decimal	No
SCountAdditive	form	decimal	No

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

HTTP + XML

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

GET /Coupons/{Code} HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/xml

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

<GetCouponResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Warehousing">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Coupon>
    <Id>0</Id>
    <Code>String</Code>
    <CouponType>0</CouponType>
    <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
    <Voided>false</Voided>
    <Used>false</Used>
    <UseTime>0001-01-01T00:00:00</UseTime>
    <Data>
      <Prods>
        <CouponProd>
          <ProdId>String</ProdId>
          <IsService>0</IsService>
          <Type>0</Type>
          <SCount>0</SCount>
          <ValueType>0</ValueType>
          <Value>0</Value>
          <SCountAdditive>0</SCountAdditive>
        </CouponProd>
      </Prods>
    </Data>
    <CouponStatus>0</CouponStatus>
    <ActivateId>00000000-0000-0000-0000-000000000000</ActivateId>
    <SpendId>00000000-0000-0000-0000-000000000000</SpendId>
    <CheckSumFrom>0</CheckSumFrom>
    <CheckSumTo>0</CheckSumTo>
    <DiscountAmountLimit>0</DiscountAmountLimit>
    <DiscountSumLimit>0</DiscountSumLimit>
    <SingleCouponPerCheck>0</SingleCouponPerCheck>
  </Coupon>
</GetCouponResponse>