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

We've released API v1.1. The API2Cart v1.0 API will be supported until the end of 2018.

Learn More

order.list

This method allows to receive list of orders from the store. It returns four orders by default. Below you will find all necessary parameters 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,
  "result":{
    "orders_count": int,
    "order":[ array
      {
        "id": string,
        "order_id": string,
        "customer":[ array
          {
            "id": string,
            "email": string,
            "first_name": string,
            "last_name": string
          }
        ],
        "create_at": string,
        "currency":[ array
          {
            "name": string,
            "iso3": string,
            "code": deprecated,
            "symbol_left": string,
            "symbol_right": string,
            "rate": decimal
          }
        ],
        "billing_address":[ array
          {
            "id": string,
            "type": string,
            "first_name": string,
            "last_name": string,
            "postcode": string,
            "address1": string,
            "address2": string,
            "phone": string,
            "city": string,
            "country":[ array
              {
                "code2": string,
                "code3": string,
                "name": string
              }
            ],
            "state":[ array
              {
                "code": string,
                "name": string
              }
            ],
            "company": string,
            "fax": string,
            "website": string,
            "gender": string,
            "region": string,
            "default": string,
            "tax_id": string
          }
        ],
        "shipping_address":[ array
          {
            "id": string,
            "type": string,
            "first_name": string,
            "last_name": string,
            "postcode": string,
            "address1": string,
            "address2": string,
            "phone": string,
            "city": string,
            "country":[ array
              {
                "code2": string,
                "code3": string,
                "name": string
              }
            ],
            "state":[ array
              {
                "code": string,
                "name": string
              }
            ],
            "company": string,
            "fax": string,
            "website": string,
            "gender": string,
            "region": string,
            "default": string,
            "tax_id": string
          }
        ],
        "payment_method":[ array
          {
            "name": string
          }
        ],
        "shipping_method":[ array
          {
            "name": string
          }
        ],
        "shipping_methods":[ array
          {
            "name": string
          }
        ],
        "status":[ array
          {
            "id": string,
            "name": string,
            "history":[ array
              {
                "history":[ array
                  {
                    "id": string,
                    "name": string,
                    "modified_time": string,
                    "notify": string,
                    "comment": string
                  }
                  ...
                ]
              }
            ],
            "refund_info":[ array
              {
                "shipping": decimal,
                "fee": decimal,
                "total_refunded": decimal,
                "tax": decimal,
                "time": string,
                "comment": string,
                "refunded_items":[ array
                  {
                    "items":[ array
                      {
                        "product_id": string,
                        "variant_id": string,
                        "qty": int,
                        "refund": decimal
                      },
                      ...
                    ]
                  }
                ]
              }
            ],
          }
        ],
        "totals":[ array
          {
            "total": decimal,
            "subtotal": decimal,
            "shipping": decimal,
            "tax": decimal,
            "discount": decimal
          }
        ],
        "total":[array
          {
            "subtotal_ex_tax": decimal,
            "wrapping_ex_tax": decimal,
            "shipping_ex_tax": decimal,
            "total_discount": decimal,
            "total_tax": decimal,
            "total": decimal,
            "additional_attributes": [array
              {
                "shipping_discount_ex_tax": decimal,
                "subtotal_discount_ex_tax": decimal,
                "subtotal_tax": decimal,
                "wrapping_tax": decimal,
                "shipping_tax": decimal
              }
            ]
          }
        ],
        "order_products":[ array
          {
            "product":[ array
              {
                "product_id": string,
                "order_product_id": string,
                "model": string,
                "name": string,
                "price": decimal,
                "quantity": int,
                "total_price": decimal,
                "tax_percent": decimal,
                "tax_value": decimal,
                "variant_id": string
              }
            ]
          }
        ],
        "modified_at": string,
        "finished_time": string,
        "comment": string,
        "store_id": string
      }
      ...
    ]
  }
}

 Response Example

 

