YM REST Services

<back to all web services

StoreProductSelection

Requires Authentication
Requires any of the roles:admin, oauthadmin, member
The following routes are available for this service:
GET/Ams/{ClientID}/StoreProductSelectReturn the list of store products.
StoreProductSelection Parameters:
NameParameterData TypeRequiredDescription
NameFilterquerystringNo
CategoryIdqueryint?No
Statusqueryint?No
PageSizequeryint?No
PageNumberqueryint?No
SortColumnquerystringNo
SortDirectionquerystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
StoreProductResponse Parameters:
NameParameterData TypeRequiredDescription
ProductListListformList<ProductData>No
ProductData Parameters:
NameParameterData TypeRequiredDescription
aut_ProductIdformintNo
txt_productNameformstringNo
intSequenceformintNo
int_productActiveformintNo
bln_FeaturedformboolNo
blnDownloadableformboolNo
strDownloadPathformstringNo
blnAllowBackOrderformboolNo
intStockLevelformintNo
intLowStockThresholdformintNo
blnUseInventoryformboolNo
intPrimaryCategoryIDformintNo
intCurrentCategoryIDformintNo
blnPrimaryCategoryformboolNo
strPrimaryCategoryformstringNo
blnFeaturedHereformboolNo
intPurchasedformintNo
intReservedformintNo
intTotalRowsformintNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /Ams/{ClientID}/StoreProductSelect HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ProductListList":[{"aut_ProductId":0,"txt_productName":"String","intSequence":0,"int_productActive":0,"bln_Featured":false,"blnDownloadable":false,"strDownloadPath":"String","blnAllowBackOrder":false,"intStockLevel":0,"intLowStockThreshold":0,"blnUseInventory":false,"intPrimaryCategoryID":0,"intCurrentCategoryID":0,"blnPrimaryCategory":false,"strPrimaryCategory":"String","blnFeaturedHere":false,"intPurchased":0,"intReserved":0,"intTotalRows":0}],"NameFilter":"String","CategoryId":0,"Status":0,"PageSize":0,"PageNumber":0,"SortColumn":"String","SortDirection":"String","UsingRedis":true,"AppInitTime":"2024-05-03T04:23:41.3671139-04:00","ServerID":"WS-4-69-031","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T05:27:03.9691081-04:00","Device":"Desktop"}