GET api/Packages/{id}
Gets a package, checked against the session's basket: what it offers and, for each gap (a rule the basket doesn't meet yet), the folders on sale that would fill it.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The package ID. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
The package, with its gaps.
Package| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The package ID. |
globally unique identifier |
None. |
| Amount |
The discount the package gives. |
decimal number |
None. |
| CodeId |
The package code applied, for packages that need a code. |
globally unique identifier |
None. |
| Text |
Text for the package in the basket. |
string |
None. |
| Description |
Description of the package. |
string |
None. |
| GroupText |
Text for the group of items the package covers. |
string |
None. |
| Headline |
Headline for promoting the package. |
string |
None. |
| NotAppliedText |
Text to show while the basket doesn't qualify yet. |
string |
None. |
| PromptText |
Text prompting the customer to complete the package. |
string |
None. |
| Gaps |
What the basket still needs to qualify. Only from api/Packages/{id}. |
Collection of PackageGap |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.