apievent-observerordersrest
I have an observer for the event "sales_order_place_after" that needs to take the order and transform it into a JSON object to be sent to an external system (over REST). However the JSON representation should be identical to the same order rendered by the REST API V2 (ie, only showing the attributes defined in api2.xml).
Is there any helper method that can do this?
This api2.xml works:
<config>
<api2>
<resource_groups>
<mymodule translate="title" module="mymodule">
<title>MyCompany Order API</title>
<sort_order>10</sort_order>
</mymodule>
</resource_groups>
<resources>
<mymodule translate="title" module="mymodule">
<group>mymodule</group>
<model>mymodule/api2_order</model>
<title>Order with Extra Fees</title>
<sort_order>10</sort_order>
<privileges>
<admin>
<retrieve>1</retrieve>
</admin>
</privileges>
<attributes translate="entity_id increment_id created_at status shipping_description _payment_method base_currency_code store_currency_code store_name remote_ip store_to_order_rate subtotal subtotal_incl_tax discount_amount base_grand_total grand_total shipping_amount shipping_tax_amount shipping_incl_tax tax_amount _tax_name _tax_rate coupon_code base_discount_amount base_subtotal base_shipping_amount base_shipping_tax_amount base_tax_amount total_paid base_total_paid total_refunded base_total_refunded base_subtotal_incl_tax base_total_due total_due shipping_discount_amount base_shipping_discount_amount discount_description customer_balance_amount base_customer_balance_amount base_customer_balance_amount _gift_message _order_comments customer_id multifees" module="mymodule">
<entity_id>Order ID (internal)</entity_id>
<increment_id>Order ID</increment_id>
<created_at>Order Date</created_at>
<status>Order Status</status>
<shipping_description>Shipping Method</shipping_description>
<_payment_method>Payment Method</_payment_method>
<base_currency_code>Base Currency</base_currency_code>
<store_currency_code>Order Currency</store_currency_code>
<store_name>Store Name</store_name>
<remote_ip>Placed from IP</remote_ip>
<store_to_order_rate>Store Currency to Order Currency Rate</store_to_order_rate>
<subtotal>Subtotal</subtotal>
<subtotal_incl_tax>Subtotal Including Tax</subtotal_incl_tax>
<discount_amount>Discount</discount_amount>
<base_grand_total>Grand Total to Be Charged</base_grand_total>
<grand_total>Grand Total</grand_total>
<shipping_amount>Shipping Amount</shipping_amount>
<shipping_tax_amount>Shipping Including Tax</shipping_tax_amount>
<shipping_incl_tax>Shipping Tax</shipping_incl_tax>
<tax_amount>Tax Amount</tax_amount>
<_tax_name>Tax Name</_tax_name>
<_tax_rate>Tax Rate</_tax_rate>
<coupon_code>Coupon Code</coupon_code>
<base_discount_amount>Base Discount</base_discount_amount>
<base_subtotal>Base Subtotal</base_subtotal>
<base_shipping_amount>Base Shipping</base_shipping_amount>
<base_shipping_tax_amount>Base Shipping Tax</base_shipping_tax_amount>
<base_tax_amount>Base Tax Amount</base_tax_amount>
<total_paid>Total Paid</total_paid>
<base_total_paid>Base Total Paid</base_total_paid>
<total_refunded>Total Refunded</total_refunded>
<base_total_refunded>Base Total Refunded</base_total_refunded>
<base_subtotal_incl_tax>Base Subtotal Including Tax</base_subtotal_incl_tax>
<base_total_due>Base Total Due</base_total_due>
<total_due>Total Due</total_due>
<shipping_discount_amount>Shipping Discount</shipping_discount_amount>
<base_shipping_discount_amount>Base Shipping Discount</base_shipping_discount_amount>
<discount_description>Discount Description</discount_description>
<customer_balance_amount>Customer Balance</customer_balance_amount>
<base_customer_balance_amount>Base Customer Balance</base_customer_balance_amount>
<_gift_message>Gift Message</_gift_message>
<_order_comments>Order Comments</_order_comments>
<customer_id>Customer ID</customer_id>
<multifees>Extra fees</multifees>
</attributes>
<routes>
<route_entity>
<route>/mymodule/orders/:id</route>
<action_type>entity</action_type>
</route_entity>
</routes>
<force_attributes>
<admin>
<payment_method>1</payment_method>
<addresses>1</addresses>
<order_items>1</order_items>
<gift_message_from>1</gift_message_from>
<gift_message_to>1</gift_message_to>
<gift_message_body>1</gift_message_body>
<order_comments>1</order_comments>
<tax_name>1</tax_name>
<tax_rate>1</tax_rate>
</admin>
</force_attributes>
<versions>1</versions>
</mymodule>
</resources>
</api2>
</config>
And the config.xml should look like:
<config>
<global>
...
<models>
<mymodule>
<class>Mynamespace_Mymodule_Model</class>
</mymodule>
</models>
...
</global>
</config>
You are right. You should get the order date back. The field is called created_at.
In case you are not getting it, check if it is allowed in the Attributes section. System->Web Services->REST Attributes and click on the user type Admin.
If you didn't test, and just looked at the link you mentioned in the question then you should try it. I think that link just offers an example. It's not the real thing.
I just did a test and here is what came back:
Array
(
[41] => Array
(
[entity_id] => 41
[status] => pending
[coupon_code] =>
[shipping_description] => United Parcel Service - Ground
[customer_id] =>
[base_discount_amount] => 0.0000
[base_grand_total] => 823.4500
[base_shipping_amount] => 11.5700
[base_shipping_tax_amount] => 0.0000
[base_subtotal] => 750.0000
[base_tax_amount] => 61.8800
[base_total_paid] =>
[base_total_refunded] =>
[discount_amount] => 0.0000
[grand_total] => 823.4500
[shipping_amount] => 11.5700
[shipping_tax_amount] => 0.0000
[store_to_order_rate] => 1.0000
[subtotal] => 750.0000
[tax_amount] => 61.8800
[total_paid] =>
[total_refunded] =>
[base_shipping_discount_amount] => 0.0000
[base_subtotal_incl_tax] => 811.8800
[base_total_due] =>
[shipping_discount_amount] => 0.0000
[subtotal_incl_tax] => 811.8800
[total_due] =>
[increment_id] => 100000049
[base_currency_code] => USD
[discount_description] =>
[remote_ip] => 216.113.168.131
[store_currency_code] => USD
[store_name] => Main Website
Main Website Store
English
[created_at] => 2013-03-15 02:01:34
[shipping_incl_tax] => 11.5700
[base_customer_balance_amount] => 0.0000
[customer_balance_amount] => 0.0000
[payment_method] => checkmo
[gift_message_from] =>
[gift_message_to] =>
[gift_message_body] =>
[tax_name] => US-CA-*-Rate 1
[tax_rate] => 8.2500
[addresses] => Array
(
.....
Notice the created_at field.
I tested with JSON format, but I don't think that makes a difference.
Best Answer
first you will have to build an array as per your requirement than you can encode it be using it.
you can use below method for encoding array into json