product.list

This method lets API2Cart users get the list of products from the store. It returns 10 products by default.

Below you will find all needed parameters as well as request and response examples.

Check integration code samples and interactive documentation (Swagger) to see how it works.

Supported Carts

Choose a shopping cart to see what params are available for this platform.

All shopping carts on the list work with this method, docs are coming soon.

● ● ●

Params

api_key

store_key

page_cursor

start

count

params

exclude

category_id

created_from

created_to

modified_from

modified_to

avail_view

avail_sale

store_id

lang_id

currency_id

product_ids

product_variant_params

since_id

report_request_id

disable_report_cache

sort_by

sort_direction

sku

disable_cache

brand_name

product_attributes

status

Response Structure

{
  "return_code": int,
  "return_message": string,
  "result":{
    "products_count": int,
    "product":[ array
      {
        "id": string,
        "type": string,
        "u_model": string,
        "u_sku": string,
        "name": string,
        "description": string,
        "short_description": string,
        "price": decimal,
        "quantity": int,
        "u_brand": string,
        "categories_ids": string,
        "stores_ids": string,
        "url": string,
        "seo_url": string,
        "meta_title": string,
        "meta_keywords": string,
        "meta_description": string,
        "avail_sale": string,
        "avail_view": string,
        "weight": decimal,
        "sort_order": int,
        "backorders": string,
        "manage_stock": string,
        "create_at": string,
        "modified_at": string,
        "tax_class_id": string,
        "dimensions_unit": string,
        "width": decimal,
        "height": decimal,
        "length": decimal,
        "special_price":[ array
          {
            "value": decimal,
            "avail": string,
            "created_at": string,
            "modified_at": string,
            "expired_at": string
          }
        ],
        "tier_price":[ array
          {
            "tier_price_count1": int,
            "tier_price_value1": decimal,
            "tier_prices_count": int
            ...
          }
        ],
        "group_price":[ array
          {
            "id": string,
            "group_id": string,
            "price": decimal,
            "store_id": string,
            "quantity": decimal,
            "start_time": string,
            "expire_time": string
          },
          ...
        ],
        "images":[ array
          {
            "item":[ array
              {
                "http_path": string,
                "type": string,
                "mime-type": string,
                "alt": string,
                "avail": string,
                "file_name": string,
                "create_at": string,
                "modified_at": string,
                "size": int
              },
              ...              
            ]
          }
        ],
        "product_options":[ array,
          {
            "option":[ array
              {
                "id": string,
                "product_option_id": string,
                "name": string,
                "type": string,
                "required": string,
                "option_value":[ array
                  {
                    "value":[ array
                      {
                        "id": string,
                        "product_option_value_id": string,
                        "name": string,
                        "price": decimal,
                        "type_price": string,
                        "quantity": int
                      },
                      ...               
                    ]
                  }
                ]
              },
              ...
            ]
          }
        ],
        "product_variants":[ array,
          {
            "product_variant":[ array
              {
                "id": string,
                "attribute_set_name": string,
                "type": string,
                "u_model": string,
                "u_sku": string,
                "name": string,
                "description": string,
                "price": decimal,
                "quantity": int,
                "u_brand_id": string,
                "u_brand": string,
                "categories_ids": string,
                "url": string,
                "seo_url": string,
                "meta_title": string,
                "meta_keywords": string,
                "meta_description": string,
                "avail_sale": string,
                "avail_view": string,
                "weight": decimal,
                "sort_order": int,
                "create_at": string,
                "modified_at": string,
                "special_price":[ array
                  {
                    "value": decimal,
                    "avail": string,
                    "created_at": string,
                    "modified_at": string,
                    "expired_at": string
                  }
                ],
                "tax_class_id": string,
                "images": array,
                "u_upc": string,
                "u_mpn": string,
                "categories": deprecated,
                "combinations":[ array
                  {
                    "combination":[ array
                      {
                        "name": string,
                        "option_id": string,
                        "value_id": string
                      },
                      {
                        "name": string,
                        "option_id": string,
                        "value_id": string
                       }
                       ...
                    ]
                  }
                ]
              },
              ...
            ]
          }
        ],
        "u_upc": string,
        "u_mpn": string,
        "categories": deprecated,
        "related_products_ids": string,
        "tax_class":[ deprecated
          {
            "tax_class_id": string,
            "name": string,
            "created_at": string,
            "modified_at": string,
            "value": deprecated,
            "avail": string,
            "value_type": int,
            "tax_rates":[ array
              {
                "tax_rate":[ array
                  {
                    "tax_rate_id": string,
                    "name": string,
                    "type": int,
                    "value": decimal,
                    "create_at": string,
                    "modified_at": string
                  },
                  ...                  
                ]
              }
            ]
          }
        ],
      },
      ...      
    ]
  }
}

Response Example

Request Example

Code Sample

index.php

<?php

include_once 'Connector.php';

$api = new Connector('PASTE_YOUR_API_KEY','PASTE_YOUR_STORE_KEY');

$params = array(
  'start'  => 0,
  'count'  => 50,
  'params' => 'id,name,price',
);

try {

  /**
   * Return stdClass
   */
  $result = $api->request('product.list', $params);

  echo "Products count: " . $result->products_count . "\n";

  foreach($result->product as $product) {

    echo "Product ID: " . $product->id   . "\n" .
         "Name: "       . $product->name . "\n" .
         "Price: "      . $product->price . "\n\n";
  }

} catch (Exception $e) {

  echo '#' . $e->getCode() . ' ' . $e->getMessage();

}

Connector.php

<?php

/**
 * Class Connector
 */
class Connector
{
  /**
   * URL to API API2Cart
   *
   * @var string A2C_URL
   */
  const A2C_URL = 'https://api.api2cart.com/v1.0/';

  /**
   * @var array $_params
   */
  private $_params = array();

  /**
   * @param string $apiKey
   * @param string $storeKey
   */
  public function __construct($apiKey, $storeKey = null)
  {
    $this->_params['api_key']   = $apiKey;

    if($storeKey !== null) {
      $this->_params['store_key'] = $storeKey;
    }
  }


  /**
   * Send request to API2Cart
   *
   * @param string $method Name method
   * @param array  $params List params for method
   *
   * @return stdClass
   *
   * @throws Exception
   */
  public function request($method, $params = array())
  {

    $params = array_merge($this->_params,$params);

    $ch = curl_init();

    $url = self::A2C_URL . $method . '.json?' . http_build_query($params);

    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
    curl_setopt($ch, CURLOPT_HEADER, false);
    curl_setopt($ch, CURLOPT_TIMEOUT, 300);
    curl_setopt($ch, CURLINFO_HEADER_OUT,true);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($ch, CURLOPT_USERAGENT, 
      "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; " .
      "rv:1.8.1.1) Gecko/20061204 Firefox/2.0.0.1");
    curl_setopt($ch, CURLOPT_HTTPHEADER, array (
      "Accept: */*",
    ));

    try {

      $response = trim(curl_exec($ch));

      if(curl_errno($ch) != CURLE_OK) {
        throw new Exception(curl_error($ch));
      }

      curl_close($ch);

      return $this->validate($response);

    } catch (Exception $e) {

      throw $e;

    }
  }

  /**
   * Validate received response
   *
   * @param string $response Response
   *
   * @return stdClass
   *
   * @throws Exception
   */
  private function validate($response)
  {
    $result = json_decode($response);

    if($result === null) {
      throw new Exception('Response NULL');
    }

    if($result->return_code != 0) {
      throw new Exception($result->return_message, $result->return_code);
    }

    return $result->result;
  }
}

See More
Integration Code Samples
Full code sample on Git Hub