GET rest/coupons?couponUsage={couponUsage}

Gets a list of coupon links (Supports OData 4.0).

Request Information

URI Parameters

NameDescriptionTypeAdditional information
couponUsage

Valid for coupons only. If set, returns only coupons that has the given coupon usage.

 CouponUsage

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Link
NameDescriptionTypeAdditional information
Id

Id of coupon or coupon book, must be unique.

 globally unique identifier

None.
Version

Coupon/coupon book version.

 byte

None.
Type

COUPON or COUPON_BOOK

 string

None.
IsInCouponBook

Whether coupon is part of a coupon book.

 boolean

None.
Name

Name of coupon.

 string

None.
Description

Description of coupon.

 string

None.
created

When it was created.

 date

None.
From

When coupon is activated

 date

None.
To

When coupon is deactivated

 date

None.
Count

For coupon books: Number of coupons attached.

 integer

None.
UniqueViews

WARNING! This property is obsolete. Please use UniqueCouponViews or AggregatedUniqueCouponViews. This field will be removed in a future version of the API. Number of unique views. For coupons, this is the unique views of the given coupon. For coupon books, this is the aggregated number of views of the underlying coupons in the coupon book.

 integer

None.
AggregatedTotalCouponViews

Gets or sets the total views for all coupons in a coupon book. Only set for coupon books.

 integer

None.
TotalCouponViews

Gets or sets the total number of views for a coupon. Only set for coupons.

 integer

None.
UniqueCouponViews

Gets or sets the number of unique views for a coupon. Only set for coupons.

 integer

None.
AggregatedUniqueCouponViews

Gets or sets the sum of unique views for all coupons in a coupon book. Only set for coupon books.

 integer

None.
TotalCouponBookViews

Gets or sets the total number of views for a coupon book. Only set for coupon books.

 integer

None.
UniqueCouponBookViews

Gets or sets the number of unique views for a coupon book. Only set for coupon books.

 integer

None.
UniqueRedemptions

WARNING! This property is obsolete. Please use UniqueCouponRedemptions or AggregatedUniqueCouponRedemptions. This field will be removed in a future version of the API. Gets or sets the number of unique redemptions. For coupons, this is the unique number of redemptions for the coupon. For coupon books, this is the the sum of the unique number of redemptions for all connected coupons.

 integer

None.
GeneratedCount

Number of generated coupons.

 integer

None.
AggregatedTotalCouponRedemptions

Gets or sets the toal sum of redemptions for all coupons in a coupon book. Only set for coupon books.

 integer

None.
TotalCouponRedemptions

Gets or sets the total number of redemptions for a coupon. Only set for coupons.

 integer

None.
AggregatedUniqueCouponRedemptions

Gets or sets the sum of unique redemptions for all coupons in a coupon book. Only set for coupon books.

 integer

None.
UniqueCouponRedemptions

Gets or sets the number of unique redemptions for a coupon. Only set for coupons.

 integer

None.
Href

URL to coupon.

 string

None.
RecipientCount

Nr of recipients for coupon / couponbook

 integer

None.
IsActive

Dynamically assigned value for active coupons/coupon books

 boolean

None.
IsExpired

Dynamically assigned value for expired coupons/coupon books

 boolean

None.
IsActiveSoon

Dynamically assigned value for coupons/coupon books that are active soon

 boolean

None.
ViewRatio

View ratio of coupon

 decimal number

None.
RedeemRatio

Redeem ratio of coupon

 decimal number

None.
Shared

Flag if coupon is shared with sub-partners

 boolean

None.
SharedWithMe

