Store Connect Rules

Rules API for Store Connect

Note: Every call made to the Rules API must be made via the signed URL process. Any request without a valid signature will be rejected.

Getting Rules for POS Transactions

To allow POS providers the ability to know when to call Koupon, we provide an optional convenience method which will tell the POS when a response from Koupon Media is required to tender the transaction and when Koupon is needed for analytics. If this method is going to be called, it is recommended that the POS stores this response for only 1 day and makes a nightly refresh.
GEThttp://storeconnect.kouponmedia.com/v1/rules

Example Response

    
{

  "code" : 200,
  "message" : "success",
  "version" : "1",
  "tender" : {

    "binRange": [ {"start": 4000, "end": 5000, "length": 6 }, … ],
      
    "UPCs" : ["333423423423"],
    "everyTransaction" : true | false
    
  },
  "analytics" : {
      
    "binRange" : [ { "start": 4000, "end": 5000, "length": 6 }, … ],
    "UPCs" : ["84393945834", "00003443434"],
    "everyTransaction" : true | false
   
  }

}

Response keys

Key Description
tender All rules within this object inform the POS of what to look for within the basket and if either the binRange, UPCs or every transaction must be sent to Koupon before tendering the transaction. May be an empty set if nothing is required to be sent to Koupon Media before tendering.
tender.binRange An array of objects that contain all of the bin ranges to key off of for sending transaction data to Koupon.
tender.binRange.start The beginning of the bin range.
tender.binRange.end The conclusion of the bin range.
tender.binRange.length How long the bin range will be.
tender.UPCs An array of UPCs that if they are within the transaction, then the entire transaction data must be sent to Koupon before tendering.
tender.everyTransaction A boolean value indicating true if all transactions must be sent to Koupon before tender. A false value indicates that it is not necessary to send Koupon all transaction data. There may be a false value, and a bin Range or UPCs that will still require transaction data to be sent for just those values.
analytics All rules within this object can be sent asynchonously. May be an empty set if nothing is required to be sent to Koupon Media for analytics.
analytics.binRange An array of objects that contain all of the bin ranges to key off of for sending analytics data to Koupon.
analytics.binRange.start The beginning of the bin range.
analytics.binRange.end The conclusion of the bin range.
analytics.binRange.length How long the bin range will be.
analytics.UPCs An array of UPCs that if they are within the transaction, then the entire transaction data must be sent to Koupon at some point for analytics.
analytics.everyTransaction A boolean value indicating true if all transactions must be sent asychonously to Koupon. A false value indicates that it is not necessary to send Koupon all transaction data. There may be a false value, and a bin Range or UPCs that will still require transaction data to be sent for just those values.