NewHavenSoftware_CMSAPI - Version 9.0.1.9

Version Notes

9.0.1.9 10/14/2013

In the V2 API changed the salesOrderInfo item.product_options from serialized php to json text for configurable product attribute information used during order download into CMS.

9.0.1.8 09/18/2013

Added cmsapiGiftMessageInfo to the V2 api that will return an object with to,from, and message values. See the NewHaven Software Magento Setup Guide for more information about the message template plug-in option.

9.0.1.7

The first Amasty Order Attributes implementation was not working properly. In this release added more flexible support for custom fields. You can now define a custom field with this syntax: CLASS_API/path/fieldName. For Amasty this would be: Amasty_Orderattr_Model_Sales_Order_Api/custom/fieldName the limitation here is the class must have an info method that accepts the order increment ID as the parameter. Also the field names all need to be unique.

Download this release

Release Info

Developer Jason Morrison
Extension NewHavenSoftware_CMSAPI
Version 9.0.1.9
Comparing to
See all releases


Code changes from version 9.0.1.8 to 9.0.1.9

Files changed (4) hide show
  1. app/code/community/NewHavenSoftware/CMSAPI/Model/Sales/Order/Api/V2.php +13 -0
  2. app/code/community/NewHavenSoftware/CMSAPI/etc/api.xml +12 -0
  3. app/code/community/NewHavenSoftware/CMSAPI/etc/config.xml +6 -1
  4. package.xml +18 -39
app/code/community/NewHavenSoftware/CMSAPI/Model/Sales/Order/Api/V2.php ADDED
@@ -0,0 +1,13 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <?php
2
+ class NewHavenSoftware_CMSAPI_Model_Sales_Order_Api_V2 extends Mage_Sales_Model_Order_Api_V2 {
3
+ public function info($orderIncrementId) {
4
+ $result = parent::info($orderIncrementId);
5
+
6
+ // Deserialize item['product_options'] and reserialize as json
7
+ foreach($result['items'] as $key => $item) {
8
+ $product_options = unserialize($item['product_options']);
9
+ $result['items'][$key]['product_options'] = json_encode($product_options);
10
+ }
11
+ return $result;
12
+ }
13
+ }
app/code/community/NewHavenSoftware/CMSAPI/etc/api.xml CHANGED
@@ -35,6 +35,17 @@
35
  </info>
36
  </methods>
37
  </cmsapi_gift_message>
 
 
 
 
 
 
 
 
 
 
 
38
  <cmsapi_catalog_product>
39
  <model>cmsapi/catalog_product_api</model>
40
  <acl>catalog/product</acl>
@@ -82,6 +93,7 @@
82
  <cmsapi_check>cmsapiCheck</cmsapi_check>
83
  <cmsapi_custom>cmsapiCustom</cmsapi_custom>
84
  <cmsapi_catalog_product>cmsapiCatalogProduct</cmsapi_catalog_product>
 
85
  <cmsapi_gift_message>cmsapiGiftMessage</cmsapi_gift_message>
86
  </resources_function_prefix>
87
  </v2>
35
  </info>
36
  </methods>
37
  </cmsapi_gift_message>
38
+ <cmsapi_sales_order>
39
+ <model>cmsapi/sales_order_api</model>
40
+ <acl>sales/order</acl>
41
+ <title>Order API</title>
42
+ <methods>
43
+ <info translate="title" module="sales">
44
+ <title>Get Order Info</title>
45
+ <acl>sales/order/info</acl>
46
+ </info>
47
+ </methods>
48
+ </cmsapi_sales_order>
49
  <cmsapi_catalog_product>
50
  <model>cmsapi/catalog_product_api</model>
51
  <acl>catalog/product</acl>
93
  <cmsapi_check>cmsapiCheck</cmsapi_check>
94
  <cmsapi_custom>cmsapiCustom</cmsapi_custom>
95
  <cmsapi_catalog_product>cmsapiCatalogProduct</cmsapi_catalog_product>
96
+ <cmsapi_sales_order>cmsapiSalesOrder</cmsapi_sales_order>
97
  <cmsapi_gift_message>cmsapiGiftMessage</cmsapi_gift_message>
98
  </resources_function_prefix>
99
  </v2>
app/code/community/NewHavenSoftware/CMSAPI/etc/config.xml CHANGED
@@ -3,7 +3,7 @@
3
  <config>
