• 1-800-224-0976 US & Canada toll free

cart.validate

This method allows to perform cart’s validation. It checks whether the store is available and if there is a bridge connection for self-hosted carts as well as database’s structure. If you are working with hosted carts it checks if the connection to API is available. Below you will find all parameters that are necessary to perform cart validation along with request and response examples. Integration code samples together with interactive documentation (Swagger) that are also presented will make API2Cart a clear tool to use.

 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

 Response Structure

 

{
  "return_code": int,
  "return_message": string,
  "result":{
    "status": string
  }
}

 Response Example

 

{
  "return_code":0,
  "return_message":"",
  "result":{
    "status":"OK"
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <return_code>0</return_code>
  <return_message />
  <result>
    <status>OK</status>
  </result>
</response>

 Request Example

 Code Sample

index.php

<?php

include_once 'Connector.php';

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

try {

  /**
   * Return stdClass
   */
  $result = $api->request('cart.validate');

  echo 'Status: ' . $result->status;

} 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

 Try Now (Swagger)