ClubReady Api

<back to all web services

GetSalesPackagesRequest

The following routes are available for this service:
GET/sales/packagesGet Available packages for a chain or store
GetSalesPackagesRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdquerystringYesID # of store to get packages for
UserIdqueryintegerNoID # of the user to get packages for
CreditFilterTypequeryintegerNoThe filter type which will used for packages credit (Class = 1, ClassSchedule = 2, SessionSize = 3)
CreditFilterIdqueryintegerNoClassId or ClassScheduleId or SessionSizeId packages which drop credits
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
InAppquerystringNoShow packages enabled for In App purchase. True or False
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ChainIdformint?No
ApiKeyformstringNo
StoreIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /sales/packages HTTP/1.1 
Host: www.clubready.com 
Accept: text/csv