How to pull products JSON through API in Opencart?

In this tutorial, we show how to pull products in JSON format through API in Opencart. First, read the post below to understand the OpenCart API:

We take an example between two servers one from which acts as Server Responder of API which is built in OpenCart and as the requestor.

Opencart API explained

Responding server

OpenCart does not provide API to show the products by default so we need to make some changes in responding server to show all products. For that in your responding server go to catalog/controller/api/ and create product.php and paste following lines of code:

class ControllerApiProduct extends Controller
    public function index()
        $json = array();
        $json['products'] = array();
        $filter_data = array();
        $results = $this->model_catalog_product->getProducts($filter_data);
        foreach ($results as $result) {
            if ($result['image']) {
                $image = $this->model_tool_image->resize($result['image'], $this->config->get('theme_' . $this->config->get('config_theme') . '_image_product_width'), $this->config->get('theme_' . $this->config->get('config_theme') . '_image_product_height'));
            } else {
                $image = $this->model_tool_image->resize('placeholder.png', $this->config->get('theme_' . $this->config->get('config_theme') . '_image_product_width'), $this->config->get('theme_' . $this->config->get('config_theme') . '_image_product_height'));
            if ($this->customer->isLogged() || !$this->config->get('config_customer_price')) {
                $price = $this->currency->format($this->tax->calculate($result['price'], $result['tax_class_id'], $this->config->get('config_tax')), $this->session->data['currency']);
            } else {
                $price = false;
            if ((float) $result['special']) {
                $special = $this->currency->format($this->tax->calculate($result['special'], $result['tax_class_id'], $this->config->get('config_tax')), $this->session->data['currency']);
            } else {
                $special = false;
            if ($this->config->get('config_tax')) {
                $tax = $this->currency->format((float) $result['special'] ? $result['special'] : $result['price'], $this->session->data['currency']);
            } else {
                $tax = false;
            if ($this->config->get('config_review_status')) {
                $rating = (int) $result['rating'];
            } else {
                $rating = false;
            $data['products'][] = array(
                'product_id' => $result['product_id'],
                'thumb' => $image,
                'name' => $result['name'],
                'description' => utf8_substr(trim(strip_tags(html_entity_decode($result['description'], ENT_QUOTES, 'UTF-8'))), 0, $this->config->get('theme_' . $this->config->get('config_theme') . '_product_description_length')) . '..',
                'price' => $price,
                'special' => $special,
                'tax' => $tax,
                'minimum' => $result['minimum'] > 0 ? $result['minimum'] : 1,
                'rating' => $result['rating'],
                'href' => $this->url->link('product/product', 'product_id=' . $result['product_id']),
        $json['products'] = $data['products'];
        $this->response->addHeader('Content-Type: application/json');

With the above code it will provide you directly accessing API URL index.php?route=api/product. As per our example, it is Here we did not do any authentication and authorization. It directly shows all products whoever is called from that URL. In our upcoming post, we will show how to show categories to API users only.

Requesting server

In your requesting server, create a file lets say apiproducts.php, as per our example let’s say we create In this file let’s make a CURL request to the get the products: Following is the code:

$url = "";
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => $url . "/index.php?route=api%2Fproduct",
        "cache-control: no-cache",
$response = curl_exec($curl);
$err = curl_error($curl);
if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;

Finally, the response you get will be like below:

    "products": [{
        "product_id": "30",
        "thumb": "https:\/\/\/nepalbuddha\/image\/cache\/catalog\/demo\/canon_eos_5d_1-228x228.jpg",
        "name": "Canon EOS 5D",
        "description": "Canon's press material for the EOS 5D states that it 'defines (a) new D-SLR category', while we're n..",
        "price": "$122.00",
        "special": "$98.00",
        "tax": "$80.00",
        "minimum": "1",
        "rating": 0,
        "href": "https:\/\/\/nepalbuddha\/index.php?route=product\/product&product_id=30"
    }, {
        "product_id": "47",
        "thumb": "https:\/\/\/nepalbuddha\/image\/cache\/catalog\/demo\/hp_1-228x228.jpg",
        "name": "HP LP3065",
        "description": "Stop your co-workers in their tracks with the stunning new 30-inch diagonal HP LP3065 Flat Panel Mon..",
        "price": "$122.00",
        "special": false,
        "tax": "$100.00",
        "minimum": "1",
        "rating": 0,
        "href": "https:\/\/\/nepalbuddha\/index.php?route=product\/product&product_id=47"

As per our API set up, it just returns product_id, thumb, name, description, price, special, tax, minimum, rating, and link of the product. If you want to make changes then you have to make changes in catalog/controller/api/product.php as per your need. In this way, you can retrieve all products in JSON format through API.

You can check following Opencart API related posts:

Please don’t forget to post your questions or comments so that we can add extra topics. Likewise, you can follow us at our twitter account @rupaknpl and subscribe to our YouTube channel for Opencart tutorials.

Previous articleOpenCart API documentation to create, read, query, update, and upsert
Next articleFeedback or Testimonials Module for Opencart 2.2 for Free


  1. Hey Rupak , I have a Query , What if anyone has Dynamic IP or let’s say that on Every Post or Get Request the IP changes . Then in that case what can we do.


    • Hi @Sushil,

      May not the good Idea but you can make following changes to allow all IPs:

      Go to catalog/controller/startup/session.php and comment out if ($api_query->num_rows) { statement like below:

      //if ($api_query->num_rows) {
      // keep the session alive
      $this->db->query(“UPDATE `” . DB_PREFIX . “api_session` SET `date_modified` = NOW() WHERE `api_session_id` = ‘” . (int)$api_query->row[‘api_session_id’] . “‘”);

      With this, it will not check the listed IPs.

      Hope it is helpful

  2. Great tutorial Rupak, I’m trying to understand the OpenCart API and your guide is very clear and concise. How could the search controller (catalog\controller\product\search.php) be adapted to do a product search (?route=api/product)? Thanks in advance for your time and attention.

  3. If I understood, you want to filter out the products. Then in above just below $filter_data = array(); we need to set the filter data something like:

    $filter_data = array(
    ‘filter_name’ => $search,
    ‘filter_tag’ => $tag,
    ‘filter_description’ => $description,
    ‘filter_category_id’ => $category_id,
    ‘filter_sub_category’ => $sub_category,
    ‘sort’ => $sort,
    ‘order’ => $order,
    ‘start’ => ($page – 1) * $limit,
    ‘limit’ => $limit

    Once you set all the variable values it will work. Hope it helps.

  4. Dear Mr.Rupak,

    Thank you for your most wonderful tutorial.
    I hope this finds you well.

    Please, I am getting a header already sent, output already started..
    If you’d please advise.
    I Thank you.

    • In the requesting server, you need to use XML load and convert it into JSON, which you can do something like below:

      $xml = simplexml_load_string($xml_string);
      $json = json_encode($xml);
      $array = json_decode($json,TRUE);

      Then convert that JSON to your required output by filtering it out.

  5. Hello Rupak, nice tutorial! wondering how can we query other general info about products or categories? for example, how can we get a list of categories and their product list, or how can we get all the product images? i’m interested in learning where do you find the right variable/method to call a particular data. thanks!

  6. Hello, I really like your tutorials. But I can’t find the one which would help me to connect my Opencart website with the Google Merchandising platform so using API configuration I can make products sync from my website with the Merchant Center. Can you please make this one? I’d really appreciate it.

  7. Hello Rupak, I installed the Opencart system locally and I need the product to add API to add products to this system, can you help me, please?


Please enter your comment!
Please enter your name here