Automattic\WooCommerce\StoreApi\Routes\V1

Checkout::get_route_post_response()protectedWC 1.0

Process an order.

  1. Obtain Draft Order
  2. Process Request
  3. Process Customer
  4. Validate Order
  5. Process Payment

Method of the class: Checkout{}

Return

\WP_REST_Response.

Usage

// protected - for code of main (parent) or child class
$result = $this->get_route_post_response( $request );
$request(\WP_REST_Request) (required)
Request object.

Checkout::get_route_post_response() code WC 9.3.3

protected function get_route_post_response( \WP_REST_Request $request ) {
	/**
	 * Before triggering validation, ensure totals are current and in turn, things such as shipping costs are present.
	 * This is so plugins that validate other cart data (e.g. conditional shipping and payments) can access this data.
	 */
	$this->cart_controller->calculate_totals();

	/**
	 * Validate items and fix violations before the order is processed.
	 */
	$this->cart_controller->validate_cart();

	/**
	 * Validate additional fields on request.
	 */
	$this->validate_required_additional_fields( $request );

	/**
	 * Persist customer session data from the request first so that OrderController::update_addresses_from_cart
	 * uses the up to date customer address.
	 */
	$this->update_customer_from_request( $request );

	/**
	 * Create (or update) Draft Order and process request data.
	 */
	$this->create_or_update_draft_order( $request );
	$this->update_order_from_request( $request );
	$this->process_customer( $request );

	/**
	 * Validate updated order before payment is attempted.
	 */
	$this->order_controller->validate_order_before_payment( $this->order );

	/**
	 * Reserve stock for the order.
	 *
	 * In the shortcode based checkout, when POSTing the checkout form the order would be created and fire the
	 * `woocommerce_checkout_order_created` action. This in turn would trigger the `wc_reserve_stock_for_order`
	 * function so that stock would be held pending payment.
	 *
	 * Via the block based checkout and Store API we already have a draft order, but when POSTing to the /checkout
	 * endpoint we do the same; reserve stock for the order to allow time to process payment.
	 *
	 * Note, stock is only "held" while the order has the status wc-checkout-draft or pending. Stock is freed when
	 * the order changes status, or there is an exception.
	 *
	 * @see ReserveStock::get_query_for_reserved_stock()
	 *
	 * @since 9.2 Stock is no longer held for all draft orders, nor on non-POST requests. See https://github.com/woocommerce/woocommerce/issues/44231
	 * @since 9.2 Uses wc_reserve_stock_for_order() instead of using the ReserveStock class directly.
	 */
	try {
		wc_reserve_stock_for_order( $this->order );
	} catch ( ReserveStockException $e ) {
		throw new RouteException(
			esc_html( $e->getErrorCode() ),
			esc_html( $e->getMessage() ),
			esc_html( $e->getCode() )
		);
	}

	wc_do_deprecated_action(
		'__experimental_woocommerce_blocks_checkout_order_processed',
		array(
			$this->order,
		),
		'6.3.0',
		'woocommerce_store_api_checkout_order_processed',
		'This action was deprecated in WooCommerce Blocks version 6.3.0. Please use woocommerce_store_api_checkout_order_processed instead.'
	);

	wc_do_deprecated_action(
		'woocommerce_blocks_checkout_order_processed',
		array(
			$this->order,
		),
		'7.2.0',
		'woocommerce_store_api_checkout_order_processed',
		'This action was deprecated in WooCommerce Blocks version 7.2.0. Please use woocommerce_store_api_checkout_order_processed instead.'
	);

	/**
	 * Fires before an order is processed by the Checkout Block/Store API.
	 *
	 * This hook informs extensions that $order has completed processing and is ready for payment.
	 *
	 * This is similar to existing core hook woocommerce_checkout_order_processed. We're using a new action:
	 * - To keep the interface focused (only pass $order, not passing request data).
	 * - This also explicitly indicates these orders are from checkout block/StoreAPI.
	 *
	 * @since 7.2.0
	 *
	 * @see https://github.com/woocommerce/woocommerce-gutenberg-products-block/pull/3238
	 * @example See docs/examples/checkout-order-processed.md

	 * @param \WC_Order $order Order object.
	 */
	do_action( 'woocommerce_store_api_checkout_order_processed', $this->order );

	/**
	 * Process the payment and return the results.
	 */
	$payment_result = new PaymentResult();

	if ( $this->order->needs_payment() ) {
		$this->process_payment( $request, $payment_result );
	} else {
		$this->process_without_payment( $request, $payment_result );
	}

	return $this->prepare_item_for_response(
		(object) [
			'order'          => wc_get_order( $this->order ),
			'payment_result' => $payment_result,
		],
		$request
	);
}