Skip to content

Commit 8e79c46

Browse files
claudiosanchesclaudiosanches
committed
Added node.js library examples
1 parent a006bcc commit 8e79c46

8 files changed

+632
-11
lines changed

‎source/includes/v2/_coupons.md

+65
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,35 @@ curl -X POST https://example.com/wc-api/v2/coupons \
7070
}'
7171
```
7272

73+
```javascript
74+
var data = {
75+
coupon: {
76+
code: 'new-coupon',
77+
type: 'percent',
78+
amount: '10',
79+
individual_use: true,
80+
product_ids: [],
81+
exclude_product_ids: [],
82+
usage_limit: '',
83+
usage_limit_per_user: '',
84+
limit_usage_to_x_items: '',
85+
expiry_date: '',
86+
enable_free_shipping: false,
87+
product_category_ids: [],
88+
exclude_product_category_ids: [],
89+
exclude_sale_items: true,
90+
minimum_amount: '100.00',
91+
maximum_amount: '0.00',
92+
customer_emails: [],
93+
description: ''
94+
}
95+
};
96+
97+
WooCommerce.post('coupons', data, function(err, data, res) {
98+
console.log(res);
99+
});
100+
```
101+
73102
> Response:
74103
75104
```json
@@ -126,6 +155,12 @@ curl https://example.com/wc-api/v2/coupons/529 \
126155
-u consumer_key:consumer_secret
127156
```
128157

158+
```javascript
159+
WooCommerce.get('coupons/529', function(err, data, res) {
160+
console.log(res);
161+
});
162+
```
163+
129164
> Response:
130165
131166
```json
@@ -175,6 +210,12 @@ curl https://example.com/wc-api/v2/coupons \
175210
-u consumer_key:consumer_secret
176211
```
177212

213+
```javascript
214+
WooCommerce.get('coupons', function(err, data, res) {
215+
console.log(res);
216+
});
217+
```
218+
178219
> Response:
179220
180221
```json
@@ -280,6 +321,18 @@ curl -X PUT https://example.com/wc-api/v2/coupons/529 \
280321
}'
281322
```
282323

324+
```javascript
325+
var data = {
326+
coupon: {
327+
amount: '5'
328+
}
329+
};
330+
331+
WooCommerce.put('coupons/529', data, function(err, data, res) {
332+
console.log(res);
333+
});
334+
```
335+
283336
> Response:
284337
285338
```json
@@ -329,6 +382,12 @@ curl -X DELETE https://example.com/wc-api/v2/coupons/529/?force=true \
329382
-u consumer_key:consumer_secret
330383
```
331384

385+
```javascript
386+
WooCommerce.delete('coupons/529/?force=true', function(err, data, res) {
387+
console.log(res);
388+
});
389+
```
390+
332391
> Response:
333392
334393
```json
@@ -361,6 +420,12 @@ curl https://example.com/wc-api/v2/coupons/count \
361420
-u consumer_key:consumer_secret
362421
```
363422

423+
```javascript
424+
WooCommerce.get('coupons/count', function(err, data, res) {
425+
console.log(res);
426+
});
427+
```
428+
364429
> Response:
365430
366431
```json

‎source/includes/v2/_customers.md

