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

<StoreProductResponse 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>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <SortColumn>String</SortColumn>
  <SortDirection>String</SortDirection>
  <Status>0</Status>
  <ProductListList>
    <ProductData>
      <aut_ProductId>0</aut_ProductId>
      <blnAllowBackOrder>false</blnAllowBackOrder>
      <blnDownloadable>false</blnDownloadable>
      <blnFeaturedHere>false</blnFeaturedHere>
      <blnPrimaryCategory>false</blnPrimaryCategory>
      <blnUseInventory>false</blnUseInventory>
      <bln_Featured>false</bln_Featured>
      <intCurrentCategoryID>0</intCurrentCategoryID>
      <intLowStockThreshold>0</intLowStockThreshold>
      <intPrimaryCategoryID>0</intPrimaryCategoryID>
      <intPurchased>0</intPurchased>
      <intReserved>0</intReserved>
      <intSequence>0</intSequence>
      <intStockLevel>0</intStockLevel>
      <intTotalRows>0</intTotalRows>
      <int_productActive>0</int_productActive>
      <strDownloadPath>String</strDownloadPath>
      <strPrimaryCategory>String</strPrimaryCategory>
      <txt_productName>String</txt_productName>
    </ProductData>
  </ProductListList>
</StoreProductResponse>