4
  <modules>
5
  <NewHavenSoftware_CMSAPI>
6
- <version>9.0.1.8</version>
7
  </NewHavenSoftware_CMSAPI>
8
  </modules>
9
  <global>
@@ -16,6 +16,11 @@
16
  <product_api_v2>NewHavenSoftware_CMSAPI_Model_Catalog_Product_Api_V2</product_api_v2>
17
  </rewrite>
18
  </catalog>
 
 
 
 
 
19
  </models>
20
  <helpers>
21
  <cmsapi>
3
  <config>
4
  <modules>
5
  <NewHavenSoftware_CMSAPI>
6
+ <version>9.0.1.9</version>
7
  </NewHavenSoftware_CMSAPI>
8
  </modules>
9
  <global>
16
  <product_api_v2>NewHavenSoftware_CMSAPI_Model_Catalog_Product_Api_V2</product_api_v2>
17
  </rewrite>
18
  </catalog>
19
+ <sales>
20
+ <rewrite>
21
+ <order_api_v2>NewHavenSoftware_CMSAPI_Model_Sales_Order_Api_V2</order_api_v2>
22
+ </rewrite>
23
+ </sales>
24
  </models>
25
  <helpers>
26
  <cmsapi>
package.xml CHANGED
@@ -1,57 +1,36 @@
1
  <?xml version="1.0"?>
2
  <package>
3
  <name>NewHavenSoftware_CMSAPI</name>
4
- <version>9.0.1.8</version>
5
  <stability>stable</stability>
6
  <license uri="http://opensource.org/licenses/osl-3.0.php">OSL v3.0</license>
7
  <channel>community</channel>
8
  <extends/>
9
  <summary>This extension extends the v2 API for integration with NewHaven Software's Commerce Management System.</summary>
10
- <description>This extension extends the v2 API for integration with NewHaven Software's Commerce Management System (CMS).&#xD;
11
  &#xD;
12
  Adds the following to the v2 API:&#xD;
13
- &lt;ol&gt;&lt;ul&gt;&lt;strong&gt;cmsapiChecknhsInstalled:&lt;/strong&gt; To verify this extension has been added to the API&lt;/ul&gt;&lt;ul&gt;&lt;strong&gt;cmsapiCustomFields:&lt;/strong&gt; This API call is used to get order level data based on the fields entered in System Configuration that may not be published in the v2 API&lt;/ul&gt;&lt;ul&gt;Extend &lt;strong&gt;catalogProductCreate:&lt;/strong&gt; to allow the passing of additional productdata fields: configurable_products and configurable_attributes (structure documented in the wsdl) &lt;/ul&gt;&#xD;
 
 
 
 
14
  &lt;/ol&gt;&#xD;
15
  &#xD;
16
- This extension is required for integration with the CMS eCMS module.</description>
17
- <notes>9.0.1.8&#xD;
18
- Added cmsapiGiftMessageInfo to the V2 api that will return an object with to,from, and message values. See the NewHaven Software Magento Setup Guide for more information about the message template plug-in option.&#xD;
19
  &#xD;
20
- 9.0.1.7&#xD;
21
- The first Amasty Order Attributes implementation was not working properly. In this release added more flexible support for custom fields. You can now define a custom field with this syntax: CLASS_API/path/fieldName. For Amasty this would be: Amasty_Orderattr_Model_Sales_Order_Api/custom/fieldName the limitation here is the class must have an info method that accepts the order increment ID as the parameter. Also the field names all need to be unique. &#xD;
22
  &#xD;
