Skip to content

Commit e57c434

Browse files
Updated the orders docs
1 parent 18fdce3 commit e57c434

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

Diff for: source/includes/wp-api-v1/_orders.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ The orders API allows you to create, view, update, and delete individual, or a b
1010
| `parent_id` | integer | Parent order ID. |
1111
| `status` | string | Order status. Default is `pending`. Options (plugins may include new status): `pending`, `processing`, `on-hold`, `completed`, `cancelled`, `refunded` and `failed`. |
1212
| `order_key` | string | Order key. <i class="label label-info">read-only</i> |
13+
| `number` | string | Order number. <i class="label label-info">read-only</i> |
1314
| `currency` | string | Currency the order was created with, in ISO format, e.g `USD`. Default is the current store currency. |
1415
| `version` | string | Version of WooCommerce when the order was made. <i class="label label-info">read-only</i> |
1516
| `prices_include_tax` | boolean | Shows if the prices included tax during checkout. <i class="label label-info">read-only</i> |
@@ -36,11 +37,11 @@ The orders API allows you to create, view, update, and delete individual, or a b
3637
| `date_completed` | date-time | The date the order was completed, in the site's timezone. <i class="label label-info">read-only</i> |
3738
| `date_paid` | date-time | The date the order has been paid, in the site's timezone. <i class="label label-info">read-only</i> |
3839
| `cart_hash` | string | MD5 hash of cart items to ensure orders are not modified. <i class="label label-info">read-only</i> |
39-
| `line_items` | array | Line items data. See [Line Items properties](#line-item-properties). |
40-
| `tax_lines` | array | Tax lines data. See [Tax Lines properties](#tax-line-properties). <i class="label label-info">read-only</i> |
41-
| `shipping_lines` | array | Shipping lines data. See [Shipping Lines properties](#shipping-line-properties). |
42-
| `fee_lines` | array | Fee lines data. See [Fee Lines Properites](#fee-line-properties). |
43-
| `coupon_lines` | array | Coupons line data. See [Coupon Lines properties](#coupon-line-properties). |
40+
| `line_items` | array | Line items data. See [Line Items properties](#line-item-properties). |
41+
| `tax_lines` | array | Tax lines data. See [Tax Lines properties](#tax-line-properties). <i class="label label-info">read-only</i> |
42+
| `shipping_lines` | array | Shipping lines data. See [Shipping Lines properties](#shipping-line-properties). |
43+
| `fee_lines` | array | Fee lines data. See [Fee Lines Properites](#fee-line-properties). |
44+
| `coupon_lines` | array | Coupons line data. See [Coupon Lines properties](#coupon-line-properties). |
4445

4546
### Line item properties ###
4647

@@ -383,6 +384,7 @@ woocommerce.post("orders", data).parsed_response
383384
"parent_id": 0,
384385
"status": "processing",
385386
"order_key": "wc_order_574cc02467274",
387+
"number": "154",
386388
"currency": "USD",
387389
"version": "2.6.0",
388390
"prices_include_tax": false,
@@ -564,6 +566,7 @@ woocommerce.get("orders/154").parsed_response
564566
"parent_id": 0,
565567
"status": "processing",
566568
"order_key": "wc_order_574cc02467274",
569+
"number": "154",
567570
"currency": "USD",
568571
"version": "2.6.0",
569572
"prices_include_tax": false,
@@ -752,6 +755,7 @@ woocommerce.get("orders").parsed_response
752755
"parent_id": 0,
753756
"status": "processing",
754757
"order_key": "wc_order_574cc02467274",
758+
"number": "154",
755759
"currency": "USD",
756760
"version": "2.6.0",
757761
"prices_include_tax": false,
@@ -892,6 +896,7 @@ woocommerce.get("orders").parsed_response
892896
"parent_id": 0,
893897
"status": "processing",
894898
"order_key": "wc_order_5728e6e53d2a4",
899+
"number": "116",
895900
"currency": "USD",
896901
"version": "2.6.0",
897902
"prices_include_tax": false,
@@ -1078,6 +1083,7 @@ woocommerce.put("orders/154", data).parsed_response
10781083
"parent_id": 0,
10791084
"status": "completed",
10801085
"order_key": "wc_order_574cc02467274",
1086+
"number": "154",
10811087
"currency": "USD",
10821088
"version": "2.6.0",
10831089
"prices_include_tax": false,
@@ -1259,6 +1265,7 @@ woocommerce.delete("orders/154", force: true).parsed_response
12591265
"parent_id": 0,
12601266
"status": "completed",
12611267
"order_key": "wc_order_574cc02467274",
1268+
"number": "154",
12621269
"currency": "USD",
12631270
"version": "2.6.0",
12641271
"prices_include_tax": false,
@@ -1990,6 +1997,7 @@ woocommerce.post("orders/batch", data).parsed_response
19901997
"parent_id": 0,
19911998
"status": "pending",
19921999
"order_key": "wc_order_574cc9541cea3",
2000+
"number": "155",
19932001
"currency": "USD",
19942002
"version": "2.6.0",
19952003
"prices_include_tax": false,
@@ -2152,6 +2160,7 @@ woocommerce.post("orders/batch", data).parsed_response
21522160
"parent_id": 0,
21532161
"status": "processing",
21542162
"order_key": "wc_order_574cc95465214",
2163+
"number": "156",
21552164
"currency": "USD",
21562165
"version": "2.6.0",
21572166
"prices_include_tax": false,
@@ -2300,6 +2309,7 @@ woocommerce.post("orders/batch", data).parsed_response
23002309
"parent_id": 0,
23012310
"status": "completed",
23022311
"order_key": "wc_order_574cc02467274",
2312+
"number": "154",
23032313
"currency": "USD",
23042314
"version": "2.6.0",
23052315
"prices_include_tax": false,
@@ -2442,6 +2452,7 @@ woocommerce.post("orders/batch", data).parsed_response
24422452
"parent_id": 0,
24432453
"status": "completed",
24442454
"order_key": "wc_order_574cc02467274",
2455+
"number": "154",
24452456
"currency": "USD",
24462457
"version": "2.6.0",
24472458
"prices_include_tax": false,

0 commit comments

Comments
 (0)