wordpress之woocommer手册---orders订单篇

客官°小女子只卖身不卖艺 2022-10-23 01:54 200阅读 0赞

# Orders #

This section lists all API that can be used to create, edit or otherwise manipulate orders.

## Orders Properties ##

<table> 
 <thead> 
  <tr> 
   <th>Attribute</th> 
   <th>Type</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>id</code></td> 
   <td>integer</td> 
   <td>Order ID (post ID) <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>order_number</code></td> 
   <td>integer</td> 
   <td>Order number <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>created_at</code></td> 
   <td>string</td> 
   <td>UTC DateTime when the order was created <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>updated_at</code></td> 
   <td>string</td> 
   <td>UTC DateTime when the order was last updated <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>completed_at</code></td> 
   <td>string</td> 
   <td>UTC DateTime when the order was last completed <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>status</code></td> 
   <td>string</td> 
   <td>Order status. By default are available the status: <code>pending</code>, <code>processing</code>, <code>on-hold</code>, <code>completed</code>, <code>cancelled</code>, <code>refunded</code> and <code>failed</code>. See <a rel="nofollow">View List of Order Statuses</a></td> 
  </tr> 
  <tr> 
   <td><code>currency</code></td> 
   <td>string</td> 
   <td>Currency in ISO format, e.g <code>USD</code></td> 
  </tr> 
  <tr> 
   <td><code>total</code></td> 
   <td>float</td> 
   <td>Order total <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>subtotal</code></td> 
   <td>float</td> 
   <td>Order subtotal <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>total_line_items_quantity</code></td> 
   <td>integer</td> 
   <td>Total of order items <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>total_tax</code></td> 
   <td>float</td> 
   <td>Order tax total <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>total_shipping</code></td> 
   <td>float</td> 
   <td>Order shipping total <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>cart_tax</code></td> 
   <td>float</td> 
   <td>Order cart tax <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>shipping_tax</code></td> 
   <td>float</td> 
   <td>Order shipping tax <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>total_discount</code></td> 
   <td>float</td> 
   <td>Order total discount <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>shipping_methods</code></td> 
   <td>string</td> 
   <td>Text list of the shipping methods used in the order <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>payment_details</code></td> 
   <td>array</td> 
   <td>List of payment details. See <a rel="nofollow">Payment Details Properties</a></td> 
  </tr> 
  <tr> 
   <td><code>billing_address</code></td> 
   <td>array</td> 
   <td>List of customer billing address. See <a rel="nofollow">Customer Billing Address Properties</a></td> 
  </tr> 
  <tr> 
   <td><code>shipping_address</code></td> 
   <td>array</td> 
   <td>List of customer shipping address. See <a rel="nofollow">Customer Shipping Address Properties</a></td> 
  </tr> 
  <tr> 
   <td><code>note</code></td> 
   <td>string</td> 
   <td>Customer order notes</td> 
  </tr> 
  <tr> 
   <td><code>customer_ip</code></td> 
   <td>string</td> 
   <td>Customer IP address <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>customer_user_agent</code></td> 
   <td>string</td> 
   <td>Customer User-Agent <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>customer_id</code></td> 
   <td>integer</td> 
   <td>Customer ID (user ID) <i>required</i></td> 
  </tr> 
  <tr> 
   <td><code>view_order_url</code></td> 
   <td>string</td> 
   <td>URL to view the order in frontend <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>line_items</code></td> 
   <td>array</td> 
   <td>List of order line items. See <a rel="nofollow">Line Items Properties</a></td> 
  </tr> 
  <tr> 
   <td><code>shipping_lines</code></td> 
   <td>array</td> 
   <td>List of shipping line items. See <a rel="nofollow">Shipping Lines Properties</a></td> 
  </tr> 
  <tr> 
   <td><code>tax_lines</code></td> 
   <td>array</td> 
   <td>List of tax line items. See <a rel="nofollow">Tax Lines Properties</a> <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>fee_lines</code></td> 
   <td>array</td> 
   <td>List of fee line items. See <a rel="nofollow">Fee Lines Properites</a></td> 
  </tr> 
  <tr> 
   <td><code>coupon_lines</code></td> 
   <td>array</td> 
   <td>List of cupon line items. See <a rel="nofollow">Coupon Lines Properties</a></td> 
  </tr> 
  <tr> 
   <td><code>customer</code></td> 
   <td>array</td> 
   <td>Customer data. See <a rel="nofollow">Customer Properties</a></td> 
  </tr> 
 </tbody> 
</table>

### Payment Details Properties ###

<table> 
 <thead> 
  <tr> 
   <th>Attribute</th> 
   <th>Type</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>method_id</code></td> 
   <td>string</td> 
   <td>Payment method ID <i>required</i></td> 
  </tr> 
  <tr> 
   <td><code>method_title</code></td> 
   <td>string</td> 
   <td>Payment method title <i>required</i></td> 
  </tr> 
  <tr> 
   <td><code>paid</code></td> 
   <td>boolean</td> 
   <td>Shows/define if the order is paid using this payment method. Use <code>true</code> to complate the payment.</td> 
  </tr> 
  <tr> 
   <td><code>transaction_id</code></td> 
   <td>string</td> 
   <td>Transaction ID, an optional field to set the transacion ID when complate one payment (to set this you need set the <code>paid</code> as <code>true</code> too)</td> 
  </tr> 
 </tbody> 
</table>

### Line Items Properties ###

<table> 
 <thead> 
  <tr> 
   <th>Attribute</th> 
   <th>Type</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>id</code></td> 
   <td>integer</td> 
   <td>Line item ID <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>subtotal</code></td> 
   <td>float</td> 
   <td>Line item subtotal</td> 
  </tr> 
  <tr> 
   <td><code>subtotal_tax</code></td> 
   <td>float</td> 
   <td>Line item tax subtotal</td> 
  </tr> 
  <tr> 
   <td><code>total</code></td> 
   <td>float</td> 
   <td>Line item total</td> 
  </tr> 
  <tr> 
   <td><code>total_tax</code></td> 
   <td>float</td> 
   <td>Line item tax total</td> 
  </tr> 
  <tr> 
   <td><code>price</code></td> 
   <td>float</td> 
   <td>Product price <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>quantity</code></td> 
   <td>integer</td> 
   <td>Quantity</td> 
  </tr> 
  <tr> 
   <td><code>tax_class</code></td> 
   <td>string</td> 
   <td>Product tax class <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>name</code></td> 
   <td>string</td> 
   <td>Product name <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>product_id</code></td> 
   <td>integer</td> 
   <td>Product ID <i>required</i></td> 
  </tr> 
  <tr> 
   <td><code>sku</code></td> 
   <td>string</td> 
   <td>Product SKU <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>meta</code></td> 
   <td>array</td> 
   <td>List of product meta items. See <a rel="nofollow">Products Meta Items Properties</a></td> 
  </tr> 
  <tr> 
   <td><code>variations</code></td> 
   <td>array</td> 
   <td>List of product variation attributes. e.g: <code>"variation": {"pa_color": "Black", "pa_size": "XGG"}</code> (Use <code>pa_</code> prefix when is a product attribute) <i>write-only</i></td> 
  </tr> 
 </tbody> 
