How do I programmatically load an order by its properties?

Question

I know how to load an order by its ID using \Drupal\commerce_order\Entity\Order::load($order_id). I added a custom field (Token ID) to the orders.

How can I load the orders knowing the value of that field? If I want to get the state of the order, how can I achieve it?

Answer 1

The best way to do this is by using by loadByProperties based on Token field:

$orders = \Drupal::entityTypeManager()
  ->getStorage('commerce_order')
  ->loadByProperties(['field_token_id' => 'TOKEN VALUE']);
$order = reset($orders);
$state = $order->get('state')->value;
$total_price = $order->getTotalprice()->getNumber();
$currency = $order->getTotalprice()->getCurrencyCode();

Here assuming token as a unique value.

Answer 2

you will need to use Drupal EntityQuery to get the order id and load order using its id, the following code might help :

$query = \Drupal::entityQuery('commerce_order')
->condition('field_token_id.value', VALUE_OF_TOKEN);
$order_ids = $query->execute();
foreach($order_ids as $order_id) {
  \Drupal\commerce_order\Entity\Order::load($order_id);
}

Answer 3

I believe the Most efficient and Fast way to get all the Orders is

$orders = \Drupal::entityTypeManager()->getStorage('commerce_order')->loadMultiple();

if you want to get the Completed Orders then you can use the loadByProperties() as like:

$orders = \Drupal::entityTypeManager()->getStorage('commerce_order')->loadByProperties(['state' => 'completed']);