API Documentation

API Call - getDeals

Description

This call gets information about deals. Filter by deal-id to look up one deal, publisher-id to look up all deals by a particular publisher, or store-id to look up deals from a store.

Parameters

Param Required? Description
pid yes your chompon publisher-id
auth yes your chompon authentication-key
type no either JSON or XML. default is XML
sid no store-id
did no deal-id
ctipped no "true" or "false" - the API call should return if the deal has been tipped yet
getzips no "true" or "false" - the API call should return the zip codes assigned for the deal

Examples

Get information about a particular deal:
https://www.chompon.com/api.php?pid=12&auth=26a4171b3c38b868&method=getDeals&did=987&type=xml

Get information about all of a store's deals:
https://www.chompon.com/api.php?pid=12&auth=26a4171b3c38b868&method=getDeals&sid=4&type=xml

© 2010 ChompOn, Inc.

Please enter your email and password.

or Sign Up!