magento2ordersrest
Guys I want to update order status using API. I am using this api to change the order status but it's not working:
http://dev-jawed.com/index.php/rest/V1/orders
{
"status" : "Out-for-delivery",
"entity" : 1,
"items": {
"order_id" : 1
}
}
Any help will be appreciated.
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>
Ideally next request must be valid to get all orders
$this->get('rest/V1/orders');
But you get error instead
{"message":"%fieldName is a required field.","parameters":{"fieldName":"searchCriteria"}}
Error occurred because request is processed by
\Magento\Sales\Api\OrderRepositoryInterface::getList(\Magento\Framework\Api\SearchCriteria $searchCriteria)
and $searchCriteria argument is required.
You can skip value for this parameter. Next request must be valid too.
$this->get('rest/V1/orders?searchCriteria');
Best Answer
If you look at the swagger api documents (either on your local machine at /swagger or at the devdocs). You should find the API
V1/orders. If you are using your local version you will also have the button to try to calls direct from swagger which is nice for debugging. From looking through the documents you should be able to post something like the following to the api.Remember to replace the entity_id with the correct order id and the status with the status you would like to change to.