</table>

#### Products Meta Items Properties ####

<table> 
 <thead> 
  <tr> 
   <th>Attribute</th> 
   <th>Type</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>key</code></td> 
   <td>string</td> 
   <td>Meta item key</td> 
  </tr> 
  <tr> 
   <td><code>label</code></td> 
   <td>string</td> 
   <td>Meta item label</td> 
  </tr> 
  <tr> 
   <td><code>value</code></td> 
   <td>string</td> 
   <td>Meta item value</td> 
  </tr> 
 </tbody> 
</table>

### Shipping Lines Properties ###

<table> 
 <thead> 
  <tr> 
   <th>Attribute</th> 
   <th>Type</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>id</code></td> 
   <td>integer</td> 
   <td>Shipping line ID <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>method_id</code></td> 
   <td>string</td> 
   <td>Shipping method ID <i>required</i></td> 
  </tr> 
  <tr> 
   <td><code>method_title</code></td> 
   <td>string</td> 
   <td>Shipping method title <i>required</i></td> 
  </tr> 
  <tr> 
   <td><code>total</code></td> 
   <td>float</td> 
   <td>Total amount</td> 
  </tr> 
 </tbody> 
</table>

### Tax Lines Properties ###

<table> 
 <thead> 
  <tr> 
   <th>Attribute</th> 
   <th>Type</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>id</code></td> 
   <td>integer</td> 
   <td>Tax rate line ID <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>rate_id</code></td> 
   <td>integer</td> 
   <td>Tax rate ID <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>code</code></td> 
   <td>string</td> 
   <td>Tax rate code <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>title</code></td> 
   <td>string</td> 
   <td>Tax rate title/name <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>total</code></td> 
   <td>float</td> 
   <td>Tax rate total <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>compound</code></td> 
   <td>boolean</td> 
   <td>Shows if is or not a compound rate. Compound tax rates are applied on top of other tax rates. <i>read-only</i></td> 
  </tr> 
 </tbody> 
</table>

### Fee Lines Properites ###

<table> 
 <thead> 
  <tr> 
   <th>Attribute</th> 
   <th>Type</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>id</code></td> 
   <td>integer</td> 
   <td>Fee line ID <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>title</code></td> 
   <td>string</td> 
   <td>Shipping method title <i>required</i></td> 
  </tr> 
  <tr> 
   <td><code>taxable</code></td> 
   <td>boolean</td> 
   <td>Shows/define if the fee is taxable <i>write-only</i></td> 
  </tr> 
  <tr> 
   <td><code>tax_class</code></td> 
   <td>string</td> 
   <td>Tax class, requered in write-mode if the fee is taxable</td> 
  </tr> 
  <tr> 
   <td><code>total</code></td> 
   <td>float</td> 
   <td>Total amount</td> 
  </tr> 
  <tr> 
   <td><code>total_tax</code></td> 
   <td>float</td> 
   <td>Tax total</td> 
  </tr> 
 </tbody> 
</table>

### Coupon Lines Properties ###

<table> 
 <thead> 
  <tr> 
   <th>Attribute</th> 
   <th>Type</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>id</code></td> 
   <td>integer</td> 
   <td>Coupon line ID <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>code</code></td> 
   <td>string</td> 
   <td>Coupon code <i>required</i></td> 
  </tr> 
  <tr> 
   <td><code>amount</code></td> 
   <td>float</td> 
   <td>Total amount <i>required</i></td> 
  </tr> 
 </tbody> 
</table>

## Create An Order ##

This API helps you to create a new order.

### HTTP Request ###

*POST*

###### /wc-api/v3/orders ######

> Example of create a paid order:

curl -X POST https://example.com/wc-api/v3/orders \
    	-u consumer_key:consumer_secret \
    	-H "Content-Type: application/json" \
    	-d '{ "order": { "payment_details": { "method_id": "bacs", "method_title": "Direct Bank Transfer", "paid": true }, "billing_address": { "first_name": "John", "last_name": "Doe", "address_1": "969 Market", "address_2": "", "city": "San Francisco", "state": "CA", "postcode": "94103", "country": "US", "email": "john.doe@example.com", "phone": "(555) 555-5555" }, "shipping_address": { "first_name": "John", "last_name": "Doe", "address_1": "969 Market", "address_2": "", "city": "San Francisco", "state": "CA", "postcode": "94103", "country": "US" }, "customer_id": 2, "line_items": [ { "product_id": 546, "quantity": 2 }, { "product_id": 613, "quantity": 1, "variations": { "pa_color": "Black" } } ], "shipping_lines": [ { "method_id": "flat_rate", "method_title": "Flat Rate", "total": 10 } ] } }'

data = { 
        "order": { 
            "payment_details": { 
                "method_id": "bacs",
                "method_title": "Direct Bank Transfer",
                "paid": True
            },
            "billing_address": { 
                "first_name": "John",
                "last_name": "Doe",
                "address_1": "969 Market",
                "address_2": "",
                "city": "San Francisco",
                "state": "CA",
                "postcode": "94103",
                "country": "US",
                "email": "john.doe@example.com",
                "phone": "(555) 555-5555"
            },
            "shipping_address": { 
                "first_name": "John",
                "last_name": "Doe",
                "address_1": "969 Market",
                "address_2": "",
                "city": "San Francisco",
                "state": "CA",
                "postcode": "94103",
                "country": "US"
            },
            "customer_id": 2,
            "line_items": [
                { 
                    "product_id": 546,
                    "quantity": 2
                },
                { 
                    "product_id": 613,
                    "quantity": 1,
                    "variations": { 
                        "pa_color": "Black"
                    }
                }
            ],
            "shipping_lines": [
                { 
                    "method_id": "flat_rate",
                    "method_title": "Flat Rate",
                    "total": 10
                }
            ]
        }
    }
    
    print(wcapi.post("orders", data).json())

data = { 
      order: { 
        payment_details: { 
          method_id: "bacs",
          method_title: "Direct Bank Transfer",
          paid: true
        },
        billing_address: { 
          first_name: "John",
          last_name: "Doe",
          address_1: "969 Market",
          address_2: "",
          city: "San Francisco",
          state: "CA",
          postcode: "94103",
          country: "US",
          email: "john.doe@example.com",
          phone: "(555) 555-5555"
        },
        shipping_address: { 
          first_name: "John",
          last_name: "Doe",
          address_1: "969 Market",
          address_2: "",
          city: "San Francisco",
          state: "CA",
          postcode: "94103",
          country: "US"
        },
        customer_id: 2,
        line_items: [
            { 
              product_id: 546,
              quantity: 2
            },
            { 
              product_id: 613,
              quantity: 1,
              variations: { 
                pa_color: "Black"
              }
            }
        ],
        shipping_lines: [
            { 
              method_id: "flat_rate",
              method_title: "Flat Rate",
              total: 10
            }
        ]
      }
    }
    
    woocommerce.post("orders", data).parsed_response