23
- 9.0.1.6&#xD;
24
- Removed error data introduced in 9.0.1.5&#xD;
25
- &#xD;
26
- 9.0.1.5&#xD;
27
- Added support for Amasty Order Attributes for use with custom fields&#xD;
28
- &#xD;
29
- 9.0.1.4&#xD;
30
- Removed unneeded module dependency. Added the ability to set global custom_field values.&#xD;
31
- &#xD;
32
- In addition to a comma delimited list of order fields. You can now add name=value in the Custom Fields list. These will be sent with every order. &#xD;
33
- &#xD;
34
- In CMS add a matching custom field plug-in option:&#xD;
35
- Name: CMS XML element name to store the data&#xD;
36
- Value: the custom field name specified in Magento&#xD;
37
- Type: Custom Field&#xD;
38
- &#xD;
39
- If no mapping plug-in option is found, the values will appear in the order notes.&#xD;
40
- &#xD;
41
- 9.0.1.3&#xD;
42
- Changed module dependency to Mage_Api&#xD;
43
- &#xD;
44
- 9.0.1.2&#xD;
45
- Added app/etc/modules/NewHavenSoftware_CMSAPI.xml file to enable the extension.&#xD;
46
- &#xD;
47
- 9.0.1.1&#xD;
48
- Added cmsapiCustomFields to the v2 API. This API call is used to get order level data based on the fields entered in System Configuration&#xD;
49
- &#xD;
50
- Added configuration option "NewHaven Software Settings" to the Services tab of System&gt;Configuration. This provides the custom fields setting. Enter a comma delimited list of order level attributes that may be custom and not available in the v2 API.</notes>
51
  <authors><author><name>Jason Morrison</name><user>jmorrison</user><email>jmorrison@newhavensoftware.com</email></author></authors>
52
- <date>2013-09-18</date>
53
- <time>20:37:54</time>
54
- <contents><target name="magecommunity"><dir name="NewHavenSoftware"><dir name="CMSAPI"><dir name="Helper"><file name="Data.php" hash="ab4082fe27f7c6732a7f857fc326ec99"/></dir><dir name="Model"><dir name="Catalog"><dir name="Product"><dir name="Api"><file name="V2.php" hash="aad926da6a10b2c2de3c28abac0eaf52"/></dir></dir></dir><dir name="Check"><dir name="Api"><file name="V2.php" hash="c27fcf391dcf5ad7e0c86de44fd14e7c"/></dir></dir><dir name="Custom"><dir name="Api"><file name="V2.php" hash="6e720e7e3704257a045905a1f639eaa5"/></dir></dir><dir name="Gift"><dir name="Api"><file name="V2.php" hash="bf989c37e7277dd55b50e378e15cd19a"/></dir><dir name="Message"><dir name="Api"><file name="V2.php" hash="0a5ffdd3fc3760b311970169858d5475"/></dir></dir></dir></dir><dir name="etc"><file name="adminhtml.xml" hash="ba4c36dbd3d346c3561fb5822d5fd3b4"/><file name="api.xml" hash="aa7bd3dce22dfa8ed65403c48fe6de9a"/><file name="config.xml" hash="94b6801f25d75ceb6519c36a07432aaf"/><file name="system.xml" hash="ab6f7ba6be148634383f9e3a8f63e2cd"/><file name="wsdl.xml" hash="93ea17ae19287afccf46543c1ac01a30"/></dir></dir></dir></target><target name="mageetc"><dir name="modules"><file name="NewHavenSoftware_CMSAPI.xml" hash="f858d97574f528dc237ad32e0e96ae73"/></dir></target></contents>
55
  <compatible/>
56
  <dependencies><required><php><min>5.2.0</min><max>5.5.3</max></php></required></dependencies>
57
  </package>
1
  <?xml version="1.0"?>
2
  <package>
3
  <name>NewHavenSoftware_CMSAPI</name>
4
+ <version>9.0.1.9</version>
5
  <stability>stable</stability>
6
  <license uri="http://opensource.org/licenses/osl-3.0.php">OSL v3.0</license>
7
  <channel>community</channel>
8
  <extends/>
9
  <summary>This extension extends the v2 API for integration with NewHaven Software's Commerce Management System.</summary>
10
+ <description>This extension extends the v2 API for integration with NewHaven Software's Commerce Management System (CMS).&lt;br /&gt;&lt;br /&gt;&#xD;
11
  &#xD;
12
  Adds the following to the v2 API:&#xD;
13
+ &lt;ol&gt;&lt;ul&gt;&lt;strong&gt;cmsapiChecknhsInstalled:&lt;/strong&gt; To verify this extension has been added to the API&lt;/ul&gt;&#xD;
14
+ &lt;ul&gt;&lt;strong&gt;cmsapiCustomFields:&lt;/strong&gt; This API call is used to get order level data based on the fields entered in System Configuration that may not be published in the v2 API&lt;/ul&gt;&#xD;
15
+ &lt;ul&gt;&lt;strong&gt;cmsapiGiftMessageInfo:&lt;/strong&gt; This API call is used to gain access to the "To" and "From" fields used in gift messages&lt;/ul&gt;&#xD;
16
+ &lt;ul&gt;Extend &lt;strong&gt;catalogProductCreate:&lt;/strong&gt; to allow the passing of additional productdata fields: configurable_products and configurable_attributes (structure documented in the wsdl) &lt;/ul&gt;&#xD;
17
+ &lt;ul&gt;Extend &lt;strong&gt;salesProductInfo:&lt;/strong&gt; for items the product_options property was changed to json (from serialized php). This is required for downloading orders containing configurable products&lt;/ul&gt;&#xD;
18
  &lt;/ol&gt;&#xD;
