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 .xml suffix or ?format=xml

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StoreProductExtractResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <CategoryId>0</CategoryId>
  <NameFilter>String</NameFilter>
  <Status>0</Status>
  <ProductList>
    <ProductExtractData>
      <Active>String</Active>
      <Allow_Back_Order>String</Allow_Back_Order>
      <Download_Path>String</Download_Path>
      <Featured_Product>String</Featured_Product>
      <Is_Career_Post>String</Is_Career_Post>
      <Is_Dowloadable>String</Is_Dowloadable>
      <Is_LMS_Course>String</Is_LMS_Course>
      <Is_Ticket>String</Is_Ticket>
      <List_In_Store>String</List_In_Store>
      <Low_Stock_Threshold>0</Low_Stock_Threshold>
      <NonMember_Price>0</NonMember_Price>
      <Number_Sold>0</Number_Sold>
      <Permalink>String</Permalink>
      <Primary_Category>String</Primary_Category>
      <Primary_Category_ID>0</Primary_Category_ID>
      <Product_Code>String</Product_Code>
      <Product_ID>0</Product_ID>
      <Product_Name>String</Product_Name>
      <Stock_Level>0</Stock_Level>
      <Use_Inventory>String</Use_Inventory>
    </ProductExtractData>
  </ProductList>
</StoreProductExtractResponse>