+96-3
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,45 @@ curl -X POST https://example.com/wc-api/v2/customers \
102102
}'
103103
```
104104

105+
```javascript
106+
var data = {
107+
customer: {
108+
email: '[email protected]',
109+
first_name: 'John',
110+
last_name: 'Doe',
111+
username: 'john.doe',
112+
billing_address: {
113+
first_name: 'John',
114+
last_name: 'Doe',
115+
company: '',
116+
address_1: '969 Market',
117+
address_2: '',
118+
city: 'San Francisco',
119+
state: 'CA',
120+
postcode: '94103',
121+
country: 'US',
122+
email: '[email protected]',
123+
phone: '(555) 555-5555'
124+
},
125+
shipping_address: {
126+
first_name: 'John',
127+
last_name: 'Doe',
128+
company: '',
129+
address_1: '969 Market',
130+
address_2: '',
131+
city: 'San Francisco',
132+
state: 'CA',
133+
postcode: '94103',
134+
country: 'US'
135+
}
136+
}
137+
};
138+
139+
WooCommerce.post('customers', data, function(err, data, res) {
140+
console.log(res);
141+
});
142+
```
143+
105144
> Response:
106145
107146
```json
@@ -171,6 +210,12 @@ curl https://example.com/wc-api/v2/customers/2 \
171210
-u consumer_key:consumer_secret
172211
```
173212

213+
```javascript
214+
WooCommerce.get('customers/2', function(err, data, res) {
215+
console.log(res);
216+
});
217+
```
218+
174219
> Response:
175220
176221
```json
@@ -233,6 +278,12 @@ curl https://example.com/wc-api/v2/customers \
233278
-u consumer_key:consumer_secret
234279
```
235280

281+
```javascript
282+
WooCommerce.get('customers', function(err, data, res) {
283+
console.log(res);
284+
});
285+
```
286+
236287
> Response:
237288
238289
```json
@@ -343,15 +394,33 @@ curl -X PUT https://example.com/wc-api/v2/customers/2 \
343394
"customer": {
344395
"first_name": "James",
345396
"billing_address": {
346-
"first_name" "James"
397+
"first_name": "James"
347398
},
348399
"shipping_address": {
349-
"first_name" "James"
400+
"first_name": "James"
350401
}
351402
}
352403
}'
353404
```
354405

406+
```javascript
407+
var data = {
408+
customer: {
409+
first_name: 'James',
410+
billing_address: {
411+
first_name: 'James'
412+
},
413+
shipping_address: {
414+
first_name: 'James'
415+
}
416+
}
417+
};
418+
419+
WooCommerce.put('customers/2', data, function(err, data, res) {
420+
console.log(res);
421+
});
422+
```
423+
355424
> Response:
356425
357426
```json
@@ -414,6 +483,12 @@ curl -X DELETE https://example.com/wc-api/v2/customers/2 \
414483
-u consumer_key:consumer_secret
415484
```
416485

486+
```javascript
487+
WooCommerce.delete('customers/2', function(err, data, res) {
488+
console.log(res);
489+
});
490+
```
491+
417492
> Response:
418493
419494
```json
@@ -440,6 +515,12 @@ curl https://example.com/wc-api/v2/customers/2/orders \
440515
-u consumer_key:consumer_secret
441516
```
442517

518+
```javascript
519+
WooCommerce.get('customers/2/orders', function(err, data, res) {
520+
console.log(res);
521+
});
522+
```
523+
443524
> Response:
444525
445526
```json
@@ -566,7 +647,7 @@ curl https://example.com/wc-api/v2/customers/2/orders \
566647
```
567648

568649
<aside class="notice">
569-
View the [Orders Properties](#orders-properties) for more details on this response.
650+
View the <a href="#orders-properties">Orders Properties</a> for more details on this response.
570651
</aside>
571652

572653
## View Customer Downloads ##
@@ -587,6 +668,12 @@ curl https://example.com/wc-api/v2/customers/2/downloads \
587668
-u consumer_key:consumer_secret
588669
```
589670

671+
```javascript
672+
WooCommerce.get('customers/2/downloads', function(err, data, res) {
673+
console.log(res);
674+
});
675+
```
676+
590677
> Response:
591678
592679
```json
@@ -642,6 +729,12 @@ curl https://example.com/wc-api/v2/customers/count \
642729
-u consumer_key:consumer_secret
643730
```
644731

732+
```javascript
733+
WooCommerce.get('customers/count', function(err, data, res) {
734+
console.log(res);
735+
});
736+
```
737+
645738
> Response:
646739
647740
```json

‎source/includes/v2/_introduction.md

+21
Original file line numberDiff line numberDiff line change
@@ -398,6 +398,27 @@ See the webhook resource section.
398398

399399
* Nginx - Older configurations of Nginx can cause issues with the API, see [this issue](https://github.com/woothemes/woocommerce/issues/5616#issuecomment-47338737) for details
400400

401+
## Official Libraries ##
402+
403+
- [Node.js](https://www.npmjs.com/package/woocommerce-api)
404+
405+
406+
```javascript
407+
// Install:
408+
// npm install --save woocommerce-api
409+
410+
// Setup:
411+
var WooCommerceAPI = require('woocommerce-api');
412+
413+
var WooCommerce = new WooCommerceAPI({
414+
url: 'http://example.com', // Your store URL
415+
consumerKey: 'consumer_key', // Your consumer key
416+
consumerSecret: 'consumer_secret', // Your consumer secret
417+
version: 'v2' // WooCommerce API version
418+
});
419+
```
420+
421+
401422
## Tools ##
402423

403424
* [WooCommerce REST API Client Library](https://github.com/kloon/WooCommerce-REST-API-Client-Library) - A simple PHP client library by Gerhard Potgieter.

0 commit comments

Comments
 (0)