How to cancel an order by the «/V1/orders/:id/cancel» Web API?

dmitry_fedyuk · April 25, 2016, 6:01pm

Interface

magento/magento2/blob/958164/app/code/Magento/Sales/etc/webapi.xml#L28-L33


<route url="/V1/orders/:id/cancel" method="POST">
    <service class="Magento\Sales\Api\OrderManagementInterface" method="cancel"/>
    <resources>
        <resource ref="Magento_Sales::sales" />
    </resources>
</route>

github.com

magento/magento2/blob/958164/app/code/Magento/Sales/Api/OrderManagementInterface.php#L21-L27


/**
 * Cancels a specified order.
 *
 * @param int $id The order ID.
 * @return bool
 */
public function cancel($id);

Implementation

github.com

magento/magento2/blob/958164/app/code/Magento/Sales/etc/di.xml#L56-L56


<preference for="Magento\Sales\Api\OrderManagementInterface" type="Magento\Sales\Model\Service\OrderService"/>

github.com

magento/magento2/blob/958164/app/code/Magento/Sales/Model/Service/OrderService.php#L81-L96


/**
 * Order cancel
 *
 * @param int $id
 * @return bool
 */
public function cancel($id)
{
    $order = $this->orderRepository->get($id);
    if ((bool)$order->cancel()) {
        $this->orderRepository->save($order);
        return true;
    }


    return false;
}

A usage example

github.com

magento/magento2/blob/958164/dev/tests/api-functional/testsuite/Magento/Sales/Service/V1/OrderCancelTest.php#L22-L36


$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
$order = $objectManager->get('Magento\Sales\Model\Order')->loadByIncrementId('100000001');
$serviceInfo = [
    'rest' => [
        'resourcePath' => '/V1/orders/' . $order->getId() . '/cancel',
        'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST,
    ],
    'soap' => [
        'service' => self::SERVICE_NAME,
        'serviceVersion' => self::SERVICE_VERSION,
        'operation' => self::SERVICE_NAME . 'cancel',
    ],
];
$requestData = ['id' => $order->getId()];
$result = $this->_webApiCall($serviceInfo, $requestData);

dmitry_fedyuk · April 25, 2016, 6:03pm