Requires any of the roles: | admin, oauthadmin |
GET | /Ams/{ClientID}/StoreProductExtract | Return the list of store products. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
NameFilter | query | string | No | |
CategoryId | query | int? | No | |
Status | query | int? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UsingRedis | form | bool | No | |
AppInitTime | form | DateTime | No | |
ServerID | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ClientID | form | int | No | |
ResponseStatus | form | ResponseStatus | No | |
BypassCache | form | bool | No | |
DateCached | form | DateTime | No | |
Device | form | Device | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ProductList | form | List<ProductExtractData> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Product_ID | form | int | No | |
Product_Code | form | string | No | |
Product_Name | form | string | No | |
Active | form | string | No | |
Featured_Product | form | string | No | |
Primary_Category_ID | form | int | No | |
Primary_Category | form | string | No | |
Use_Inventory | form | string | No | |
Stock_Level | form | int | No | |
Low_Stock_Threshold | form | int | No | |
Allow_Back_Order | form | string | No | |
Number_Sold | form | int | No | |
NonMember_Price | form | decimal | No | |
Permalink | form | string | No | |
Is_Dowloadable | form | string | No | |
Download_Path | form | string | No | |
List_In_Store | form | string | No | |
Buy_From_Store | form | string | No | |
Is_Ticket | form | string | No | |
Is_Career_Post | form | string | No | |
Is_LMS_Course | form | string | No |
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
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","Buy_From_Store":"String","Is_Ticket":"String","Is_Career_Post":"String","Is_LMS_Course":"String"}],"NameFilter":"String","CategoryId":0,"Status":0,"UsingRedis":true,"AppInitTime":"2025-01-15T07:46:04.6467430-05:00","ServerID":"WS-6-64-014","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":"2025-01-15T08:45:58.9877454-05:00","Device":"Desktop"}