> JSON response example:

{ 
      "order": { 
        "id": 645,
        "order_number": 645,
        "created_at": "2015-01-26T20:00:21Z",
        "updated_at": "2015-01-26T20:00:21Z",
        "completed_at": "2015-01-26T20:00:21Z",
        "status": "processing",
        "currency": "USD",
        "total": "79.87",
        "subtotal": "63.97",
        "total_line_items_quantity": 3,
        "total_tax": "5.90",
        "total_shipping": "10.00",
        "cart_tax": "5.40",
        "shipping_tax": "0.50",
        "total_discount": "0.00",
        "shipping_methods": "Flat Rate",
        "payment_details": { 
          "method_id": "bacs",
          "method_title": "Direct Bank Transfer",
          "paid": true
        },
        "billing_address": { 
          "first_name": "John",
          "last_name": "Doe",
          "company": "",
          "address_1": "969 Market",
          "address_2": "",
          "city": "San Francisco",
          "state": "CA",
          "postcode": "94103",
          "country": "US",
          "email": "john.doe@example.com",
          "phone": "(555) 555-5555"
        },
        "shipping_address": { 
          "first_name": "John",
          "last_name": "Doe",
          "company": "",
          "address_1": "969 Market",
          "address_2": "",
          "city": "San Francisco",
          "state": "CA",
          "postcode": "94103",
          "country": "US"
        },
        "note": "",
        "customer_ip": "127.0.0.1",
        "customer_user_agent": "WordPress/4.1; http://example.com",
        "customer_id": 2,
        "view_order_url": "https://example.com/my-account/view-order/645",
        "line_items": [
          { 
            "id": 504,
            "subtotal": "43.98",
            "subtotal_tax": "4.40",
            "total": "43.98",
            "total_tax": "4.40",
            "price": "21.99",
            "quantity": 2,
            "tax_class": "reduced-rate",
            "name": "Premium Quality",
            "product_id": 546,
            "sku": "",
            "meta": []
          },
          { 
            "id": 505,
            "subtotal": "19.99",
            "subtotal_tax": "1.00",
            "total": "19.99",
            "total_tax": "1.00",
            "price": "19.99",
            "quantity": 1,
            "tax_class": null,
            "name": "Ship Your Idea",
            "product_id": 613,
            "sku": "",
            "meta": [
              { 
                "key": "pa_color",
                "label": "Color",
                "value": "Black"
              }
            ]
          }
        ],
        "shipping_lines": [
          { 
            "id": 506,
            "method_id": "flat_rate",
            "method_title": "Flat Rate",
            "total": "10.00"
          }
        ],
        "tax_lines": [
          { 
            "id": 507,
            "rate_id": "5",
            "code": "US-CA-TAX-1",
            "title": "Tax",
            "total": "4.40",
            "compound": false
          },
          { 
            "id": 508,
            "rate_id": "4",
            "code": "US-STANDARD-1",
            "title": "Standard",
            "total": "1.50",
            "compound": false
          }
        ],
        "fee_lines": [],
        "coupon_lines": [],
        "customer": { 
          "id": 2,
          "created_at": "2014-11-19T18:34:19Z",
          "email": "john.doe@example.com",
          "first_name": "",
          "last_name": "",
          "username": "john.doe",
          "last_order_id": "645",
          "last_order_date": "2015-01-26T20:00:21Z",
          "orders_count": 2,
          "total_spent": "19.00",
          "avatar_url": "https://secure.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536?s=96",
          "billing_address": { 
            "first_name": "John",
            "last_name": "Doe",
            "company": "",
            "address_1": "969 Market",
            "address_2": "",
            "city": "San Francisco",
            "state": "CA",
            "postcode": "94103",
            "country": "US",
            "email": "john.doe@example.com",
            "phone": "(555) 555-5555"
          },
          "shipping_address": { 
            "first_name": "John",
            "last_name": "Doe",
            "company": "",
            "address_1": "969 Market",
            "address_2": "",
            "city": "San Francisco",
            "state": "CA",
            "postcode": "94103",
            "country": "US"
          }
        }
      }
    }

## View An Order ##

This API lets you retrieve and view a specific order.

### HTTP Request ###

*GET*

###### /wc-api/v3/orders/<id> ######

curl https://example.com/wc-api/v3/orders/645 \
    	-u consumer_key:consumer_secret

WooCommerce.get('orders/645', function(err, data, res) { 
      console.log(res);
    });

print(wcapi.get("orders/645").json())

woocommerce.get("orders/645").parsed_response

> JSON response example:

## View List Of Orders ##

This API helps you to view all the orders.

### HTTP Request ###

*GET*

###### /wc-api/v3/orders ######

curl https://example.com/wc-api/v3/orders \
    	-u consumer_key:consumer_secret

WooCommerce.get('orders', function(err, data, res) { 
      console.log(res);
    });

print(wcapi.get("orders").json())

woocommerce.get("orders").parsed_response

> JSON response example:

{ 
      "orders": [
        { 
          "id": 645,
          "order_number": 645,
          "created_at": "2015-01-26T20:00:21Z",
          "updated_at": "2015-01-26T20:00:21Z",
          "completed_at": "2015-01-26T20:00:21Z",
          "status": "processing",
          "currency": "USD",
          "total": "79.87",
          "subtotal": "63.97",
          "total_line_items_quantity": 3,
          "total_tax": "5.90",
          "total_shipping": "10.00",
          "cart_tax": "5.40",
          "shipping_tax": "0.50",
          "total_discount": "0.00",
          "shipping_methods": "Flat Rate",
          "payment_details": { 
            "method_id": "bacs",
            "method_title": "Direct Bank Transfer",
            "paid": true
          },
          "billing_address": { 
            "first_name": "John",
            "last_name": "Doe",
            "company": "",
            "address_1": "969 Market",
            "address_2": "",
            "city": "San Francisco",
            "state": "CA",
            "postcode": "94103",
            "country": "US",
            "email": "john.doe@example.com",
            "phone": "(555) 555-5555"
          },
          "shipping_address": { 
            "first_name": "John",
            "last_name": "Doe",
            "company": "",
            "address_1": "969 Market",
            "address_2": "",
            "city": "San Francisco",
            "state": "CA",
            "postcode": "94103",
            "country": "US"
          },
          "note": "",
          "customer_ip": "127.0.0.1",
          "customer_user_agent": "WordPress/4.1; http://example.com",
          "customer_id": 2,
          "view_order_url": "https://example.com/my-account/view-order/645",
          "line_items": [
            { 
              "id": 504,
              "subtotal": "43.98",
              "subtotal_tax": "4.40",
              "total": "43.98",
              "total_tax": "4.40",
              "price": "21.99",
              "quantity": 2,
              "tax_class": "reduced-rate",
              "name": "Premium Quality",
              "product_id": 546,
              "sku": "",
              "meta": []
            },
            { 
              "id": 505,
              "subtotal": "19.99",
              "subtotal_tax": "1.00",
              "total": "19.99",
              "total_tax": "1.00",
              "price": "19.99",
              "quantity": 1,
              "tax_class": null,
              "name": "Ship Your Idea",
              "product_id": 613,
              "sku": "",
              "meta": [
                { 
                  "key": "pa_color",
                  "label": "Color",
                  "value": "Black"
                }
              ]
            }
          ],
          "shipping_lines": [
            { 
              "id": 506,
              "method_id": "flat_rate",
              "method_title": "Flat Rate",
              "total": "10.00"
            }
          ],
          "tax_lines": [
            { 
              "id": 507,
              "rate_id": "5",
              "code": "US-CA-TAX-1",
              "title": "Tax",
              "total": "4.40",
              "compound": false
            },
            { 
              "id": 508,
              "rate_id": "4",
              "code": "US-STANDARD-1",
              "title": "Standard",
              "total": "1.50",
              "compound": false
            }
          ],
          "fee_lines": [],
          "coupon_lines": [],
          "customer": { 
            "id": 2,
            "created_at": "2014-11-19T18:34:19Z",
            "email": "john.doe@example.com",
            "first_name": "",
            "last_name": "",
            "username": "john.doe",
            "last_order_id": "645",
            "last_order_date": "2015-01-26T20:00:21Z",
            "orders_count": 2,
            "total_spent": "19.00",
            "avatar_url": "https://secure.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536?s=96",
            "billing_address": { 
              "first_name": "John",
              "last_name": "Doe",
              "company": "",
              "address_1": "969 Market",
              "address_2": "",
              "city": "San Francisco",
              "state": "CA",
              "postcode": "94103",
              "country": "US",
              "email": "john.doe@example.com",
              "phone": "(555) 555-5555"
            },
            "shipping_address": { 
              "first_name": "John",
              "last_name": "Doe",
              "company": "",
              "address_1": "969 Market",
              "address_2": "",
              "city": "San Francisco",
              "state": "CA",
              "postcode": "94103",
              "country": "US"
            }
          }
        },
        { 
          "id": 644,
          "order_number": 644,
          "created_at": "2015-01-26T19:33:42Z",
          "updated_at": "2015-01-26T19:33:42Z",
          "completed_at": "2015-01-26T19:33:42Z",
          "status": "on-hold",
          "currency": "USD",
          "total": "44.14",
          "subtotal": "30.99",
          "total_line_items_quantity": 2,
          "total_tax": "3.15",
          "total_shipping": "10.00",
          "cart_tax": "2.65",
          "shipping_tax": "0.50",
          "total_discount": "0.00",
          "shipping_methods": "Flat Rate",
          "payment_details": { 
            "method_id": "bacs",
            "method_title": "Direct Bank Transfer",
            "paid": false
          },
          "billing_address": { 
            "first_name": "John",
            "last_name": "Doe",
            "company": "",
            "address_1": "969 Market",
            "address_2": "",
            "city": "San Francisco",
            "state": "CA",
            "postcode": "94103",
            "country": "US",
            "email": "john.doe@example.com",
            "phone": "(555) 555-5555"
          },
          "shipping_address": { 
            "first_name": "John",
            "last_name": "Doe",
            "company": "",
            "address_1": "969 Market",
            "address_2": "",
            "city": "San Francisco",
            "state": "CA",
            "postcode": "94103",
            "country": "US"
          },
          "note": "",
          "customer_ip": "127.0.0.1",
          "customer_user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/40.0.2214.91 Safari/537.36",
          "customer_id": 2,
          "view_order_url": "https://example.com/my-account/view-order/644",
          "line_items": [
            { 
              "id": 499,
              "subtotal": "21.99",
              "subtotal_tax": "2.20",
              "total": "21.99",
              "total_tax": "2.20",
              "price": "21.99",
              "quantity": 1,
              "tax_class": "reduced-rate",
              "name": "Premium Quality",
              "product_id": 546,
              "sku": "",
              "meta": []
            },
            { 
              "id": 500,
              "subtotal": "9.00",
              "subtotal_tax": "0.45",
              "total": "9.00",
              "total_tax": "0.45",
              "price": "9.00",
              "quantity": 1,
              "tax_class": null,
              "name": "Woo Album #4",
              "product_id": 96,
              "sku": "",
              "meta": []
            }
          ],
          "shipping_lines": [
            { 
              "id": 501,
              "method_id": "flat_rate",
              "method_title": "Flat Rate",
              "total": "10.00"
            }
          ],
          "tax_lines": [
            { 
              "id": 502,
              "rate_id": "5",
              "code": "US-CA-TAX-1",
              "title": "Tax",
              "total": "4.40",
              "compound": false
            },
            { 
              "id": 503,
              "rate_id": "4",
              "code": "US-STANDARD-1",
              "title": "Standard",
              "total": "1.50",
              "compound": false
            }
          ],
          "fee_lines": [],
          "coupon_lines": [],
          "customer": { 
            "id": 2,
            "created_at": "2014-11-19T18:34:19Z",
            "email": "john.doe@example.com",
            "first_name": "",
            "last_name": "",
            "username": "john.doe",
            "last_order_id": "645",
            "last_order_date": "2015-01-26T20:00:21Z",
            "orders_count": 2,
            "total_spent": "19.00",
            "avatar_url": "https://secure.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536?s=96",
            "billing_address": { 
              "first_name": "John",
              "last_name": "Doe",
              "company": "",
              "address_1": "969 Market",
              "address_2": "",
              "city": "San Francisco",
              "state": "CA",
              "postcode": "94103",
              "country": "US",
              "email": "john.doe@example.com",
              "phone": "(555) 555-5555"
            },
            "shipping_address": { 
              "first_name": "John",
              "last_name": "Doe",
              "company": "",
              "address_1": "969 Market",
              "address_2": "",
              "city": "San Francisco",
              "state": "CA",
              "postcode": "94103",
              "country": "US"
            }
          }
        }
      ]
    }

#### Available Filters ####

<table> 
 <thead> 
  <tr> 
   <th>Filter</th> 
   <th>Type</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>status</code></td> 
   <td>string</td> 
   <td>Orders by status. eg: <code>processing</code> or <code>cancelled</code></td> 
  </tr> 
 </tbody> 
</table>

## Update An Order ##

This API lets you make changes to an order.

### HTTP Request ###

*PUT*

###### /wc-api/v3/orders/<id> ######

