GET api/inventory/InventoryShopping/GetEnrollmentItems?repDID={repDID}&langKey={langKey}&country={country}&cartConfigurationId={cartConfigurationId}&localeID={localeID}
To get enrollment items available for the cart
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| repDID |
The sponsor rep for the enrolling rep. |
string |
Default value is |
| langKey |
The language key to use to make sure the items show in the proper language (e.g. en-us) |
string |
Default value is |
| country |
The country the user will be joining in. |
string |
Default value is |
| cartConfigurationId |
Optional. Used to potentially get a subset of inventory based upon InventoryCollectionTypeId stored in CartConfigurations table |
integer |
Default value is 0 |
| localeID |
Optional. This is the ID of the Locale in the ByDesign system, useful when multiple locales have the same langKey. Overrides langKey if present. |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of InventoryShoppingDisplayViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| InventoryID |
The internal inventory ID. Displayed for BackOffice Comparison. |
integer |
None. |
| ProductID |
The external ID of the inventory item. |
string |
None. |
| MasterProductID | string |
None. |
|
| DisplayName | string |
None. |
|
| ShortDetail | string |
None. |
|
| LongDetail | string |
None. |
|
| Price | decimal number |
None. |
|
| CurrencyTypeID | integer |
None. |
|
| CurrencySymbol | string |
None. |
|
| Volume | decimal number |
None. |
|
| Volume2 | decimal number |
None. |
|
| Volume3 | decimal number |
None. |
|
| Volume4 | decimal number |
None. |
|
| Compare | decimal number |
None. |
|
| CompareText | string |
None. |
|
| SmallImageURL | string |
None. |
|
| LargeImageURL | string |
None. |
|
| IsFeaturedItem | boolean |
None. |
|
| CategoryID | integer |
None. |
|
| InventoryRelationshipGroupID | integer |
None. |
|
| OutOfStockMessage | string |
None. |
|
| LowStockMessage | string |
None. |
|
| DoNotAllowAddToCartStock | boolean |
None. |
|
| DoNotAllowAddToCartCountry | boolean |
None. |
|
| AllowBackOrder | boolean |
None. |
|
| GroupItemOverrideStock | boolean |
None. |
|
| SearchField | string |
None. |
|
| IsCartItem | boolean |
None. |
|
| SortOrder | integer |
None. |
|
| Level | integer |
None. |
|
| MasterInventoryProductID | string |
None. |
|
| MasterInventoryRelationshipGroupID | integer |
None. |
|
| RenewalIncrement | integer |
None. |
|
| QtyOptions | string |
None. |
|
| MasterItemDisplayName | string |
None. |
|
| AllowJSCartPurchase | boolean |
None. |
|
| DoNotAllowAddToCartFlagged | boolean |
None. |
|
| TagText |
Text to show as a "Tag" on the List Image |
string |
None. |
| TagImageUrl |
Image to show as a "Tag" on the List Image |
string |
None. |
| Customization |
For the ByDesign JS Cart, this property contains information that allows us to customize our UI/Front-end display based on certain needs. This mostly pertains to disabling certain buttons or areas as well as injecting custom content into the page. |
InventoryShoppingDetailCustomization |
None. |
| AutoShipPrice |
Display AutoShip pricing on the shopping cart. |
decimal number |
None. |
| WholesalePrice | decimal number |
None. |
|
| IsEnrollment | boolean |
None. |
|
| PurchaseOption | integer |
None. |
|
| SearchTerms |
Search Terms that can be used as another way to filter results when searching for items. |
string |
None. |
| IsAutoShipItem | boolean |
None. |
|
| Media | Collection of IMedia |
None. |
|
| HasAutoShipTemplate | boolean |
None. |
|
| SignupOptionalItem | boolean |
None. |
|
| SignupAutoshipOption | boolean |
None. |
|
| SignupOptionalItemQtyOptions | string |
None. |
|
| SignupAutoshipOptionQtyOptions | string |
None. |
|
| PricePerUnitStandardOfMeasurement | string |
None. |
|
| PricePerUnitQuantityPer | decimal number |
None. |
Response Formats
application/xml, text/xml, application/json, text/json
Sample not available.