WooCommerce REST API PHP Client Library

About

A PHP wrapper for the WooCommerce REST API. Easily interact with the WooCommerce REST API using this library., _(*1)

Feedback and bug reports are appreciated, and fixed ASAP., _(*2)

Installation

Via Composer

``` bash $ composer require wic/woocommerce-api, _(*3)


## Requirements

PHP 5.4.x
cURL
WooCommerce 2.2 at least on the store

## Getting started

Generate API credentials (Consumer Key & Consumer Secret) under WP Admin > Your Profile.

## Setup the library

```php
use WIC/Client;

$options = array(
    'ssl_verify'      => false,
);

try {

    $client = new Client( 'http://your-store-url.com', $consumer_key, $consumer_secret, $options );

} catch ( ClientException $e ) {

    echo $e->getMessage() . PHP_EOL;
    echo $e->getCode() . PHP_EOL;

    if ( $e instanceof ClientHTTPException ) {

        print_r( $e->get_request() );
        print_r( $e->get_response() );
    }
}

Options

debug (default false) - set to true to add request/response information to the returned data. This is particularly useful for troubleshooting errors., _(*4)
return_as_array (default false) - all methods return data as a stdClass by default, but you can set this option to true to return data as an associative array instead., _(*5)
validate_url (default false) - set this to true to verify that the URL provided has a valid, parseable WC API index, and optionally force SSL when supported., _(*6)
timeout (default 30) - set this to control the HTTP timeout for requests., _(*7)
ssl_verify (default true) - set this to false if you don't want to perform SSL peer verification for every request., _(*8)

Error handling

Exceptions are thrown when errors are encountered, most will be instances of ClientHTTPException which has two additional methods, get_request() and get_response() -- these return the request and response objects to help with debugging., _(*9)

Methods

Index

$client->index->get() - get the API index

Orders

$client->orders->get() - get a list of orders
$client->orders->get( null, array( 'status' => 'completed' ) ) - get a list of completed orders
$client->orders->get( $order_id ) - get a single order