curl -X PUT https://example.com/wc-api/v3/orders/645 \
    	-u consumer_key:consumer_secret \
    	-H "Content-Type: application/json" \
    	-d '{ "order": { "status": "completed" } }'

var data = { 
      order: { 
        status: 'completed'
      }
    };
    
    WooCommerce.put('orders/645', data, function(err, data, res) { 
      console.log(res);
    });

data = { 
        "order": { 
            "status": "completed"
        }
    }
    
    print(wcapi.put("orders/645", data).json())

data = { 
      order: { 
        status: "completed"
      }
    }
    
    woocommerce.put("orders/645", data).parsed_response

> JSON response example:

{ 
      "order": { 
        "id": 645,
        "order_number": 645,
        "created_at": "2015-01-26T20:00:21Z",
        "updated_at": "2015-01-26T20:00:21Z",
        "completed_at": "2015-01-26T20:00:21Z",
        "status": "completed",
        "currency": "USD",
        "total": "79.87",
        "subtotal": "63.97",
        "total_line_items_quantity": 3,
        "total_tax": "5.90",
        "total_shipping": "10.00",
        "cart_tax": "5.40",
        "shipping_tax": "0.50",
        "total_discount": "0.00",
        "shipping_methods": "Flat Rate",
        "payment_details": { 
          "method_id": "bacs",
          "method_title": "Direct Bank Transfer",
          "paid": true
        },
        "billing_address": { 
          "first_name": "John",
          "last_name": "Doe",
          "company": "",
          "address_1": "969 Market",
          "address_2": "",
          "city": "San Francisco",
          "state": "CA",
          "postcode": "94103",
          "country": "US",
          "email": "john.doe@example.com",
          "phone": "(555) 555-5555"
        },
        "shipping_address": { 
          "first_name": "John",
          "last_name": "Doe",
          "company": "",
          "address_1": "969 Market",
          "address_2": "",
          "city": "San Francisco",
          "state": "CA",
          "postcode": "94103",
          "country": "US"
        },
        "note": "",
        "customer_ip": "127.0.0.1",
        "customer_user_agent": "WordPress/4.1; http://example.com",
        "customer_id": 2,
        "view_order_url": "https://example.com/my-account/view-order/645",
        "line_items": [
          { 
            "id": 504,
            "subtotal": "43.98",
            "subtotal_tax": "4.40",
            "total": "43.98",
            "total_tax": "4.40",
            "price": "21.99",
            "quantity": 2,
            "tax_class": "reduced-rate",
            "name": "Premium Quality",
            "product_id": 546,
            "sku": "",
            "meta": []
          },
          { 
            "id": 505,
            "subtotal": "19.99",
            "subtotal_tax": "1.00",
            "total": "19.99",
            "total_tax": "1.00",
            "price": "19.99",
            "quantity": 1,
            "tax_class": null,
            "name": "Ship Your Idea",
            "product_id": 613,
            "sku": "",
            "meta": [
              { 
                "key": "pa_color",
                "label": "Color",
                "value": "Black"
              }
            ]
          }
        ],
        "shipping_lines": [
          { 
            "id": 506,
            "method_id": "flat_rate",
            "method_title": "Flat Rate",
            "total": "10.00"
          }
        ],
        "tax_lines": [
          { 
            "id": 507,
            "rate_id": "5",
            "code": "US-CA-TAX-1",
            "title": "Tax",
            "total": "4.40",
            "compound": false
          },
          { 
            "id": 508,
            "rate_id": "4",
            "code": "US-STANDARD-1",
            "title": "Standard",
            "total": "1.50",
            "compound": false
          }
        ],
        "fee_lines": [],
        "coupon_lines": [],
        "customer": { 
          "id": 2,
          "created_at": "2014-11-19T18:34:19Z",
          "email": "john.doe@example.com",
          "first_name": "",
          "last_name": "",
          "username": "john.doe",
          "last_order_id": "645",
          "last_order_date": "2015-01-26T20:00:21Z",
          "orders_count": 2,
          "total_spent": "19.00",
          "avatar_url": "https://secure.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536?s=96",
          "billing_address": { 
            "first_name": "John",
            "last_name": "Doe",
            "company": "",
            "address_1": "969 Market",
            "address_2": "",
            "city": "San Francisco",
            "state": "CA",
            "postcode": "94103",
            "country": "US",
            "email": "john.doe@example.com",
            "phone": "(555) 555-5555"
          },
          "shipping_address": { 
            "first_name": "John",
            "last_name": "Doe",
            "company": "",
            "address_1": "969 Market",
            "address_2": "",
            "city": "San Francisco",
            "state": "CA",
            "postcode": "94103",
            "country": "US"
          }
        }
      }
    }

## Create/Update Multiple Orders ##

This API helps you to bulk create/update multiple orders.

To update is necessary to send objects containing IDs and to create new not just send the ID.

### HTTP Request ###

*POST*

###### /wc-api/v3/orders/bulk ######

curl -X PUT https://example.com/wc-api/v3/orders/bulk \
    	-u consumer_key:consumer_secret \
    	-H "Content-Type: application/json" \
    	-d '{ "orders": [ { "id": 645, "shipping_methods": "Local Delivery" }, { "id": 644, "shipping_methods": "Local Delivery" } ] }'

data = { 
        "orders": [
            { 
                "id": 645,
                "shipping_methods": "Local Delivery"
            },
            { 
                "id": 644,
                "shipping_methods": "Local Delivery"
            }
        ]
    }
    
    print(wcapi.put("orders/bulk", data).json())

data = { 
      orders: [
        { 
          id: 645,
          shipping_methods: "Local Delivery"
        },
        { 
          id: 644,
          shipping_methods: "Local Delivery"
        }
      ]
    }
    
    woocommerce.put("orders/bulk", data).parsed_response

> JSON response example:

