How to get WooCommerce order details

Question

In WooCommerce from the following line code     order   new WC Order   order id      How can I get WooCommerce order details from the order id

User · Answer

ONLY FOR WOOCOMMERCE VERSIONS 2 5 x AND 2 6 x For WOOCOMMERCE VERSION 3 0  see THIS UPDATE  Here is a custom function I have made  to make the things clear for you  related to get the data of an order ID  You will see all the different RAW outputs you can get and how to get the data you need    Using print r   function  or var dump   function too  allow to output the raw data of an object or an array   So first I output this data to show the object or the array hierarchy  Then I use different syntax depending on the type of that variable  string  array or object  to output the specific data needed  IMPORTANT  With  order object you can use most of WC order or WC Abstract Order methods  using the object syntax       Here is the code  function get order details  order id           1  Get the Order object      order   wc get order   order id            OUTPUT     echo   lt h3 gt RAW OUTPUT OF THE ORDER OBJECT   lt  h3 gt        print r  order       echo   lt br gt  lt br gt        echo   lt h3 gt THE ORDER OBJECT  Using the object syntax notation   lt  h3 gt        echo   order- gt order type       order- gt order type     lt br gt        echo   order- gt id       order- gt id     lt br gt        echo   lt h4 gt THE POST OBJECT  lt  h4 gt        echo   order- gt post- gt ID       order- gt post- gt ID     lt br gt        echo   order- gt post- gt post author       order- gt post- gt post author     lt br gt        echo   order- gt post- gt post date       order- gt post- gt post date     lt br gt        echo   order- gt post- gt post date gmt       order- gt post- gt post date gmt     lt br gt        echo   order- gt post- gt post content       order- gt post- gt post content     lt br gt        echo   order- gt post- gt post title       order- gt post- gt post title     lt br gt        echo   order- gt post- gt post excerpt       order- gt post- gt post excerpt     lt br gt        echo   order- gt post- gt post status       order- gt post- gt post status     lt br gt        echo   order- gt post- gt comment status       order- gt post- gt comment status     lt br gt        echo   order- gt post- gt ping status       order- gt post- gt ping status     lt br gt        echo   order- gt post- gt post password       order- gt post- gt post password     lt br gt        echo   order- gt post- gt post name       order- gt post- gt post name     lt br gt        echo   order- gt post- gt to ping       order- gt post- gt to ping     lt br gt        echo   order- gt post- gt pinged       order- gt post- gt pinged     lt br gt        echo   order- gt post- gt post modified       order- gt post- gt post modified     lt br gt        echo   order- gt post- gt post modified gtm       order- gt post- gt post modified gtm     lt br gt        echo   order- gt post- gt post content filtered       order- gt post- gt post content filtered     lt br gt        echo   order- gt post- gt post parent       order- gt post- gt post parent     lt br gt        echo   order- gt post- gt guid       order- gt post- gt guid     lt br gt        echo   order- gt post- gt menu order       order- gt post- gt menu order     lt br gt        echo   order- gt post- gt post type       order- gt post- gt post type     lt br gt        echo   order- gt post- gt post mime type       order- gt post- gt post mime type     lt br gt        echo   order- gt post- gt comment count       order- gt post- gt comment count     lt br gt        echo   order- gt post- gt filter       order- gt post- gt filter     lt br gt        echo   lt h4 gt THE ORDER OBJECT  again   lt  h4 gt        echo   order- gt order date       order- gt order date     lt br gt        echo   order- gt modified date       order- gt modified date     lt br gt        echo   order- gt customer message       order- gt customer message     lt br gt        echo   order- gt customer note       order- gt customer note     lt br gt        echo   order- gt post status       order- gt post status     lt br gt        echo   order- gt prices include tax       order- gt prices include tax     lt br gt        echo   order- gt tax display cart       order- gt tax display cart     lt br gt        echo   order- gt display totals ex tax       order- gt display totals ex tax     lt br gt        echo   order- gt display cart ex tax       order- gt display cart ex tax     lt br gt        echo   order- gt formatted billing address- gt protected       order- gt formatted billing address- gt protected     lt br gt        echo   order- gt formatted shipping address- gt protected       order- gt formatted shipping address- gt protected     lt br gt  lt br gt        echo  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  lt br gt  lt br gt            2  Get the Order meta data      order meta   get post meta  order id        echo   lt h3 gt RAW OUTPUT OF THE ORDER META DATA  ARRAY    lt  h3 gt        print r  order meta       echo   lt br gt  lt br gt        echo   lt h3 gt THE ORDER META DATA  Using the array syntax notation   lt  h3 gt        echo   order meta  order key  0        order meta  order key  0      lt br gt        echo   order meta  order currency  0        order meta  order currency  0      lt br gt        echo   order meta  prices include tax  0        order meta  prices include tax  0      lt br gt        echo   order meta  customer user  0        order meta  customer user  0      lt br gt        echo   order meta  billing first name  0        order meta  billing first name  0      lt br gt  lt br gt        echo  And so on            lt br gt  lt br gt        echo  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  lt br gt  lt br gt            3  Get the order items      items    order- gt get items         echo   lt h3 gt RAW OUTPUT OF THE ORDER ITEMS DATA  ARRAY    lt  h3 gt         foreach    items as  item id   gt   item data              echo   lt h4 gt RAW OUTPUT OF THE ORDER ITEM NUMBER      item id       lt  h4 gt            print r  item data           echo   lt br gt  lt br gt            echo  Item ID       item id    lt br gt            echo   item data  quot product id quot    lt i gt  product ID  lt  i gt        item data  product id       lt br gt            echo   item data  quot name quot    lt i gt  product Name  lt  i gt        item data  name       lt br gt                Using get item meta   method         echo  Item quantity  lt i gt  product quantity  lt  i gt        order- gt get item meta  item id    qty   true      lt br gt  lt br gt            echo  Item line total  lt i gt  product quantity  lt  i gt        order- gt get item meta  item id    line total   true      lt br gt  lt br gt            echo  And so on            lt br gt  lt br gt            echo  - - - - - - - - - - - - -  lt br gt  lt br gt              echo  - - - - - - E N D - - - - -  lt br gt  lt br gt       Code goes in function php file of your active child theme  or theme  or also in any plugin file  Usage  if your order ID is 159 for example   get order details 159    This code is tested and works   Updated code on November 21  2016

