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 .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 /Ams/{ClientID}/StoreProductSelect HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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-03T00:24:41.1317790-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-03T02:03:35.1267538-04:00,
	Device: Desktop
}