{ 
      "orders": [
        { 
          "id": 645,
          "order_number": 645,
          "created_at": "2015-01-26T20:00:21Z",
          "updated_at": "2015-07-31T11:45:12Z",
          "completed_at": "2015-01-26T20:00:21Z",
          "status": "processing",
          "currency": "USD",
          "total": "79.87",
          "subtotal": "63.97",
          "total_line_items_quantity": 3,
          "total_tax": "5.90",
          "total_shipping": "10.00",
          "cart_tax": "5.40",
          "shipping_tax": "0.50",
          "total_discount": "0.00",
          "shipping_methods": "Local Delivery",
          "payment_details": { 
            "method_id": "bacs",
            "method_title": "Direct Bank Transfer",
            "paid": true
          },
          "billing_address": { 
            "first_name": "John",
            "last_name": "Doe",
            "company": "",
            "address_1": "969 Market",
            "address_2": "",
            "city": "San Francisco",
            "state": "CA",
            "postcode": "94103",
            "country": "US",
            "email": "john.doe@example.com",
            "phone": "(555) 555-5555"
          },
          "shipping_address": { 
            "first_name": "John",
            "last_name": "Doe",
            "company": "",
            "address_1": "969 Market",
            "address_2": "",
            "city": "San Francisco",
            "state": "CA",
            "postcode": "94103",
            "country": "US"
          },
          "note": "",
          "customer_ip": "127.0.0.1",
          "customer_user_agent": "WordPress/4.1; http://example.com",
          "customer_id": 2,
          "view_order_url": "https://example.com/my-account/view-order/645",
          "line_items": [
            { 
              "id": 504,
              "subtotal": "43.98",
              "subtotal_tax": "4.40",
              "total": "43.98",
              "total_tax": "4.40",
              "price": "21.99",
              "quantity": 2,
              "tax_class": "reduced-rate",
              "name": "Premium Quality",
              "product_id": 546,
              "sku": "",
              "meta": []
            },
            { 
              "id": 505,
              "subtotal": "19.99",
              "subtotal_tax": "1.00",
              "total": "19.99",
              "total_tax": "1.00",
              "price": "19.99",
              "quantity": 1,
              "tax_class": null,
              "name": "Ship Your Idea",
              "product_id": 613,
              "sku": "",
              "meta": [
                { 
                  "key": "pa_color",
                  "label": "Color",
                  "value": "Black"
                }
              ]
            }
          ],
          "shipping_lines": [
            { 
              "id": 506,
              "method_id": "flat_rate",
              "method_title": "Local Delivery",
              "total": "10.00"
            }
          ],
          "tax_lines": [
            { 
              "id": 507,
              "rate_id": "5",
              "code": "US-CA-TAX-1",
              "title": "Tax",
              "total": "4.40",
              "compound": false
            },
            { 
              "id": 508,
              "rate_id": "4",
              "code": "US-STANDARD-1",
              "title": "Standard",
              "total": "1.50",
              "compound": false
            }
          ],
          "fee_lines": [],
          "coupon_lines": [],
          "customer": { 
            "id": 2,
            "created_at": "2014-11-19T18:34:19Z",
            "email": "john.doe@example.com",
            "first_name": "",
            "last_name": "",
            "username": "john.doe",
            "last_order_id": "645",
            "last_order_date": "2015-01-26T20:00:21Z",
            "orders_count": 2,
            "total_spent": "19.00",
            "avatar_url": "https://secure.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536?s=96",
            "billing_address": { 
              "first_name": "John",
              "last_name": "Doe",
              "company": "",
              "address_1": "969 Market",
              "address_2": "",
              "city": "San Francisco",
              "state": "CA",
              "postcode": "94103",
              "country": "US",
              "email": "john.doe@example.com",
              "phone": "(555) 555-5555"
            },
            "shipping_address": { 
              "first_name": "John",
              "last_name": "Doe",
              "company": "",
              "address_1": "969 Market",
              "address_2": "",
              "city": "San Francisco",
              "state": "CA",
              "postcode": "94103",
              "country": "US"
            }
          }
        },
        { 
          "id": 644,
          "order_number": 644,
          "created_at": "2015-01-26T19:33:42Z",
          "updated_at": "2015-07-31T11:45:12Z",
          "completed_at": "2015-01-26T19:33:42Z",
          "status": "on-hold",
          "currency": "USD",
          "total": "44.14",
          "subtotal": "30.99",
          "total_line_items_quantity": 2,
          "total_tax": "3.15",
          "total_shipping": "10.00",
          "cart_tax": "2.65",
          "shipping_tax": "0.50",
          "total_discount": "0.00",
          "shipping_methods": "Flat Rate",
          "payment_details": { 
            "method_id": "bacs",
            "method_title": "Direct Bank Transfer",
            "paid": false
          },
          "billing_address": { 
            "first_name": "John",
            "last_name": "Doe",
            "company": "",
            "address_1": "969 Market",
            "address_2": "",
            "city": "San Francisco",
            "state": "CA",
            "postcode": "94103",
            "country": "US",
            "email": "john.doe@example.com",
            "phone": "(555) 555-5555"
          },
          "shipping_address": { 
            "first_name": "John",
            "last_name": "Doe",
            "company": "",
            "address_1": "969 Market",
            "address_2": "",
            "city": "San Francisco",
            "state": "CA",
            "postcode": "94103",
            "country": "US"
          },
          "note": "",
          "customer_ip": "127.0.0.1",
          "customer_user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/40.0.2214.91 Safari/537.36",
          "customer_id": 2,
          "view_order_url": "https://example.com/my-account/view-order/644",
          "line_items": [
            { 
              "id": 499,
              "subtotal": "21.99",
              "subtotal_tax": "2.20",
              "total": "21.99",
              "total_tax": "2.20",
              "price": "21.99",
              "quantity": 1,
              "tax_class": "reduced-rate",
              "name": "Premium Quality",
              "product_id": 546,
              "sku": "",
              "meta": []
            },
            { 
              "id": 500,
              "subtotal": "9.00",
              "subtotal_tax": "0.45",
              "total": "9.00",
              "total_tax": "0.45",
              "price": "9.00",
              "quantity": 1,
              "tax_class": null,
              "name": "Woo Album #4",
              "product_id": 96,
              "sku": "",
              "meta": []
            }
          ],
          "shipping_lines": [
            { 
              "id": 501,
              "method_id": "flat_rate",
              "method_title": "Flat Rate",
              "total": "10.00"
            }
          ],
          "tax_lines": [
            { 
              "id": 502,
              "rate_id": "5",
              "code": "US-CA-TAX-1",
              "title": "Tax",
              "total": "4.40",
              "compound": false
            },
            { 
              "id": 503,
              "rate_id": "4",
              "code": "US-STANDARD-1",
              "title": "Standard",
              "total": "1.50",
              "compound": false
            }
          ],
          "fee_lines": [],
          "coupon_lines": [],
          "customer": { 
            "id": 2,
            "created_at": "2014-11-19T18:34:19Z",
            "email": "john.doe@example.com",
            "first_name": "",
            "last_name": "",
            "username": "john.doe",
            "last_order_id": "645",
            "last_order_date": "2015-01-26T20:00:21Z",
            "orders_count": 2,
            "total_spent": "19.00",
            "avatar_url": "https://secure.gravatar.com/avatar/ad516503a11cd5ca435acc9bb6523536?s=96",
            "billing_address": { 
              "first_name": "John",
              "last_name": "Doe",
              "company": "",
              "address_1": "969 Market",
              "address_2": "",
              "city": "San Francisco",
              "state": "CA",
              "postcode": "94103",
              "country": "US",
              "email": "john.doe@example.com",
              "phone": "(555) 555-5555"
            },
            "shipping_address": { 
              "first_name": "John",
              "last_name": "Doe",
              "company": "",
              "address_1": "969 Market",
              "address_2": "",
              "city": "San Francisco",
              "state": "CA",
              "postcode": "94103",
              "country": "US"
            }
          }
        }
      ]
    }

## Delete An Order ##