User · Answer

You can get all details by order object        Get  order object from order ID             order   wc get order   order id                  Now you have access to  see above                if    order               Get Order ID and Key      order- gt get id         order- gt get order key                 Get Order Totals  0 00      order- gt get formatted order total         order- gt get cart tax         order- gt get currency         order- gt get discount tax         order- gt get discount to display         order- gt get discount total         order- gt get fees         order- gt get formatted line subtotal         order- gt get shipping tax         order- gt get shipping total         order- gt get subtotal         order- gt get subtotal to display         order- gt get tax location         order- gt get tax totals         order- gt get taxes         order- gt get total         order- gt get total discount         order- gt get total tax         order- gt get total refunded         order- gt get total tax refunded         order- gt get total shipping refunded         order- gt get item count refunded         order- gt get total qty refunded         order- gt get qty refunded for item         order- gt get total refunded for item         order- gt get tax refunded for item         order- gt get total tax refunded by rate id         order- gt get remaining refund amount

User · Answer

WOOCOMMERCE ORDERS IN VERSION 3 0  Since Woocommerce mega major Update 3 0  things have changed quite a lot   For WC Order Object  properties can t be accessed directly anymore as before and will throw some errors  New WC Order and WC Abstract Order getter and setter methods are now required on the WC Order object instance  Also  there are some New classes for Order items   WC Order Item class  WC Order Item Product class  WC Order Item Tax class  WC Order Item Shipping class  WC Order Item Coupon class  WC Order Item Fee class    Additionally  WC Data Abstract  class allow to access Order and order items data using get data    get meta data   and get meta   methods    Related       How to get Customer details from Order in WooCommerce       Get Order items and WC Order Item Product in WooCommerce 3  So the Order items properties will not be accessible as before in a foreach loop and you will have to use these specific getter and setter methods instead  Using some WC Order and WC Abstract Order methods  example      Get an instance of the WC Order object  same as before   order   wc get order   order id      order id     order- gt get id       Get the order ID  parent id    order- gt get parent id       Get the parent order ID  for subscriptions       user id      order- gt get user id       Get the costumer ID  user         order- gt get user       Get the WP User object   order status     order- gt get status       Get the order status  see the conditional method has status   below   currency         order- gt get currency       Get the currency used    payment method    order- gt get payment method       Get the payment method ID  payment title    order- gt get payment method title       Get the payment method title  date created     order- gt get date created       Get date created  WC DateTime object   date modified    order- gt get date modified       Get date modified  WC DateTime object    billing country    order- gt get billing country       Customer billing country         and so on       For order status as a conditional method  where  quot the targeted status quot  need to be defined and replaced by an order status to target a specific order status   if    order- gt has status  completed              Do something     Get and access to the order data properties  in an array of values      Get an instance of the WC Order object  order   wc get order   order id      order data    order- gt get data       The Order data   order id    order data  id     order parent id    order data  parent id     order status    order data  status     order currency    order data  currency     order version    order data  version     order payment method    order data  payment method     order payment method title    order data  payment method title     order payment method    order data  payment method     order payment method    order data  payment method        Creation and modified WC DateTime Object date string        Using a formated date   with php date   function as method   order date created    order data  date created  - gt date  Y-m-d H i s     order date modified    order data  date modified  - gt date  Y-m-d H i s        Using a timestamp   with php getTimestamp   function as method   order timestamp created    order data  date created  - gt getTimestamp     order timestamp modified    order data  date modified  - gt getTimestamp      order discount total    order data  discount total     order discount tax    order data  discount tax     order shipping total    order data  shipping total     order shipping tax    order data  shipping tax     order total    order data  total     order total tax    order data  total tax     order customer id    order data  customer id           and so on     BILLING INFORMATION    order billing first name    order data  billing    first name     order billing last name    order data  billing    last name     order billing company    order data  billing    company     order billing address 1    order data  billing    address 1     order billing address 2    order data  billing    address 2     order billing city    order data  billing    city     order billing state    order data  billing    state     order billing postcode    order data  billing    postcode     order billing country    order data  billing    country     order billing email    order data  billing    email     order billing phone    order data  billing    phone        SHIPPING INFORMATION    order shipping first name    order data  shipping    first name     order shipping last name    order data  shipping    last name     order shipping company    order data  shipping    company     order shipping address 1    order data  shipping    address 1     order shipping address 2    order data  shipping    address 2     order shipping city    order data  shipping    city     order shipping state    order data  shipping    state     order shipping postcode    order data  shipping    postcode     order shipping country    order data  shipping    country     Get the order items and access the data with WC Order Item Product and WC Order Item methods     Get an instance of the WC Order object  order   wc get order  order id       Iterating through each WC Order Item Product objects foreach   order- gt get items   as  item key   gt   item            Using WC Order Item methods            Item ID is directly accessible from the  item key in the foreach loop or      item id    item- gt get id            Using WC Order Item Product methods          product         item- gt get product       Get the WC Product object       product id      item- gt get product id       the Product id      variation id    item- gt get variation id       the Variation id       item type       item- gt get type       Type of the order item   quot line item quot         item name       item- gt get name       Name of the product      quantity        item- gt get quantity           tax class       item- gt get tax class         line subtotal        item- gt get subtotal       Line subtotal  non discounted       line subtotal tax    item- gt get subtotal tax       Line subtotal tax  non discounted       line total           item- gt get total       Line total  discounted       line total tax       item- gt get total tax       Line total tax  discounted          Access Order Items data properties  in an array of values          item data       item- gt get data          product name    item data  name         product id      item data  product id         variation id    item data  variation id         quantity        item data  quantity         tax class       item data  tax class         line subtotal        item data  subtotal         line subtotal tax    item data  subtotal tax         line total           item data  total         line total tax       item data  total tax            Get data from The WC product object using methods  examples       product           item- gt get product       Get the WC Product object       product type      product- gt get type         product sku       product- gt get sku         product price     product- gt get price         stock quantity    product- gt get stock quantity     endforeach    So using get data   method allow us to access to the protected data  associative array mode

