Automattic\WooCommerce\StoreApi\Routes\V1

Checkout::create_or_update_draft_order │ private │ WC 1.0

Create or update a draft order based on the cart.

Method of the class: Checkout{}

Returns

null. Nothing (null).

Usage

// private - for code of main (parent) class only
$result = $this->create_or_update_draft_order( $request );

$request(WP_REST_Request) (required)

Full details about the request.

Checkout::create_or_update_draft_order() Checkout::create or update draft order code ^{WC 10.5.0}

private function create_or_update_draft_order( \WP_REST_Request $request ) {
	$this->order = $this->get_draft_order();

	if ( ! $this->order ) {
		$this->order = $this->order_controller->create_order_from_cart();
		wc_log_order_step( '[Store API #4::create_or_update_draft_order] Created order from cart', array( 'order_object' => $this->order ) );

	} else {
		$this->order_controller->update_order_from_cart( $this->order, true );
		wc_log_order_step( '[Store API #4::create_or_update_draft_order] Updated order from cart', array( 'order_object' => $this->order ) );
	}

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

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

	/**
	 * Fires when the Checkout Block/Store API updates an order's meta data.
	 *
	 * This hook gives extensions the chance to add or update meta data on the $order.
	 * Throwing an exception from a callback attached to this action will make the Checkout Block render in a warning state, effectively preventing checkout.
	 *
	 * This is similar to existing core hook woocommerce_checkout_update_order_meta.
	 * 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/3686
	 *
	 * @param \WC_Order $order Order object.
	 */
	do_action( 'woocommerce_store_api_checkout_update_order_meta', $this->order );

	// Confirm order is valid before proceeding further.
	if ( ! $this->order instanceof \WC_Order ) {
		throw new RouteException(
			'woocommerce_rest_checkout_missing_order',
			esc_html__( 'Unable to create order', 'woocommerce' ),
			500
		);
	}

	// Store order ID to session.
	$this->set_draft_order_id( $this->order->get_id() );
	wc_log_order_step( '[Store API #4::create_or_update_draft_order] Set order draft id', array( 'order_object' => $this->order ) );
}