JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 9
  • Score
    100M100P100Q33801F
  • License MIT

A wocommerce Api wrapper for React Native

Package Exports

  • react-native-wc-api

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-native-wc-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

GitHub package.json version

react-native-wc-api

A wrapper that connects react Native to the WooCommerce API

Installation

To install the module using NPM:

npm install react-native-wc-api --save

To install the module using Yarn:

yarn add react-native-wc-api

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-wc-api' module within your script and instantiate it with a config:

import WooCommerceAPI from 'react-native-wc-api';

let Api = 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 Api object has been instantiated (see above).

GET

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

Note:- Your can use either query params or query as object (Check Example)

POST

For this example you have a Order object.

Api.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