This API helps you delete an order.

### HTTP Request ###

*DELETE*

###### /wc-api/v3/orders/<id> ######

curl -X DELETE https://example.com/wc-api/v3/orders/645/?force=true \
    	-u consumer_key:consumer_secret

WooCommerce.delete('orders/645/?force=true', function(err, data, res) { 
      console.log(res);
    });

print(wcapi.delete("orders/645/?force=true").json())

woocommerce.delete("orders/645/?force=true").parsed_response

> JSON response example:

{ 
      "message": "Permanently deleted order"
    }

### Parameters ###

<table> 
 <thead> 
  <tr> 
   <th>Parameter</th> 
   <th>Type</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>force</code></td> 
   <td>string</td> 
   <td>Use <code>true</code> whether to permanently delete the order, defaults to <code>false</code>. Note that permanently deleting the order will return HTTP 200 rather than HTTP 202.</td> 
  </tr> 
 </tbody> 
</table>

## View Orders Count ##

This API lets you retrieve a count of all orders.

### HTTP Request ###

*GET*

###### /wc-api/v3/orders/count ######

curl https://example.com/wc-api/v3/orders/count \
    	-u consumer_key:consumer_secret

WooCommerce.get('orders/count', function(err, data, res) { 
      console.log(res);
    });

print(wcapi.get("orders/count").json())

woocommerce.get("orders/count").parsed_response

> JSON response example:

{ 
      "count": 2
    }

#### Available Filters ####

## View List Of Order Statuses ##

This API lets you retrieve a list of orders statuses available.

### HTTP Request ###

*GET*

###### /wc-api/v3/orders/statuses ######

curl https://example.com/wc-api/v3/orders/statuses \
    	-u consumer_key:consumer_secret

WooCommerce.get('orders/statuses', function(err, data, res) { 
      console.log(res);
    });

print(wcapi.get("orders/statuses").json())

woocommerce.get("orders/statuses").parsed_response

> JSON response example:

{ 
      "order_statuses": { 
        "pending": "Pending Payment",
        "processing": "Processing",
        "on-hold": "On Hold",
        "completed": "Completed",
        "cancelled": "Cancelled",
        "refunded": "Refunded",
        "failed": "Failed"
      }
    }

## Create A Note For An Order ##

This API helps you to create a new note for an order.

### HTTP Request ###

*POST*

###### /wc-api/v3/orders/<id>/notes ######

curl -X POST https://example.com/wc-api/v3/orders/645/notes \
    	-u consumer_key:consumer_secret \
    	-H "Content-Type: application/json" \
    	-d '{ "order_note": { "note": "Order ok!!!" } }'

var data = { 
      order_note: { 
        note: 'Order ok!!!'
      }
    };
    
    WooCommerce.post('orders/645/notes', data, function(err, data, res) { 
      console.log(res);
    });

data = { 
        "order_note": { 
            "note": "Order ok!!!"
        }
    }
    
    print(wcapi.post("orders/645/notes", data).json())

data = { 
      order_note: { 
        note: "Order ok!!!"
      }
    }
    
    woocommerce.post("orders/645/notes", data).parsed_response

> JSON response example:

{ 
      "order_note": { 
        "id": "416",
        "created_at": "2015-01-26T20:56:44Z",
        "note": "Order ok!!!",
        "customer_note": false
      }
    }

### Order Notes Properties ###

<table> 
 <thead> 
  <tr> 
   <th>Attribute</th> 
   <th>Type</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>id</code></td> 
   <td>integer</td> 
   <td>Order note ID <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>created_at</code></td> 
   <td>string</td> 
   <td>UTC DateTime when the order note was created <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>note</code></td> 
   <td>string</td> 
   <td>Order note <i>required</i></td> 
  </tr> 
  <tr> 
   <td><code>customer_note</code></td> 
   <td>boolean</td> 
   <td>Shows/define if the note is only for reference or for the customer (the user will be notified). Default is <code>false</code></td> 
  </tr> 
 </tbody> 
</table>

## View An Order Note ##

This API lets you retrieve and view a specific note from an order.

### HTTP Request ###

*GET*

###### /wc-api/v3/orders/<id>/notes/<note\_id> ######

curl https://example.com/wc-api/v3/orders/645/notes/416 \
    	-u consumer_key:consumer_secret

WooCommerce.get('orders/645/notes/416', function(err, data, res) { 
      console.log(res);
    });

print(wcapi.get("orders/645/notes/416").json())

woocommerce.get("orders/645/notes/416").parsed_response

> JSON response example:

{ 
      "order_note": { 
        "id": "416",
        "created_at": "2015-01-26T20:56:44Z",
        "note": "Order ok!!!",
        "customer_note": false
      }
    }

View the Order Notes Properties for more details on this response.

## View List Of Notes From An Order ##

This API helps you to view all the notes from an order.

### HTTP Request ###

*GET*

###### /wc-api/v3/orders/<id>/notes ######

curl https://example.com/wc-api/v3/orders/645/notes \
    	-u consumer_key:consumer_secret

WooCommerce.get('orders/645/notes', function(err, data, res) { 
      console.log(res);
    });

print(wcapi.get("orders/645/notes").json())

woocommerce.get("orders/645/notes").parsed_response

> JSON response example:

{ 
      "order_notes": [
        { 
          "id": "416",
          "created_at": "2015-01-26T20:56:44Z",
          "note": "Order ok!!!",
          "customer_note": false
        },
        { 
          "id": "415",
          "created_at": "2015-01-26T20:16:14Z",
          "note": "Order status changed from Processing to Completed.",
          "customer_note": false
        },
        { 
          "id": "412",
          "created_at": "2015-01-26T20:00:21Z",
          "note": "Order item stock reduced successfully.",
          "customer_note": false
        },
        { 
          "id": "411",
          "created_at": "2015-01-26T20:00:09Z",
          "note": "Order status changed from Pending Payment to Processing.",
          "customer_note": false
        }
      ]
    }

View the Order Notes Properties for more details on this response.

## Update An Order Note ##

This API lets you make changes to an order note.

### HTTP Request ###

*PUT*

###### /wc-api/v3/orders/<id>/notes/<note\_id> ######

curl -X PUT https://example.com/wc-api/v3/orders/645/notes/416 \
    	-u consumer_key:consumer_secret \
    	-H "Content-Type: application/json" \
    	-d '{ "order_note": { "note": "Ok!" } }'

var data = { 
      order_note: { 
        note: 'Ok!'
      }
    };
    
    WooCommerce.put('orders/645/notes/416', data, function(err, data, res) { 
      console.log(res);
    });

data = { 
        "order_note": { 
            "note": "Ok!"
        }
    }
    
    print(wcapi.put("orders/645/notes/416", data).json())

data = { 
      order_note: { 
        note: "Ok!"
      }
    }
    
    woocommerce.put("orders/645/notes/416", data).parsed_response

