<back to all web services
GetSalesPackagesRequest
The following routes are available for this service:| GET | /sales/packages | Get Available packages for a chain or store | |
|---|
GetSalesPackagesRequest Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| XForwardedFor | header | string | No | IP address of the end user |
| ApiKey | query | string | Yes | Api Key - grants access to resources |
| StoreId | query | string | Yes | ID # of store to get packages for |
| UserId | query | integer | No | ID # of the user to get packages for |
| CreditFilterType | query | integer | No | The filter type which will used for packages credit (Class = 1, ClassSchedule = 2, SessionSize = 3) |
| CreditFilterId | query | integer | No | ClassId or ClassScheduleId or SessionSizeId packages which drop credits |
| RestrictedId | query | int? | No | |
| RestrictedResourceType | query | RestrictedResourceType | No | |
| InApp | query | string | No | Show packages enabled for In App purchase. True or False |
ApiDtoBase Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ApiKey | form | string | No | |
| StoreId | form | int? | No | |
| ChainId | form | int? | No | |
RestrictedResourceType Enum:| Store | |
| Chain | |
| User | |
| Undefined | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
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: clubready.com
Accept: application/xml