19
  &#xD;
20
+ This extension is recommended for integration with the CMS eCMS module.&lt;br /&gt;&lt;br /&gt;</description>
21
+ <notes>&lt;strong&gt;9.0.1.9&lt;/strong&gt; 10/14/2013&lt;br /&gt;&#xD;
22
+ In the V2 API changed the salesOrderInfo item.product_options from serialized php to json text for configurable product attribute information used during order download into CMS.&lt;br /&gt;&lt;br /&gt;&#xD;
23
  &#xD;
24
+ &lt;strong&gt;9.0.1.8&lt;/strong&gt; 09/18/2013&lt;br /&gt;&#xD;
25
+ Added cmsapiGiftMessageInfo to the V2 api that will return an object with to,from, and message values. See the NewHaven Software Magento Setup Guide for more information about the message template plug-in option.&lt;br /&gt;&lt;br /&gt;&#xD;
26
  &#xD;
27
+ &lt;strong&gt;9.0.1.7&lt;/strong&gt;&lt;br /&gt;&#xD;
28
+ The first Amasty Order Attributes implementation was not working properly. In this release added more flexible support for custom fields. You can now define a custom field with this syntax: CLASS_API/path/fieldName. For Amasty this would be: Amasty_Orderattr_Model_Sales_Order_Api/custom/fieldName the limitation here is the class must have an info method that accepts the order increment ID as the parameter. Also the field names all need to be unique. &lt;br /&gt;&lt;br /&gt;&#xD;
29
+ </notes>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
30
  <authors><author><name>Jason Morrison</name><user>jmorrison</user><email>jmorrison@newhavensoftware.com</email></author></authors>
31
+ <date>2013-10-14</date>
32
+ <time>19:48:15</time>
33
+ <contents><target name="magecommunity"><dir name="NewHavenSoftware"><dir name="CMSAPI"><dir name="Helper"><file name="Data.php" hash="ab4082fe27f7c6732a7f857fc326ec99"/></dir><dir name="Model"><dir name="Catalog"><dir name="Product"><dir name="Api"><file name="V2.php" hash="aad926da6a10b2c2de3c28abac0eaf52"/></dir></dir></dir><dir name="Check"><dir name="Api"><file name="V2.php" hash="c27fcf391dcf5ad7e0c86de44fd14e7c"/></dir></dir><dir name="Custom"><dir name="Api"><file name="V2.php" hash="6e720e7e3704257a045905a1f639eaa5"/></dir></dir><dir name="Gift"><dir name="Api"><file name="V2.php" hash="bf989c37e7277dd55b50e378e15cd19a"/></dir><dir name="Message"><dir name="Api"><file name="V2.php" hash="0a5ffdd3fc3760b311970169858d5475"/></dir></dir></dir><dir name="Sales"><dir name="Order"><dir name="Api"><file name="V2.php" hash="03443ab449fb867f4a5bb08877bea5d6"/></dir></dir></dir></dir><dir name="etc"><file name="adminhtml.xml" hash="ba4c36dbd3d346c3561fb5822d5fd3b4"/><file name="api.xml" hash="1fa0bb1db0aa578270f5bc210e66daac"/><file name="config.xml" hash="cdbcd30695f2536cd40633348d9d1d14"/><file name="system.xml" hash="ab6f7ba6be148634383f9e3a8f63e2cd"/><file name="wsdl.xml" hash="93ea17ae19287afccf46543c1ac01a30"/></dir></dir></dir></target><target name="mageetc"><dir name="modules"><file name="NewHavenSoftware_CMSAPI.xml" hash="f858d97574f528dc237ad32e0e96ae73"/></dir></target></contents>
34
  <compatible/>
35
  <dependencies><required><php><min>5.2.0</min><max>5.5.3</max></php></required></dependencies>
36
  </package>