YM REST Services

<back to all web services

StoreProductExtractSelection

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/StoreProductExtractReturn the list of store products.
StoreProductExtractSelection Parameters:
NameParameterData TypeRequiredDescription
NameFilterquerystringNo
CategoryIdqueryint?No
Statusqueryint?No
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
StoreProductExtractResponse Parameters:
NameParameterData TypeRequiredDescription
ProductListformList<ProductExtractData>No
ProductExtractData Parameters:
NameParameterData TypeRequiredDescription
Product_IDformintNo
Product_CodeformstringNo
Product_NameformstringNo
ActiveformstringNo
Featured_ProductformstringNo
Primary_Category_IDformintNo
Primary_CategoryformstringNo
Use_InventoryformstringNo
Stock_LevelformintNo
Low_Stock_ThresholdformintNo
Allow_Back_OrderformstringNo
Number_SoldformintNo
NonMember_PriceformdecimalNo
PermalinkformstringNo
Is_DowloadableformstringNo
Download_PathformstringNo
List_In_StoreformstringNo
Is_TicketformstringNo
Is_Career_PostformstringNo
Is_LMS_CourseformstringNo

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}/StoreProductExtract HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ProductList":[{"Product_ID":0,"Product_Code":"String","Product_Name":"String","Active":"String","Featured_Product":"String","Primary_Category_ID":0,"Primary_Category":"String","Use_Inventory":"String","Stock_Level":0,"Low_Stock_Threshold":0,"Allow_Back_Order":"String","Number_Sold":0,"NonMember_Price":0,"Permalink":"String","Is_Dowloadable":"String","Download_Path":"String","List_In_Store":"String","Is_Ticket":"String","Is_Career_Post":"String","Is_LMS_Course":"String"}],"NameFilter":"String","CategoryId":0,"Status":0,"UsingRedis":true,"AppInitTime":"2024-05-03T00:47:02.7459456-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-03T03:23:02.6799066-04:00","Device":"Desktop"}