User · Answer

order   new WC Order get query var  order-received

User · Answer

Accessing direct properties and related are explained

// Get an instance of the WC_Order object
            $order = wc_get_order($order_id);
            $order_data = array(
                    'order_id' => $order->get_id(),
                    'order_number' => $order->get_order_number(),
                    'order_date' => date('Y-m-d H:i:s', strtotime(get_post($order->get_id())->post_date)),
                    'status' => $order->get_status(),
                    'shipping_total' => $order->get_total_shipping(),
                    'shipping_tax_total' => wc_format_decimal($order->get_shipping_tax(), 2),
                    'fee_total' => wc_format_decimal($fee_total, 2),
                    'fee_tax_total' => wc_format_decimal($fee_tax_total, 2),
                    'tax_total' => wc_format_decimal($order->get_total_tax(), 2),
                    'cart_discount' => (defined('WC_VERSION') && (WC_VERSION >= 2.3)) ? wc_format_decimal($order->get_total_discount(), 2) : wc_format_decimal($order->get_cart_discount(), 2),
                    'order_discount' => (defined('WC_VERSION') && (WC_VERSION >= 2.3)) ? wc_format_decimal($order->get_total_discount(), 2) : wc_format_decimal($order->get_order_discount(), 2),
                    'discount_total' => wc_format_decimal($order->get_total_discount(), 2),
                    'order_total' => wc_format_decimal($order->get_total(), 2),
                    'order_currency' => $order->get_currency(),
                    'payment_method' => $order->get_payment_method(),
                    'shipping_method' => $order->get_shipping_method(),
                    'customer_id' => $order->get_user_id(),
                    'customer_user' => $order->get_user_id(),
                    'customer_email' => ($a = get_userdata($order->get_user_id() )) ? $a->user_email : '',
                    'billing_first_name' => $order->get_billing_first_name(),
                    'billing_last_name' => $order->get_billing_last_name(),
                    'billing_company' => $order->get_billing_company(),
                    'billing_email' => $order->get_billing_email(),
                    'billing_phone' => $order->get_billing_phone(),
                    'billing_address_1' => $order->get_billing_address_1(),
                    'billing_address_2' => $order->get_billing_address_2(),
                    'billing_postcode' => $order->get_billing_postcode(),
                    'billing_city' => $order->get_billing_city(),
                    'billing_state' => $order->get_billing_state(),
                    'billing_country' => $order->get_billing_country(),
                    'shipping_first_name' => $order->get_shipping_first_name(),
                    'shipping_last_name' => $order->get_shipping_last_name(),
                    'shipping_company' => $order->get_shipping_company(),
                    'shipping_address_1' => $order->get_shipping_address_1(),
                    'shipping_address_2' => $order->get_shipping_address_2(),
                    'shipping_postcode' => $order->get_shipping_postcode(),
                    'shipping_city' => $order->get_shipping_city(),
                    'shipping_state' => $order->get_shipping_state(),
                    'shipping_country' => $order->get_shipping_country(),
                    'customer_note' => $order->get_customer_note(),
                    'download_permissions' => $order->is_download_permitted() ? $order->is_download_permitted() : 0,
            );

