<back to all web services
GetSalesPackageRequest
The following routes are available for this service:| GET | /sales/package/{PackageId} | Get sales package details | |
|---|
GetSalesPackageRequest 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 | No | ID # of store to get package details for.
Either StoreId or ChainId is required |
| ChainId | query | string | No | ID # of chain to get package details for.
Either StoreId or ChainId is required |
| PackageId | path | string | Yes | ID # of package to get details for |
| RestrictedId | query | int? | No | |
| RestrictedResourceType | query | RestrictedResourceType | No | |
GetSalesPackageRequestDto Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| PackageId | form | int | No | |
ApiDtoBase Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ChainId | form | int? | No | |
| ApiKey | form | string | No | |
| StoreId | form | int? | 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: www.clubready.com
Accept: text/jsv