YM REST Services

FindProducts

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin	Required permission:	/admin/store/

The following routes are available for this service:
GET	/Ams/{ClientID}/FindProducts	Look up products - with cache.	Find a product by search key elements of a product.

**FindProducts** Parameters:
Name	Parameter	Data Type	Required
term	query	string	No
useCategories	query	bool	No
limit	query	int	No
isTicket	query	bool?	No

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**FindProductsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
productsFound	form	List<ProductFound>	No

**ProductFound** Parameters:
Name	Parameter	Data Type	Required	Description
id	form	int	No
label	form	string	No

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

HTTP + CSV

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

GET /Ams/{ClientID}/FindProducts HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"productsFound":[{"id":0,"label":"String"}],"term":"String","useCategories":false,"limit":0,"isTicket":false,"UsingRedis":true,"AppInitTime":"2024-05-03T03:46:39.8151879-04:00","ServerID":"WS-4-7-585","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:42:41.9019124-04:00","Device":"Desktop"}