{
  "return_code":0,
  "return_message":"",
  "result":{
    "orders_count":5,
    "order":[
      {
        "id":"1",
        "customer":[
          {
            "id":"26",
            "email":"molestie.in@molestiesodales.co.uk",
            "first_name":"Adara",
            "last_name":"Cortez"
          }
        ],
        "status":[
          {
            "id":"3",
            "name":"Shipped",
            "history":[
              {
                "history":[
                  {
                    "id":"3",
                    "name":"Shipped",
                    "modified_time":"2014-03-25 15:29:00",
                    "notify":"True",
                    "comment":"Make Payable To: \nFrost\n\nSend To: \nAddress 1\n\nYour order will not ship until we receive payment.\n"
                  }
                ]
              }
            ],
            "refund_info": null
          }
        ]
      },
      {
        "id":"2",
        "customer":[
          {
            "id":"26",
            "email":"molestie.in@molestiesodales.co.uk",
            "first_name":"Adara",
            "last_name":"Cortez"
          }
        ],
        "status":[
          {
            "id":"1",
            "name":"Pending",
            "history":[
              {
                "history":[
                  {
                    "id":"1",
                    "name":"Pending",
                    "modified_time":"2014-03-25 15:30:58",
                    "notify":"True",
                    "comment":""
                  }
                ]
              }
            ],
            "refund_info": null
          }
        ]
      },
      {
        "id":"3",
        "customer":[
          {
            "id":"26",
            "email":"molestie.in@molestiesodales.co.uk",
            "first_name":"Adara",
            "last_name":"Cortez"
          }
        ],
        "status":[
          {
            "id":"1",
            "name":"Pending",
            "history":[
              {
                "history":[
                  {
                    "id":"1",
                    "name":"Pending",
                    "modified_time":"2014-03-25 15:31:57",
                    "notify":"True",
                    "comment":""
                  }
                ]
              }
            ],
            "refund_info": null
          }
        ]
      },
      {
        "id":"4",
        "customer":[
          {
            "id":"25",
            "email":"quis.lectus.Nullam@egetlacusMauris.co.uk",
            "first_name":"Adara",
            "last_name":"Huffman"
          }
        ],
        "status":[
          {
            "id":"3",
            "name":"Shipped",
            "history":[
              {
                "history":[
                  {
                    "id":"3",
                    "name":"Shipped",
                    "modified_time":"2014-03-25 15:34:52",
                    "notify":"True",
                    "comment":"Make Payable To: \nFrost\n\nSend To: \nAddress 1\n\nYour order will not ship until we receive payment.\n"
                  }
                ]
              }
            ],
            "refund_info": null
          }
        ]
      },
      {
        "id":"5",
        "customer":[
          {
            "id":"12",
            "email":"rutrum.justo.Praesent@risus.net",
            "first_name":"Darrel",
            "last_name":"Knapp"
          }
        ],
        "status":[
          {
            "id":"3",
            "name":"Shipped",
            "history":null,
            "refund_info":[
              {
                "shipping":0,
                "fee":0,
                "tax":0,
                "total_refunded":-38,
                "time":"2015-04-02 10:54:56",
                "comment":"Product Did Not Meet Customer’s Expectations",
                "refunded_items": [
                  {
                    "items": [
                      {
                        "product_id": "50",
                        "variant_id": "50",
                        "qty": 1,
                        "refund": -35
                      },
                      {
                        "product_id": "93",
                        "variant_id": "93",
                        "qty": 1,
                        "refund": -3
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <return_code>0</return_code>
  <return_message />
  <result>
    <orders_count>5</orders_count>
    <order>
      <id>1</id>
      <customer>
        <id>26</id>
        <email>molestie.in@molestiesodales.co.uk</email>
        <first_name>Adara</first_name>
        <last_name>Cortez</last_name>
      </customer>
      <status>
        <id>3</id>
        <name>Shipped</name>
        <history>
          <history>
            <id>3</id>
            <name>Shipped</name>
            <modified_time>2014-03-25 15:29:00</modified_time>
            <notify>True</notify>
            <comment>Make Payable To:
Frost

Send To:
Address 1

Your order will not ship until we receive payment.</comment>
          </history>
        </history>
        <refund_info></refund_info>
      </status>
    </order>
    <order>
      <id>2</id>
      <customer>
        <id>26</id>
        <email>molestie.in@molestiesodales.co.uk</email>
        <first_name>Adara</first_name>
        <last_name>Cortez</last_name>
      </customer>
      <status>
        <id>1</id>
        <name>Pending</name>
        <history>
          <history>
            <id>1</id>
            <name>Pending</name>
            <modified_time>2014-03-25 15:30:58</modified_time>
            <notify>True</notify>
            <comment />
          </history>
        </history>
        <refund_info></refund_info>
      </status>
    </order>
    <order>
      <id>3</id>
      <customer>
        <id>26</id>
        <email>molestie.in@molestiesodales.co.uk</email>
        <first_name>Adara</first_name>
        <last_name>Cortez</last_name>
      </customer>
      <status>
        <id>1</id>
        <name>Pending</name>
        <history>
          <history>
            <id>1</id>
            <name>Pending</name>
            <modified_time>2014-03-25 15:31:57</modified_time>
            <notify>True</notify>
            <comment />
          </history>
        </history>
        <refund_info></refund_info>
      </status>
    </order>
    <order>
      <id>4</id>
      <customer>
        <id>25</id>
        <email>quis.lectus.Nullam@egetlacusMauris.co.uk</email>
        <first_name>Adara</first_name>
        <last_name>Huffman</last_name>
      </customer>
      <status>
        <id>3</id>
        <name>Shipped</name>
        <history>
          <history>
            <id>3</id>
            <name>Shipped</name>
            <modified_time>2014-03-25 15:34:52</modified_time>
            <notify>True</notify>
            <comment>Make Payable To:
Frost

Send To:
Address 1

Your order will not ship until we receive payment.</comment>
          </history>
        </history>
        <refund_info></refund_info>
      </status>
    </order>
    <order>
      <id>5</id>
      <customer>
        <id>12</id>
        <email>rutrum.justo.Praesent@risus.net</email>
        <first_name>Darrel</first_name>
        <last_name>Knapp</last_name>
      </customer>
      <status>
        <id>3</id>
        <name>Shipped</name>
        <history>
          <history>
            <id>3</id>
            <name>Shipped</name>
            <modified_time>2014-03-25 15:38:45</modified_time>
            <notify>True</notify>
            <comment>Make Payable To:
Frost

Send To:
Address 1

Your order will not ship until we receive payment.</comment>
          </history>
        </history>
        <refund_info></refund_info>
      </status>
    </order>
  </result>
</response>

 Request Example

https://api.api2cart.com/v1.0/order.list.xml?api_key=e3d14cb857bb7c271f26c1fbe2b00470 &store_key=cfce78a77cc4r46ab02ca75aee5d4398 &customer_id=5 &customer_email=jubari@hannsgroup.com &order_status=Completed &start=0 &count=20 &sort_by=modified_at &sort_direction=asc &params=order_id,totals,status &exclude=order_id,totals,status &created_to=2100-08-29 13:45:52 &created_from=2010-07-29 13:45:52 &modified_to=2100-08-29 13:45:52 &modified_from=2010-07-29 13:45:52 &store_id=1 &ids=24,25 &order_ids=24,25 &financial_status=paid &fulfillment_status=fulfilled &shipping_method=flatrate_flatrate

 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'  => 5,
  'params' => 'id,customer,status'
);

try {

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

  echo "Orders count: " . $result->orders_count . "\n" .
       "Orders list: \n";

  foreach($result->order[0] as $order) {

    $customer = $order->customer[0];
    $status   = $order->status[0];

    echo "Order ID: "       . $order->id       . "\n" .
         "Customer email: " . $customer->email . "\n" .
         "Order status: "   . $status->name    . "\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

 Try Now (Swagger)

back to top

Need help?

Let me help you live.

×Chat now