Additional details

  $line_items_shipping = $order->get_items('shipping');
            foreach ($line_items_shipping as $item_id => $item) {
                if (is_object($item)) {
                    if ($meta_data = $item->get_formatted_meta_data('')) :
                        foreach ($meta_data as $meta_id => $meta) :
                            if (in_array($meta->key, $line_items_shipping)) {
                                continue;
                            }
                            // html entity decode is not working preoperly
                            $shipping_items[] = implode('|', array('item:' . wp_kses_post($meta->display_key), 'value:' . str_replace('&times;', 'X', strip_tags($meta->display_value))));
                        endforeach;
                    endif;
                }
            }

            //get fee and total
            $fee_total = 0;
            $fee_tax_total = 0;

            foreach ($order->get_fees() as $fee_id => $fee) {

                $fee_items[] = implode('|', array(
                        'name:' .  html_entity_decode($fee['name'], ENT_NOQUOTES, 'UTF-8'),
                        'total:' . wc_format_decimal($fee['line_total'], 2),
                        'tax:' . wc_format_decimal($fee['line_tax'], 2),
                ));

                $fee_total += $fee['line_total'];
                $fee_tax_total += $fee['line_tax'];
            }

            // get tax items
            foreach ($order->get_tax_totals() as $tax_code => $tax) {            
                $tax_items[] = implode('|', array(
                    'rate_id:'.$tax->id,
                    'code:' . $tax_code,
                    'total:' . wc_format_decimal($tax->amount, 2),
                    'label:'.$tax->label,                
                    'tax_rate_compound:'.$tax->is_compound,
                ));
            }

            // add coupons
            foreach ($order->get_items('coupon') as $_ => $coupon_item) {

                $coupon = new WC_Coupon($coupon_item['name']);

                $coupon_post = get_post((WC()->version < '2.7.0') ? $coupon->id : $coupon->get_id());
                $discount_amount = !empty($coupon_item['discount_amount']) ? $coupon_item['discount_amount'] : 0;
                $coupon_items[] = implode('|', array(
                        'code:' . $coupon_item['name'],
                        'description:' . ( is_object($coupon_post) ? $coupon_post->post_excerpt : '' ),
                        'amount:' . wc_format_decimal($discount_amount, 2),
                ));
            }

            foreach ($order->get_refunds() as $refunded_items){
                $refund_items[] = implode('|', array(
                    'amount:' . $refunded_items->get_amount(),
            'reason:' . $refunded_items->get_reason(),
                    'date:'. date('Y-m-d H-i-s',strtotime((WC()->version < '2.7.0') ? $refunded_items->date_created : $refunded_items->get_date_created())),
                ));
            }

[php] How to get WooCommerce order details

The answer is

Examples related to php

Examples related to wordpress

Examples related to woocommerce

Examples related to product

Examples related to orders

Tags