Skip to content

Commit 24a05e1

Browse files
authored
Merge pull request #266 from woocommerce/56681-update-order-api-docs
Update orders api to add the `created_via` filter and make it not read-only for POST endpoint
2 parents 3046596 + 05e6039 commit 24a05e1

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

source/includes/wp-api-v3/_orders.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +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
| `number` | string | Order number. <i class="label label-info">read-only</i> |
1212
| `order_key` | string | Order key. <i class="label label-info">read-only</i> |
13-
| `created_via` | string | Shows where the order was created. <i class="label label-info">read-only</i> |
13+
| `created_via` | string | Shows where the order was created. It can only be set during order creation and cannot be modified afterward. |
1414
| `version` | string | Version of WooCommerce which last updated the order. <i class="label label-info">read-only</i> |
1515
| `status` | string | Order status. Options: `pending`, `processing`, `on-hold`, `completed`, `cancelled`, `refunded`, `failed` and `trash`. Default is `pending`. |
1616
| `currency` | string | Currency the order was created with, in ISO format. Options: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTC`, `BTN`, `BWP`, `BYR`, `BZD`, `CAD`, `CDF`, `CHF`, `CLP`, `CNY`, `COP`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GGP`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `IMP`, `INR`, `IQD`, `IRR`, `IRT`, `ISK`, `JEP`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PRB`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VEF`, `VND`, `VUV`, `WST`, `XAF`, `XCD`, `XOF`, `XPF`, `YER`, `ZAR` and `ZMW`. Default is `USD`. |
@@ -1196,6 +1196,7 @@ woocommerce.get("orders").parsed_response
11961196
| `customer` | integer | Limit result set to orders assigned a specific customer. |
11971197
| `product` | integer | Limit result set to orders assigned a specific product. |
11981198
| `dp` | integer | Number of decimal points to use in each resource. Default is `2`. |
1199+
| `created_via` | string | Limit result set to orders created via specific sources (e.g. checkout, store-api). Multiple options can be provided as a comma-separated list. |
11991200

12001201
## Update an Order ##
12011202

0 commit comments

Comments
 (0)