ClubReady Api

<back to all web services

GetSalesPackageRequest

The following routes are available for this service:
GET/sales/package/{PackageId}Get sales package details
GetSalesPackageRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdquerystringNoID # of store to get package details for.
Either StoreId or ChainId is required
ChainIdquerystringNoID # of chain to get package details for.
Either StoreId or ChainId is required
PackageIdpathstringYesID # of package to get details for
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
GetSalesPackageRequestDto Parameters:
NameParameterData TypeRequiredDescription
PackageIdformintNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined

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

HTTP + JSV

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

GET /sales/package/{PackageId} HTTP/1.1 
Host: clubready.com 
Accept: text/jsv