Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

react-native-woocommerce-api

1.0.12 • Public • Published

GitHub package.json version

react-native-woocommerce-api

A wrappper that connects react Native to the WooCommerce API

Installation

To install the module using NPM:

npm install react-native-woocommerce-api --save

Setup

You will need a consumer key and consumer secret to call your store's WooCommerce API. You can find instructions here

Include the 'react-native-woocommerce-api' module within your script and instantiate it with a config:

import WooCommerceAPI from 'react-native-woocommerce-api';
 
var WooCommerceAPI = new WooCommerceAPI({
  url: 'https://yourstore.com', // Your store URL
  ssl: true,
  consumerKey: 'ck_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx', // Your consumer secret
  consumerSecret: 'cs_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', // Your consumer secret
  wpAPI: true, // Enable the WP REST API integration
  version: 'wc/v2', // WooCommerce WP REST API version
  queryStringAuth: true
});

Instantiating a WooCommerceAPI instance without a url, consumerKey or secret will result in an error being thrown

Calling the API

Your WooCommerce API can be called once the WooCommerceAPI object has been instantiated (see above).

GET

WooCommerceAPI.get('products',{
    })
    .then(data => {
      // data will contain the body content from the request
    })
    .catch(error => {
       // error will return any errors that occur
      })
});

POST

For this example you have a Order object.

WooCommerceAPI.post('orders', orderObject, {
 
  })
  .then(data => {
   // data will contain the body content from the request
  })
  .catch(error => {
      // error will return any errors that occur
  })
});

PUT

 
 WooCommerceAPI.put('/orders/1', orderUpdate, {
  })
  .then(data => {
     // data will contain the body content from the request
  })
    .catch(error => {
      // error will return any errors that occur
  })
  
});

DELETE

NPMWooCommerceAPI.delete('orders/1234', {
  })
  .then(data => {
   // data will contain the body content from the request
  })
  .catch(error => {
  // error will return any errors that occur
  })
});

Testing

npm test

Install

npm i react-native-woocommerce-api

DownloadsWeekly Downloads

17

Version

1.0.12

License

MIT

Unpacked Size

12.7 kB

Total Files

4

Last publish

Collaborators

  • avatar