Getting Popular Products

Method Description

Invoked with a POST request. Operation name can be retrieved via Maestra framework. Details of method invocation can be found here.

POST https://api.maestra.io/v3/operations/sync?endpointId={unique ID of site/mobile app/etc.}&operation={operation name}

Accept: application/xml
Content-Type: application/xml

<operation>
  <productCategory>
    <ids>
      <webSiteId>{product category ID}</webSiteId>
    </ids>
  </productCategory>
  <page>
    <pageNumber>{page number}</pageNumber>
    <itemsPerPage>{products per page}</itemsPerPage>
  </page>
</operation>

Page numbers start at 1.
Maximum products per page is 1000.
Product category is optional. If not set, products from all categories are retrieved.

Sample Operation

POST https://api.maestra.io/v3/operations/sync?endpointId=Maestra&operation=GetPopularProducts

Accept: application/xml
Content-Type: application/xml

<operation>
  <productCategory>
    <ids>
      <webSiteId>123</webSiteId>
    </ids>
  </productCategory>
  <page>
    <page>1</page>
    <itemsPerPage>50</itemsPerPage>
  </page>
</operation>

The query returns top 30 products in the category.

Response

<result>
  <status>Success</status>
  <recommendedProducts>
    <product>
      <ids>
        <webSiteId>1</webSiteId>
      </ids>
    </product>
    <product>
      <ids>
        <webSiteId>2</webSiteId>
      </ids>
    </product>
  </recommendedProducts>
</result>