Offer Network API

Note: Every call made to the v2 API’s must be made via the signed URL process. Any request without a valid signature will be rejected. Note the domain for this call is management.kouponmedia.com and not consumer.kouponmedia.com.

Get Offer Available Locations

Retrieves all of the Locations (stores) that are available at which to redeem the indicated Offer. The default is to only include Locations associated with subscriptions to the Offer.

GEThttp://consumer.kouponmedia.com/consumer_id/offers/offer_id/locations

Query Parameters

Parameter Required/Optional Description
lat required Latitude of location, in degrees, to search for stores near.
lon required Latitude of location, in degrees, to search for stores near.
radius required Radius, in miles, around the given lat/lon to search for nearby stores. Can be specified with fractional value (e.g. “2.5”).
limit optional A limit to the number of nearby stores to return within the radius. Optional; a negative value indicates no limit, a value of 0 will default to 20.
include_own required Radius, in miles, around the given lat/lon to search for nearby stores. Can be specified with fractional value (e.g. “2.5”).
exclude_sub optional A flag indicating whether the Locations for subscribing Retailer Account(s) should be excluded (1) or not (0). Ignored unless include_own=1.

Response Parameters

Parameter Description
retailerName The name of the Retailer that owns the Channel.
retailerId The numeric Id of the Retailer Account that owns the Channel.
storeName The name of the Store.
latitude, longitude The coordinates of the Store location.
distance The distance, in miles, between the reference location and the location of the Store.
street The street address of the Store location.
city The city of the Store location.
state The state/province of the Store location.
zip The ZIP code/Postal Code of the Store location.

Example Response

    
{
    "code": 200,
    "message": "success",
    "version": "2.1",
    "locations": [
        {
            retailerName:  String,
            retailerId:  Number,
            storeName:  String,
            latitude:  Float,
            longitude:  Float,
            distance:  Float,
            street:  String,
            city:  String,
            state:  String,
            zip: String
        },  ...
    ]
}
    

Get Offer Available Channels

Retrieves all of the Channels that are available on which to redeem the indicated Offer. The default is to only include Channels associated with subscriptions to the Offer.
NOTE: This API requires that the Consumer identified by consumer_id has been registered with a Primary identity key.

GEThttp://consumer.kouponmedia.com/consumer_id/offers/offer_id/channels

Query Parameters

Parameter Required/Optional Description
include_own required Radius, in miles, around the given lat/lon to search for nearby stores. Can be specified with fractional value (e.g. “2.5”).
exclude_sub optional A flag indicating whether the Locations for subscribing Retailer Account(s) should be excluded (1) or not (0). Ignored unless include_own=1.

Response Parameters

Parameter Description
retailerName The name of the Retailer that owns the Channel.
retailerId The numeric Id of the Retailer Account that owns the Channel.
channelImage The absolute URL to subscribed channel’s image on the CDN.
channelName The name of the Channel.
channelId The string identifier of the Channel of the Retailer.
channelType The type of the Channel, one of “App” or “Web”.
offerViewerURL The fully qualified URL of the OfferViewer to access the Offer in the Channel of the Retailer.

Example Response

    
{
    "code": 200,
    "message": "success",
    "version": "2.1",
    "channels": [
        {
            retailerName:  String,
            retailerId:  Number,
            channelImage:  URLString,
            channelName:  String,
            channelId:  String,
            channelType:  String,
            offerViewerURL:  URLString
        },  ...
    ]
}
    

Deliver Network Offer

Allows a Publishing (Brand) Account to deliver a Published Network Offer to an identified Consumer in a Subscriber (Retailer) Account in the form of an SMS text message. The indicated Subscriber Account MUST be subscribed to the Offer (i.e. has a Subscribed Offer corresponding to the Published Offer). If a Consumer does not exist in the Subscribing Account for the given mobile number, one will be created. If the Published Offer is configured as a Private offer, an instance of the corresponding Subscribed Offer will be added to the Subscribing Account before the Offer is delivered to the Consumer via SMS.

POSThttp://management.kouponmedia.com/offernet/offer_id/deliver/account_id? mobileNumber=mobile_number

Path and Query Parameters

Parameter Required/Optional Description
offer_id required in path The numeric Id of a Published Offer in the calling Publisher Account to deliver to the Consumer within the Subscribing Account.
accountId required in path The numeric Id of the Subscriber Account to Deliver the Subscribed Offer to.
mobile_number required The 10-digit mobile phone number of the Consumer to deliver the Offer to.
sub_channel_code optional Channel Code of Subscriber Channel to use for the message. The Subscribed Offer(s) must be associated with the Channel. If not specified, the first applicable Channel will be chosen.

Example Response

    
{
    "code": 200,
    "message": "success",
    "version": "2.1",
}