Retrieve a list of all Products

Follow

 

URL Query Parameters

  • page - The current page (default: 1)
  • limit - Amount of results per page (default: 20)
  • sort - Sort by a parameter
  • action - (Optional), When submitting a keyword search so set to “search”
  • keyword - (Optional), Used with action, a keyword(s) to search for

Using Action

When submitting the action parameter, Instantcart accepts the following:-

  • search - Used in conjunction with a keyword parameter
  • specials - Show Special offers only
  • features - Show featured products only

Using Sort

To use the sort feature, submit a sort parameter with any of the following

  • p-products_name-asc - Sort by Name Ascending
  • p-products_name-desc - Sort by Name Descending
  • p-products_code-asc - Sort by Code Ascending
  • p-products_code-desc - Sort by Code Descending
  • pf-products_features_id-asc - Sort by Features Ascending
  • pf-products_features_id-desc - Sort by Features Descending
  • p-products_active-asc - Sort by Active Ascending
  • p-products_active-desc - Sort by Code Descending
  • p.products_date_added-asc - Sort by Date Added Ascending
  • p.products_date_added-desc - Sort by Date Added Descending
  • price-asc - Sort by Price Ascending
  • price-desc - Sort by Price Descending

Call

GET /rest/products.json?page=2

Usage Examples

GET /rest/products.json?page=2
GET /rest/products.json?page=2&limit=10

Response

{
  "success":"1",
  "status":"Products successfully retrieved",
  "count":"906",
  "products":[
    {
      "count":1,
      "id":"1",
      "image_one":{
        "small":"https:\/\/demo.instantcart.com\/images\/product_images\/small\/1\/watercool-mounting-kit-for-heatkiller-cpu-30-series-1366-for-2011-32ld450t-1-1.jpg",
        "mini":"https:\/\/demo.instantcart.com\/images\/product_images\/mini\/1\/watercool-mounting-kit-for-heatkiller-cpu-30-series-1366-for-2011-32ld450t-1-1.jpg",
        "active":"1\/watercool-mounting-kit-for-heatkiller-cpu-30-series-1366-for-2011-32ld450t-1-1.jpg",
        "thumb":"https:\/\/demo.instantcart.com\/images\/product_images\/thumbs\/1\/watercool-mounting-kit-for-heatkiller-cpu-30-series-1366-for-2011-32ld450t-1-1.jpg",
        "main":"https:\/\/demo.instantcart.com\/images\/product_images\/main\/1\/watercool-mounting-kit-for-heatkiller-cpu-30-series-1366-for-2011-32ld450t-1-1.jpg",
        "large":"https:\/\/demo.instantcart.com\/images\/product_images\/large\/1\/watercool-mounting-kit-for-heatkiller-cpu-30-series-1366-for-2011-32ld450t-1-1.jpg"
      },
      "link":"p\/Watercool-Mounting-Kit-for-HEATKILLER-CPU-30-Series-1366-for-2012_1.html",
      "link_button":"
<ahref=\"p\/Watercool-Mounting-Kit-for-HEATKILLER-CPU-30-Series-1366-for-2012_1.html\"><inputonclick=\"window.location('p\/Watercool-Mounting-Kit-for-HEATKILLER-CPU-30-Series-1366-for-2012_1.html');\"type=\"button\"value=\"View this item\"class=\"tooltip\"title=\"View this item\" \/><\/a>",
      "short_description":"",
      "buy_link":"p\/add\/Watercool-Mounting-Kit-for-HEATKILLER-CPU-30-Series-1366-for-2012_1.html",
      "price_ex_tax":"300.00",
      "price_inc_tax":"360.00",
      "price_was":"0.56",
      "price_saved":"0.00",
"price_is_percentage":"1",
"price_percentage":"5", "tax":"20.0000", "tax_rate_id":null, "tax_rate":{ "id":null, "percent":"20.0000" }, "currency":"EUR", "name":"Watercool Mounting Kit for HEATKILLER CPU 3.0 Series 1366 for 2012", "name_short":"Watercool Mounting Kit for HEATKILLER CPU 3.0 Series 13", "stock":"80", "code":"32LD450h80", "man_code":"3yelll8080", "ean_code":"rides80", "upc_code":"32LD450j80", "is_set":false, "is_active":"0", "brand":"TRANSCEND", "is_special":false, "is_free_delivery":"1", "is_dropship":"0", "product_man":"3yelll8080", "review_average":false, "review_count":0, "login_for_price":"0", "qty_prices":"", "date":{ "added":"2012-08-15 11:36:56", "edited":"2014-03-18 11:22:50" } }, { "count":2, "id":"6", "image_one":{ "small":"https:\/\/demo.instantcart.com\/images\/product_images\/small\/1\/6_01.jpg", "mini":"https:\/\/demo.instantcart.com\/images\/product_images\/mini\/1\/6_01.jpg", "active":"1\/6_01.jpg", "thumb":"https:\/\/demo.instantcart.com\/images\/product_images\/thumbs\/1\/6_01.jpg", "main":"https:\/\/demo.instantcart.com\/images\/product_images\/main\/1\/6_01.jpg", "large":"https:\/\/demo.instantcart.com\/images\/product_images\/large\/1\/6_01.jpg" }, "link":"p\/Tower-case_6.html", "link_button":"
<ahref=\"p\/Tower-case_6.html\"><inputonclick=\"window.location('p\/Tower-case_6.html');\"type=\"button\"value=\"View this item\"class=\"tooltip\"title=\"View this item\" \/><\/a>", "short_description":"", "buy_link":"p\/add\/Tower-case_6.html", "price_ex_tax":"750.00", "price_inc_tax":"900.00", "price_was":"0.00", "price_saved":"0.00", "tax":"20.0000", "tax_rate_id":null, "tax_rate":{ "id":null, "percent":"20.0000" }, "currency":"EUR", "name":"Tower case", "name_short":"Tower case", "stock":"155", "code":"TEST-2", "man_code":"TEST-y", "ean_code":"tedfgh", "upc_code":"", "is_set":false, "is_active":"1", "brand":"HYPERAM", "is_special":"1", "is_free_delivery":"0", "is_dropship":"0", "product_man":"TEST-y", "review_average":false, "review_count":0, "login_for_price":"0", "qty_prices":"", "date":{ "added":"2013-07-22 17:37:12", "edited":"2014-03-14 12:26:24" } }
  ] 
}

 

Have more questions? Submit a request

Comments

Powered by Zendesk