API Version 1

• API V1 Overview
• Vendors
• Stock Levels
• SKU
• Purchase Order
• Products
• Product Variations
• Orders
• Fulfillment
• Customers
• Companies
• 301 Redirect

API Documentation

• Overview
• API V2
• API V1

The Lead Commerce Order API allows you to view, create, and update.

If you are looking for the Fulfillment extension of the Order API, click here.

Views

Views allow you to display data about your orders including line items and shipping information and more. Available output are in xml and json

Example:

<?php  
header("Content-type: text/xml;");  
$credentials = array('identifier' =>  'LC350000000', 'key'=> 'dynKSr4I7y2K3RrPRsFYFJr03IXUbv'); 
$curl = curl_init();  
curl_setopt($curl,CURLOPT_POSTFIELDS, http_build_query($credentials));  
curl_setopt($curl,CURLOPT_POST, 1);  
curl_setopt($curl, CURLOPT_URL, 'http://leadcommercestore.web/api/v1/Orders.xml');
curl_exec($curl);  
curl_close($curl);  
?>

With orders, you can filter the result set also by the sales channel and timeframe.

<?php  
header("Content-type: text/xml;");  
$credentials = array('identifier' => 'LC350000000', 'key'        => 'dynKSr4I7y2K3RrPRsFYFJr03IXUbv',
 'sales_channel'   => 1,
 'placed_start'    => 1395334414,
 'placed_end'      => 1395336987);  
$curl = curl_init();  
curl_setopt($curl,CURLOPT_POSTFIELDS, http_build_query($credentials));  
curl_setopt($curl,CURLOPT_POST, 1);  
curl_setopt($curl, CURLOPT_URL, 'http://leadcommercestore.web/api/v1/Orders.xml');
curl_exec($curl);  
curl_close($curl);  
?>

Please note that the filter "sales_channel" must be a sales channel ID. The placed_start and placed_end is the time parameters when the order was placed. You can use them separately or together.

Filters

Example Output:

<?xml version="1.0" encoding="UTF-8"?>
<message client="192.168.100.208" time="1402076250">
   <response>
      <code>200</code>
      <data>
         <item>
            <order_id>1000</display_id>
            <customer_id>1</customer>
            <sale_channel>1</sale_channel>
            <tax>0.00</tax>
            <shipping>10.00</shipping>
            <shipping_override>N</shipping_override>
            <shipping_account />
            <total>78.97</total>
            <paid>0.00</paid>
            <subtotal>68.97</subtotal>
            <line_item_total>68.97</line_item_total>
            <shipped>N</shipped>
            <placed>6/6/2014 1:32PM</placed>
            <notes />
            <status>Backordered</status>
            <name>Billy Bob</name>
            <email>[email protected]</email>
            <phone>6199900074</phone>e>
            <products>
               <product>
             <line_item>1</line_item>
                  <inventory_sku>1-0003</inventory_sku>
          <inventory_id>3</inventory_id>
                  <product_id>1</product_id>
                  <qty>1</qty>
                  <committed>0</committed>
                  <price>22.99</price>
                  <subtotal>22.99</subtotal>
                  <tax>0.00</tax>
                  <can_ship>Y</can_ship>
                  <discount_type>0</discount_type>
                  <discount_number>0.00</discount_number>
                  <total>22.99</total>
                  <status>Backordered</status>
               </product>
               <product>
             <line_item>2</line_item>
                  <inventory_sku>1-0002</inventory_sku>
          <product_id>1</product_id>
                  <inventory_id>2</product_id>
                  <qty>1</qty>
                  <committed>0</committed>
                  <price>22.99</price>
                  <subtotal>22.99</subtotal>
                  <tax>0.00</tax>
                  <can_ship>Y</can_ship>
                  <discount_type>0</discount_type>
                  <discount_number>0.00</discount_number>
                  <total>22.99</total>
                  <status>Backordered</status>
               </product>
               <product>
             <line_item>3</line_item>
                  <inventory_sku>1-0001</inventory_sku>
                  <product_id>1</product_id>
          <inventory_id>1</inventory_id>
                  <qty>1</qty>
                  <committed>0</committed>
                  <price>22.99</price>
                  <subtotal>22.99</subtotal>
                  <tax>0.00</tax>
                  <can_ship>Y</can_ship>
                  <discount_type>0</discount_type>
                  <discount_number>0.00</discount_number>
                  <total>22.99</total>
                  <status>Backordered</status>
               </product>
            </products>
            <fulfillments>
               <fulfillment>
          <fulfillment_id>27</fulfillment_id>
                  <shipping_provider_class>51</shipping_provider_class>
          <shipping_provider>5</shipping_provider>
                  <line_items>3</line_items>
                  <total_items>3</total_items>
                  <warehouse>1</warehouse>
          <customer_address>7</customer_address>
              <products>
                <product>
                <qty>1</qty>
                <line_item>1</line_item>
                <customer_address>7</customer_address>
                </product>
            </products>
               </fulfillment>
            </fulfillments>
        <payments>
        <payment>
            <payment_id>3</payment_id>
            <payment_gateway>Cash</payment_gateway>
            <payment_gateway_id>2</payment_gateway_id>
            <amount>26.80</amount>
            <customer_address>7</customer_address>
            <data1>Additional Data 1</data1>
            <data2>Additional Data 2</data2>
            <data3/>
            <data4/>
            <received>8/18/2014 1:50PM</received>
        </payment>
        </payments>
         </item>
      </data>
   </response>
</message>

Create

Create allows you to create Orders as if you went through the Lead Commerce Back Office. Refer to the Data Points table below to learn which data points can be passed when creating Orders.

Data Points

Products

All product data is a subvalue under the array value "products"

Payments

All payment data is a subvalue under the array value "payments". This will allow for payments to be made. You can use multiple payments for

Customer Address

All payment data is a subvalue under the array value "address". This section will create the address for the customer. This is not required.

Example:

<?php  
header("Content-type: text/xml;");  
$insert = array('sales_channel'         => '1',
                'customer_type'       => 1,
                'shipping_cost'       => 10.00,
                'customer'          =>array(
                                    'first'               => "Jack",
                                    'last'                => "Jones",
                                    'phone'               => "619.555.1212",
                                    'email'               => " [email protected]"),
                'shipping_provider'         => '5',
                'products'    => array(array('sku'    => '1000-0003',
                                              'qty'        => '1',
                                              'shipping_class'    => '51',
                                              'address' => array('full_name'         => 'Leo DeCappuccino',
                                                         'address_1'         => '5000 Parkway Avenue',
                                                         'city'              => 'Los Angeles',
                                                         'subregion'         => 'California',
                                                         'postal_code'       => '90210',
                                                         'phone'             => '310-555-6789',
                                                         'default_billing'   => 1),
                                              'price'       => '16.80',
                                              'tax'    => '0'),
                                        ),
                'payments'    => array(array('amount'    => 26.80,
                                              'data1'    => 'Additional Data 1',
                                              'data2'    => 'Additional Data 2'
                                              ),
                                        ),
                );
$credentials = array('identifier' => 'LC350000000', 'key'        => 'dynKSr4I7y2K3RrPRsFYFJr03IXUbv', 'inserts'    => array($insert)); 
$curl = curl_init();  
curl_setopt($curl,CURLOPT_POSTFIELDS, http_build_query($credentials));  
curl_setopt($curl,CURLOPT_POST, 1);  
curl_setopt($curl, CURLOPT_URL, 'http://leadcommercestore.web/api/v1/Orders.xml/create.xml');
curl_exec($curl);  
curl_close($curl);  
?>