product.child_item.list

This method lets API2Cart users get info about child items of the product.

For configurable products this method returns the list of variants, for bundles it returns the list of items the bundle consists of.

Please note that you need to specify either product_id or product_ids parameter for this method (separate the IDs with commas).

You can identify the parent item of the child item by checking the parent_id parameter.

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

created_from

created_to

modified_from

modified_to

product_id

product_ids

store_id

lang_id

currency_id

avail_sale

report_request_id

disable_report_cache

Response Structure

{
  "return_code": int,
  "return_message": string,
  "result":{
    "total_count": int,
    "children": [ array
      {
        "id": string,
        "parent_id": string,
        "sku": string,
        "upc": string,
        "ean": string,
        "mpn": string,
        "gtin": string,
        "sort_order": int,
        "created_time": {
          "value": string,
          "format": string
        },
        "modified_time": {
          "value": string,
          "format": string
        },
        "name": string,
        "short_description": string,
        "full_description": string,
        "images": [ array
          {
            "id": string,
            "http_path": string,
            "file_name": string,
            "mime-type": string,
            "size": int,
            "create_at": {
              "value": string,
              "format": string
            },
            "modified_at": {
              "value": string,
              "format": string
            },
            "alt": string,
            "avail": bool,
            "sort_order": int,
            "type": string
          },
          ...
        ],
        "combination": [ array
          {
            "option_id": string,
            "option_value_id": string
          },
          ...
        ],
        "default_price": decimal,
        "list_price": decimal,
        "wholesale_price": decimal,
        "advanced_price": [ array
          {
            "id": string,
            "value":  decimal,
            "avail": bool,
            "group_id": string,
            "quantity_from": decimal,
            "start_time": {
              "value": string,
              "format": string
            },
            "expire_time": {
              "value": string,
              "format": string
            },
          },
          ...
        ],
        "tax_class_id": string,
        "avail_for_sale": bool,
        "allow_backorders": bool,
        "in_stock": bool,
        "manage_stock": bool,
        "inventory_level": decimal,
        "min_quantity": decimal,
        "default_qty_in_pack": decimal,
        "is_qty_in_pack_fixed": bool,
        "weight_unit": string,
        "weight": decimal,
        "dimensions_unit": string,
        "width": decimal,
        "height": decimal,
        "length": decimal,
        "additional_fields": {
          ...
        },
        "custom_fields": {
          ...
        }
      },
      ...
    ]
  }
}

{
  "return_code": 0,
  "return_message": "",
  "result": {
    "total_count": 2,
    "children": Array[2][
      {
        "id": "2",
        "parent_id": "1",
        "sku": "test-r",
        "upc": null,
        "ean": null,
        "mpn": null,
        "gtin": null,
        "sort_order": null,
        "created_time": {
          "value": "2017-05-23T12:02:37-0200",
          "format": "Y-m-d\\TH:i:sO"
        },
        "modified_time": {
          "value": "2017-11-01T10:13:22-0200",
          "format": "Y-m-d\\TH:i:sO"
        },
        "name": "test red",
        "short_description": "Short Description",
        "full_description": "<p>test Description</p>",
        "images": Array[1][
          {
            "id": "18",
            "http_path": "http://www.store.com/media/catalog/product/1/a/test.jpg",
            "file_name": "test.jpg",
            "mime-type": null,
            "size": null,
            "create_at": null,
            "modified_at": null,
            "alt": test,
            "avail": true,
            "sort_order": 5,
            "type": "IMAGE_TYPE_SMALL"
          }
        ],
        "combination": Array[1][
          {
            "option_id": "92",
            "option_value_id": "3"
          }
        ],
        "default_price": 209,
        "list_price": null,
        "wholesale_price": null,
        "advanced_price": Array[1][
          {
            "id": "sp",
            "value": 207,
            "avail": true,
            "group_id": null,
            "quantity_from": null,
            "start_time": {
              "value": "2017-09-12T00:00:00-0200",
              "format": "Y-m-d\\TH:i:sO"
            },
            "expire_time": null
          }
        ],
        "tax_class_id": null,
        "avail_for_sale": true,
        "allow_backorders": true,
        "in_stock": true,
        "manage_stock": false,
        "inventory_level": 0,
        "min_quantity": null,
        "default_qty_in_pack": null,
        "is_qty_in_pack_fixed": null,
        "weight_unit": null,
        "weight": 11,
        "dimensions_unit": null,
        "width": null,
        "height": null,
        "length": null,
        "additional_fields": {
          "attribute_set_id": 4
        },
        "custom_fields": {
          "color": "red"
        }
      },
      ...
    ]
  }
}

<response>
<return_code>100</return_code>
<return_message>
Unsupported output format 'xml'. Please use 'json' instead.
</return_message>
<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