Sparkfly Platform API Documentation

Main
Getting Started
Credentials In Depth

Sparkfly Platform API Documentation

Sparkfly Platform API Documentation

Main
Getting Started
Credentials In Depth

Account
Disable Callbacks
Enable Callbacks
Update Account
View Account

Channels
Create Channel
Delete Channel
List Channels
Retrieve Channel
Update Channel

Counters
Create Counter
Delete Counter
List Counters
Retrieve Counter
Update Counter

Credentials
Attempting to update a locked credential
Create Credential
Delete Credential
Determine if a member is eligible for an offer
List Credentials
List Credentials by Member, Offer & Store
List Credentials for a Member
List Credentials for a Member and Offer
List Credentials for an Offer
Redeem Credential
Retrieve Credential
Update Credential
Update Credential (remove offers)
Void Credential

Events
Create Event
Delete Event
List Events
Retrieve Event
Update Event

Impressions
Create Impression
Delete Impression
List Impressions

Item Sets
Delete Item Set

Items
Create Item
Get Items for Item Set
List Items
Retrieve Item
Search for Items by Code
Search for Items by Name
Update Item

Loyalty Points
Check Card Status
Transfer Loyalty Points

Manufacturers
Create Item
Create Manufacturer
Delete Item Set
Delete Manufacturer
Eligible Merchants Add
Eligible Merchants List
Eligible Merchants Remove
Eligible Merchants Set
Get Items for Item Set
List Items
List Manufacturers
Retrieve Item
Retrieve Manufacturer
Update Item
Update Manufacturer

Member Lists
Create Member List
Delete Member List
List Member Lists
Retrieve Member List
Update Member List

Member Lists/Members
Eligible Members Add
Eligible Members List
Eligible Members Remove
Eligible Members Set

Members
Create Member
Delete Member
List Members
Retrieve Member
Update Member

Members/Offers
Answer correctly for Started Member
Answer correctly for Unstarted Member
Answer incorrectly for Started Member
Answer incorrectly for Unstarted Member

Merchants
Create Item
Create Merchant
Delete Item Set
Delete Merchant
Get Items for Item Set
List Items
List Merchants
List Offers for Merchant
Retrieve Item
Retrieve Merchant
Search for Items by Code
Search for Items by Name
Search for Merchant by Name
Update Item
Update Merchant

Merchants/StoreLists
Create Store List
Delete Store List
Eligible Stores Add
Eligible Stores List
Eligible Stores Remove
Eligible Stores Set
Filter Eligible Stores by Name
List Store Lists
Retrieve Store List
Stores for Merchant Store List (detailed)
Update Store List

Merchants/Stores
Create Store
Delete Store
Get and Filter Stores WITH Active Offers (stores/index)
Get and Filter Stores WITH Active Offers (stores/nearby/:lat/:lng/index)
Get and Filter Stores WITH Active Offers (stores/nearby/index)
List Offer IDs for Merchant and Store
List Stores for Merchant
Retrieve Store
Retrieve Store without Merchant ID
Search for Stores
Update Store

Offer Engine
Check-In Member to Store
Retrieve Offer Activities for Member
Retrieve Redeemed Redemptions for Member
Retrieve Redeemed Redemptions for Member for Store
Retrieve Store for Member

Pos Offer Codes
List PosOfferCodes
Retrieve PosOfferCode

Reports
Get Report Data
Get Report Data for all merchants
Get Unique Impressions

Search
Search for Member by Identifier

Zidentifiers
Create an identifier linking Offer, Member, Channel
Retrieve Zidentifier

Sparkfly Platform API

Version 1.0

Click on a link to the left to load documentation.