Skip to content

Commit 0167804

Browse files
claudiosanchesclaudiosanches
committed
Merge pull request #13 from woothemes/v3
REST API Docs v3, closes #6
2 parents 1addfa9 + 1d1b07c commit 0167804

17 files changed

+9872
-375
lines changed

‎.editorconfig

+7-5
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,15 @@ trim_trailing_whitespace = false
1616
[*.txt]
1717
trim_trailing_whitespace = false
1818

19-
[*.json]
20-
insert_final_newline = false
19+
[*.{rb,scss,json}]
2120
indent_size = 2
2221
tab_width = 2
2322
indent_style = space
2423

25-
[*.scss]
26-
indent_size = 2
27-
tab_width = 2
24+
[*.json]
25+
insert_final_newline = false
26+
27+
[*.py]
28+
indent_size = 4
29+
tab_width = 4
2830
indent_style = space

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,5 @@ build/
2020
_yardoc
2121
doc/
2222
.idea/
23+
24+
test.*

‎source/includes/v2/_coupons.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ WooCommerce.post('coupons', data, function(err, data, res) {
102102
```python
103103
data = {
104104
"coupon": {
105-
"code": "new-coupon3",
105+
"code": "new-coupon",
106106
"type": "percent",
107107
"amount": "10",
108108
"individual_use": True,
@@ -130,7 +130,7 @@ print(wcapi.post("coupons", data).json())
130130
<?php
131131
$data = array(
132132
'coupon' => array(
133-
'code' => 'new-coupon3',
133+
'code' => 'new-coupon',
134134
'type' => 'percent',
135135
'amount' => '10',
136136
'individual_use' => true,

‎source/includes/v2/_customers.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,22 @@ This section lists all API that can be used to create, edit or otherwise manipul
44

55
## Customers Properties ##
66

7-
| Attribute | Type | Description |
8-
| ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
9-
| `id` | integer | Customer ID (user ID) <i class="label label-info">read-only</i> |
10-
| `created_at` | string | UTC DateTime when the customer was created <i class="label label-info">read-only</i> |
11-
| `email` | string | Customer email address <i class="label label-info">mandatory</i> |
12-
| `first_name` | string | Customer first name |
13-
| `last_name` | string | Customer last name |
14-
| `username` | string | Customer username, can be generated automatically from the customer's email addrees if the option `woocommerce_registration_generate_username` is equal to `yes` <i class="label label-info">cannot be changed</i> |
15-
| `password` | string | Customer password, can be generated automatically with [`wp_generate_password()`](http://codex.wordpress.org/Function_Reference/wp_generate_password) <i class="label label-info">write-only</i> |
16-
| `last_order_id` | integer | Last order ID <i class="label label-info">read-only</i> |
17-
| `last_order_date` | string | UTC DateTime of the customer last order <i class="label label-info">read-only</i> |
18-
| `orders_count` | integer | Quantity of orders that the customer have <i class="label label-info">read-only</i> |
19-
| `total_spent` | integer | Total amount spent <i class="label label-info">read-only</i> |
20-
| `avatar_url` | string | Gravatar URL |
21-
| `billing_address` | array | List of Billing Address fields. See [Billing Address Properties](#billing-address-properties) |
22-
| `shipping_address` | array | List of Shipping Address fields. See [Shipping Address Properties](#shipping-address-properties) |
7+
| Attribute | Type | Description |
8+
| ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
9+
| `id` | integer | Customer ID (user ID) <i class="label label-info">read-only</i> |
10+
| `created_at` | string | UTC DateTime when the customer was created <i class="label label-info">read-only</i> |
11+
| `email` | string | Customer email address <i class="label label-info">mandatory</i> |
12+
| `first_name` | string | Customer first name |
13+
| `last_name` | string | Customer last name |
14+
| `username` | string | Customer username, can be generated automatically from the customer's email addrees if the option `woocommerce_registration_generate_username` is equal to `yes` <i class="label label-info">cannot be changed</i> |
15+
| `password` | string | Customer password, can be generated automatically with [`wp_generate_password()`](http://codex.wordpress.org/Function_Reference/wp_generate_password) if the "Automatically generate customer password" option is enabled, check the index meta for `generate_password` <i class="label label-info">write-only</i> |
16+
| `last_order_id` | integer | Last order ID <i class="label label-info">read-only</i> |
17+
| `last_order_date` | string | UTC DateTime of the customer last order <i class="label label-info">read-only</i> |
18+
| `orders_count` | integer | Quantity of orders that the customer have <i class="label label-info">read-only</i> |
19+
| `total_spent` | integer | Total amount spent <i class="label label-info">read-only</i> |
20+
| `avatar_url` | string | Gravatar URL |
21+
| `billing_address` | array | List of Billing Address fields. See [Billing Address Properties](#billing-address-properties) |
22+
| `shipping_address` | array | List of Shipping Address fields. See [Shipping Address Properties](#shipping-address-properties) |
2323

2424
### Billing Address Properties ###
2525

0 commit comments

Comments
 (0)