WooDroid/README.md
Gilbert Kimutai 64c0c97199
Update README.md
Added TODOs
2019-02-06 08:20:16 +03:00

2.8 KiB

Woocommerce Android SDK

This is an android sdk for woocommerce

Under construction, is not ready for use yet. :(

alt text

Built-based on the documentation: http://woocommerce.github.io/woocommerce-rest-api-docs/#introduction

Installation

Maven dependency:

TODO

Gradle dependency:

TODO

Getting started

Generate API credentials (Consumer Key & Consumer Secret) following this instructions http://docs.woocommerce.com/document/woocommerce-rest-api/ .

Check out the WooCommerce API endpoints and data that can be manipulated in https://woocommerce.github.io/woocommerce-rest-api-docs/.

Setup

Setup for the new WP REST API integration (WooCommerce 2.6 or later):

 val woocommerce = Woocommerce.Builder()
            .setSiteUrl("http://example.com")
            .setApiVersion("2")
            .setConsumerKey("ck_XXXXX")
            .setConsumerSecret("cs_XXXX")
            .build()

Usage

Getting products example

  woocommerce.products.enqueue(object : Callback<ArrayList<Product>> {
            override fun onResponse(call: Call<ArrayList<Product>>, response: Response<ArrayList<Product>>) {
                val products = response.body()
                for (product in products!!) {
                    tvText.append(product.title + "\n")
                }
            }

            override fun onFailure(call: Call<ArrayList<Product>>, t: Throwable) {

            }
        })

API Support Checklist

Method Create Delete Retrieve Update Batch
Coupons N N N N N
Customers N N N N N
Orders N N N N N
Order notes N N N N N
Refunds N N N N N
Products N N N N N
Product variations N N N N N
Product attributes N N N N N
Product attribute terms N N N N N
Product categories N N N N N
Product shipping classes N N N N N
Product tags N N N N N
Product reviews N N N N N
Reports N N N N N
Tax rates N N N N N
Tax classes N N N N N
Webhooks N N N N N
Settings N N N N N
Setting options N N N N N
Payment gateways N N N N N
Shipping zones N N N N N
Shipping zone locations N N N N N
Shipping zone methods N N N N N
Shipping methods N N N N N

TODO

At them moment working on these :

  1. Authentication a. More robust authentication : pick method and end point from retrofit interceptor b. Add tests for end points
  2. API version support
  3. Support for ssl enabled api calls
  4. Review and clean all model classes