> JSON response example:

{ 
      "order_note": { 
        "id": "416",
        "created_at": "2015-01-26T20:56:44Z",
        "note": "Ok!",
        "customer_note": false
      }
    }

View the Order Notes Properties for more details on this response.

## Delete An Order Note ##

This API helps you delete an order note.

### HTTP Request ###

*DELETE*

###### /wc-api/v3/orders/<id>/notes/<note\_id> ######

curl -X DELETE https://example.com/wc-api/v3/orders/645/notes/416 \
    	-u consumer_key:consumer_secret

WooCommerce.delete('orders/645/notes/416', function(err, data, res) { 
      console.log(res);
    });

print(wcapi.delete("orders/645/notes/416").json())

woocommerce.delete("orders/645/notes/416").parsed_response

> JSON response example:

{ 
      "message": "Permanently deleted order note"
    }

## Create A Refund For An Order ##

This API helps you to create a new refund for an order.

### HTTP Request ###

*POST*

###### /wc-api/v3/orders/<id>/refunds ######

curl -X POST https://example.com/wc-api/v3/orders/645/refunds \
    	-u consumer_key:consumer_secret \
    	-H "Content-Type: application/json" \
    	-d '{ "order_refund": { "amount": 10 } }'

var data = { 
      order_refund: { 
        amount: 10
      }
    };
    
    WooCommerce.post('orders/645/refunds', data, function(err, data, res) { 
      console.log(res);
    });

data = { 
        "order_refund": { 
            "amount": 10
        }
    }
    
    print(wcapi.post("orders/645/refunds", data).json())

data = { 
      order_refund: { 
        amount: 10
      }
    }
    
    woocommerce.post("orders/645/refunds", data).parsed_response

> JSON response example:

{ 
      "order_refund": { 
        "id": 649,
        "created_at": "2015-01-26T19:29:32Z",
        "amount": "10.00",
        "reason": "",
        "line_items": []
      }
    }

### Order Refunds Properties ###

<table> 
 <thead> 
  <tr> 
   <th>Attribute</th> 
   <th>Type</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>id</code></td> 
   <td>integer</td> 
   <td>Order note ID <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>created_at</code></td> 
   <td>string</td> 
   <td>UTC DateTime when the order refund was created <i>read-only</i></td> 
  </tr> 
  <tr> 
   <td><code>amount</code></td> 
   <td>float</td> 
   <td>Refund amount <i>required</i></td> 
  </tr> 
  <tr> 
   <td><code>reason</code></td> 
   <td>string</td> 
   <td>Reason for refund</td> 
  </tr> 
  <tr> 
   <td><code>line_items</code></td> 
   <td>array</td> 
   <td>List of order items to refund. See <a rel="nofollow">Line Items Properties</a></td> 
  </tr> 
 </tbody> 
</table>

## View An Order Refund ##

This API lets you retrieve and view a specific refund from an order.

### HTTP Request ###

*GET*

###### /wc-api/v3/orders/<id>/refunds/<refund\_id> ######

curl https://example.com/wc-api/v3/orders/645/refunds/649 \
    	-u consumer_key:consumer_secret

WooCommerce.get('orders/645/refunds/649', function(err, data, res) { 
      console.log(res);
    });

print(wcapi.get("orders/645/refunds/649").json())

woocommerce.get("orders/645/refunds/649").parsed_response

> JSON response example:

{ 
      "order_refund": { 
        "id": 649,
        "created_at": "2015-01-26T19:29:32Z",
        "amount": "10.00",
        "reason": "",
        "line_items": []
      }
    }

View the Order Refunds Properties for more details on this response.

## View List Of Refunds From An Order ##

This API helps you to view all the refunds from an order.

### HTTP Request ###

*GET*

###### /wc-api/v3/orders/<id>/refunds ######

curl https://example.com/wc-api/v3/orders/645/refunds \
    	-u consumer_key:consumer_secret

WooCommerce.get('orders/645/refunds', function(err, data, res) { 
      console.log(res);
    });

print(wcapi.get("orders/645/refunds").json())

woocommerce.get("orders/645/refunds").parsed_response

> JSON response example:

{ 
      "order_refunds": [
        { 
          "id": 649,
          "created_at": "2015-01-26T19:29:32Z",
          "amount": "10.00",
          "reason": "",
          "line_items": []
        },
        { 
          "id": 647,
          "created_at": "2015-01-26T19:19:06Z",
          "amount": "21.99",
          "reason": "",
          "line_items": [
            { 
              "id": 514,
              "subtotal": "-21.99",
              "subtotal_tax": "0.00",
              "total": "-21.99",
              "total_tax": "0.00",
              "price": "-21.99",
              "quantity": 1,
              "tax_class": "reduced-rate",
              "name": "Premium Quality",
              "product_id": 546,
              "sku": "",
              "meta": []
            },
            { 
              "id": 515,
              "subtotal": "0.00",
              "subtotal_tax": "0.00",
              "total": "0.00",
              "total_tax": "0.00",
              "price": "0.00",
              "quantity": 0,
              "tax_class": null,
              "name": "Ship Your Idea",
              "product_id": 613,
              "sku": "",
              "meta": []
            }
          ]
        }
      ]
    }

View the Order Refunds Properties for more details on this response.

## Update An Order Refund ##

This API lets you make changes to an order refund.

### HTTP Request ###

*PUT*

###### /wc-api/v3/orders/<id>/refunds/<refund\_id> ######

curl -X PUT https://example.com/wc-api/v3/orders/645/refunds/649 \
    	-u consumer_key:consumer_secret \
    	-H "Content-Type: application/json" \
    	-d '{ "order_refund": { "reason": "Because was it necessary!" } }'

data = { 
        "order_refund": { 
            "reason": "Because was it necessary!"
        }
    }
    
    print(wcapi.put("orders/645/refunds/649", data).json())

data = { 
      order_refund: { 
        reason: "Because was it necessary!"
      }
    }
    
    woocommerce.put("orders/645/refunds/649", data).parsed_response

> JSON response example:

{ 
      "order_refund": { 
        "id": 649,
        "created_at": "2015-01-26T19:29:32Z",
        "amount": "10.00",
        "reason": "Because was it necessary!",
        "line_items": []
      }
    }

View the Order Refunds Properties for more details on this response.

## Delete An Order Refund ##

This API helps you delete an order refund.

### HTTP Request ###

*DELETE*

###### /wc-api/v3/orders/<id>/refunds/<refund\_id> ######

curl -X DELETE https://example.com/wc-api/v3/orders/645/refunds/649 \
    	-u consumer_key:consumer_secret

WooCommerce.delete('orders/645/refunds/649', function(err, data, res) { 
      console.log(res);
    });

print(wcapi.delete("orders/645/refunds/649").json())

woocommerce.delete("orders/645/refunds/649").parsed_response

> JSON response example:

{ 
      "message": "Permanently deleted refund"
    }