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

cart.giftcard.list

This method makes it possible to get the list of giftcards on the store. It returns 10 giftcards by default. Below you will find all parameters that are necessary to get giftcards' list as well as 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,
  "gift_card": [
     {
        "id": string,
        "code": string,
        "name": string,
        "currency_code": string,
        "amount": decimal,
        "initial_amount": decimal,
        "status": string,
        "created_at": string,
        "avail_to": string,
        "free_product_ids": string,
        "message": string,
        "owner_email": string,
        "recipient_email": string,
        "owner_name": string,
        "recipient_name": string,
        "usage_history":[ array
          {
            "order_id": string,
            "amount": decimal
          },
          ...
        ]
     },
     ...
  ]

 Response Example

 

{
  "return_code": 0,
  "return_message": "",
  "result": {
    "gift_cards_count": 2,
    "gift_card": [
      {
        "id": "6",
        "code": "AS5S4D522S4D664",
        "name": null,
        "type": "email",
        "currency_code": "GBP",
        "amount": 25,
        "initial_amount": 25,
        "status": "disabled",
        "created_at": "2017-05-30 15:20:30",
        "avail_to": "2019-05-11 11:30:10",
        "free_product_ids": "59,65,811",
        "message": "this is a gift",
        "owner_email": "[email protected]",
        "recipient_email": null,
        "owner_name": "Test",
        "recipient_name": Test,
        "usage_history": [
          
        ]
      },
      {
        "id": "7",
        "code": "b9cg444gfhj",
        "name": null,
        "type": "virtual",
        "currency_code": "GBP",
        "amount": 5,
        "initial_amount": 10,
        "status": "expired",
        "created_at": "2015-04-21 13:02:18",
        "avail_to": "2016-09-08 00:00:00",
        "free_product_ids": null,
        "message": null,
        "owner_email": null,
        "recipient_email": null,
        "owner_name": null,
        "recipient_name": null,
        "usage_history": [
            {
                "order_id":"14",
                "amount":5
            }
        ]
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <return_code>0</return_code>
    <return_message></return_message>
    <result>
        <gift_cards_count>2</gift_cards_count>
        <gift_card>
            <id>75925316</id>
            <code>qq45ff4f3e6</code>
            <name/>
            <type>email</type>
            <currency_code>GBP</currency_code>
            <amount>25</amount>
            <initial_amount>25</initial_amount>
            <status>disabled</status>
            <created_at>2017-05-30 15:20:30</created_at>
            <avail_to/>
            <free_product_ids/>
            <message/>
            <owner_email>[email protected]</owner_email>
            <recipient_email/>
            <owner_name>Test</owner_name>
            <recipient_name/>
            <usage_history></usage_history>
        </gift_card>
        <gift_card>
            <id>75234628</id>
            <code>df4g54hj</code>
            <name/>
            <type>virtual</type>
            <currency_code>GBP</currency_code>
            <amount>10</amount>
            <initial_amount>10</initial_amount>
            <status>expired</status>
            <created_at>2011-04-21 13:02:18</created_at>
            <avail_to>2016-09-08 00:00:00</avail_to>
            <free_product_ids/>
            <message/>
            <owner_email/>
            <recipient_email/>
            <owner_name/>
            <recipient_name/>
            <usage_history></usage_history>
        </gift_card>
    </result>
</response>

 Request Example

 Code Sample

Not Defined

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)