Flag if coupon is by parent partner

 boolean

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "id": "8c6a9a52-7c5b-49f4-8b40-01682d51eb41",
    "version": 64,
    "type": "sample string 3",
    "isInCouponBook": true,
    "name": "sample string 5",
    "description": "sample string 6",
    "created": 1659830345305,
    "from": "2022-08-06T23:59:05.3056634Z",
    "to": "2022-08-06T23:59:05.3056634Z",
    "count": 1,
    "uniqueViews": 1,
    "aggregatedTotalCouponViews": 1,
    "totalCouponViews": 1,
    "uniqueCouponViews": 1,
    "aggregatedUniqueCouponViews": 1,
    "totalCouponBookViews": 1,
    "uniqueCouponBookViews": 1,
    "uniqueRedemptions": 1,
    "generatedCount": 1,
    "aggregatedTotalCouponRedemptions": 1,
    "totalCouponRedemptions": 1,
    "aggregatedUniqueCouponRedemptions": 1,
    "uniqueCouponRedemptions": 1,
    "href": "sample string 8",
    "recipientCount": 1,
    "isActive": true,
    "isExpired": true,
    "isActiveSoon": true,
    "viewRatio": 1.0,
    "redeemRatio": 12.0,
    "shared": true,
    "sharedWithMe": true
  },
  {
    "id": "8c6a9a52-7c5b-49f4-8b40-01682d51eb41",
    "version": 64,
    "type": "sample string 3",
    "isInCouponBook": true,
    "name": "sample string 5",
    "description": "sample string 6",
    "created": 1659830345305,
    "from": "2022-08-06T23:59:05.3056634Z",
    "to": "2022-08-06T23:59:05.3056634Z",
    "count": 1,
    "uniqueViews": 1,
    "aggregatedTotalCouponViews": 1,
    "totalCouponViews": 1,
    "uniqueCouponViews": 1,
    "aggregatedUniqueCouponViews": 1,
    "totalCouponBookViews": 1,
    "uniqueCouponBookViews": 1,
    "uniqueRedemptions": 1,
    "generatedCount": 1,
    "aggregatedTotalCouponRedemptions": 1,
    "totalCouponRedemptions": 1,
    "aggregatedUniqueCouponRedemptions": 1,
    "uniqueCouponRedemptions": 1,
    "href": "sample string 8",
    "recipientCount": 1,
    "isActive": true,
    "isExpired": true,
    "isActiveSoon": true,
    "viewRatio": 1.0,
    "redeemRatio": 12.0,
    "shared": true,
    "sharedWithMe": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfLink xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.linkmobility.com/common/coupons">
  <Link>
    <AggregatedTotalCouponRedemptions>1</AggregatedTotalCouponRedemptions>
    <AggregatedTotalCouponViews>1</AggregatedTotalCouponViews>
    <AggregatedUniqueCouponRedemptions>1</AggregatedUniqueCouponRedemptions>
    <AggregatedUniqueCouponViews>1</AggregatedUniqueCouponViews>
    <Count>1</Count>
    <Description>sample string 6</Description>
    <From>2022-08-06T23:59:05.3056634+00:00</From>
    <GeneratedCount>1</GeneratedCount>
    <Href>sample string 8</Href>
    <Id>8c6a9a52-7c5b-49f4-8b40-01682d51eb41</Id>
    <IsActive>true</IsActive>
    <IsActiveSoon>true</IsActiveSoon>
    <IsExpired>true</IsExpired>
    <IsInCouponBook>true</IsInCouponBook>
    <Name>sample string 5</Name>
    <RecipientCount>1</RecipientCount>
    <RedeemRatio>12</RedeemRatio>
    <Shared>true</Shared>
    <SharedWithMe>true</SharedWithMe>
    <To>2022-08-06T23:59:05.3056634+00:00</To>
    <TotalCouponBookViews>1</TotalCouponBookViews>
    <TotalCouponRedemptions>1</TotalCouponRedemptions>
    <TotalCouponViews>1</TotalCouponViews>
    <Type>sample string 3</Type>
    <UniqueCouponBookViews>1</UniqueCouponBookViews>
    <UniqueCouponRedemptions>1</UniqueCouponRedemptions>
    <UniqueCouponViews>1</UniqueCouponViews>
    <UniqueRedemptions>1</UniqueRedemptions>
    <UniqueViews>1</UniqueViews>
    <Version>64</Version>
    <ViewRatio>1</ViewRatio>
    <created>2022-08-06T23:59:05.3056634+00:00</created>
  </Link>
  <Link>
    <AggregatedTotalCouponRedemptions>1</AggregatedTotalCouponRedemptions>
    <AggregatedTotalCouponViews>1</AggregatedTotalCouponViews>
    <AggregatedUniqueCouponRedemptions>1</AggregatedUniqueCouponRedemptions>
    <AggregatedUniqueCouponViews>1</AggregatedUniqueCouponViews>
    <Count>1</Count>
    <Description>sample string 6</Description>
    <From>2022-08-06T23:59:05.3056634+00:00</From>
    <GeneratedCount>1</GeneratedCount>
    <Href>sample string 8</Href>
    <Id>8c6a9a52-7c5b-49f4-8b40-01682d51eb41</Id>
    <IsActive>true</IsActive>
    <IsActiveSoon>true</IsActiveSoon>
    <IsExpired>true</IsExpired>
    <IsInCouponBook>true</IsInCouponBook>
    <Name>sample string 5</Name>
    <RecipientCount>1</RecipientCount>
    <RedeemRatio>12</RedeemRatio>
    <Shared>true</Shared>
    <SharedWithMe>true</SharedWithMe>
    <To>2022-08-06T23:59:05.3056634+00:00</To>
    <TotalCouponBookViews>1</TotalCouponBookViews>
    <TotalCouponRedemptions>1</TotalCouponRedemptions>
    <TotalCouponViews>1</TotalCouponViews>
    <Type>sample string 3</Type>
    <UniqueCouponBookViews>1</UniqueCouponBookViews>
    <UniqueCouponRedemptions>1</UniqueCouponRedemptions>
    <UniqueCouponViews>1</UniqueCouponViews>
    <UniqueRedemptions>1</UniqueRedemptions>
    <UniqueViews>1</UniqueViews>
    <Version>64</Version>
    <ViewRatio>1</ViewRatio>
    <created>2022-08-06T23:59:05.3056634+00:00</created>
  </Link>
</ArrayOfLink>