Apimatic-WoocommerceSDK 1.0.0

Getting Started with WooCommerce REST API

Introduction

Taken from: https://github.com/woocommerce/woocommerce-rest-api-docs

Introduction

WooCommerce (WC) 2.6+ is fully integrated with the WordPress REST API. This allows WC data to be created, read, updated, and deleted using requests in JSON format and using WordPress REST API Authentication methods and standard HTTP verbs which are understood by most HTTP clients.

The current WP REST API integration version is v3 which takes a first-order position in endpoints.

The following table shows API versions present in each major version of WooCommerce:

<table><thead> <tr> <th>API Version</th> <th>WC Version</th> <th>WP Version</th> <th>Documentation</th> </tr> </thead><tbody> <tr> <td>v3</td> <td>3.5.x or later</td> <td>4.4 or later</td> <td>-</td> </tr> <tr> <td>v2</td> <td>3.0.x or later</td> <td>4.4 or later</td> <td>v2 docs</td> </tr> <tr> <td>v1</td> <td>2.6.x or later</td> <td>4.4 or later</td> <td>v1 docs</td> </tr> </tbody></table>

Prior to 2.6, WooCommerce has had a REST API separate from WordPress which is now known as the legacy API. You can find the documentation for the legacy API separately.

<table><thead> <tr> <th>API Version</th> <th>WC Version</th> <th>WP Version</th> <th>Documentation</th> </tr> </thead><tbody> <tr> <td>Legacy v3</td> <td>2.4.x or later</td> <td>4.1 or later</td> <td>Legacy v3 docs</td> </tr> <tr> <td>Legacy v2</td> <td>2.2.x or later</td> <td>4.1 or later</td> <td>Legacy v2 docs</td> </tr> <tr> <td>Legacy v1</td> <td>2.1.x or later</td> <td>4.1 or later</td> <td>Legacy v1 docs</td> </tr> </tbody></table>

Requirements

To use the latest version of the REST API you must be using:

• WooCommerce 3.5+.
• WordPress 4.4+.
• Pretty permalinks in Settings > Permalinks so that the custom endpoints are supported. Default permalinks will not work.
• You may access the API over either HTTP or HTTPS, but HTTPS is recommended where possible.

If you use ModSecurity and see 501 Method Not Implemented errors, see this issue for details.

Install the Package

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package Apimatic-WoocommerceSDK --version 1.0.0

You can also view the package at: https://www.nuget.org/packages/Apimatic-WoocommerceSDK/1.0.0

Test the SDK

The generated SDK also contain one or more Tests, which are contained in the Tests project. In order to invoke these test cases, you will need NUnit 3.0 Test Adapter Extension for Visual Studio. Once the SDK is complied, the test cases should appear in the Test Explorer window. Here, you can click Run All to execute these test cases.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

using WooCommerceRESTAPI.Standard;
using WooCommerceRESTAPI.Standard.Authentication;

namespace ConsoleApp;

WooCommerceRESTAPIClient client = new WooCommerceRESTAPIClient.Builder()
    .BasicAuthCredentials(
        new BasicAuthModel.Builder(
            "username",
            "password"
        )
        .Build())
    .Environment(WooCommerceRESTAPI.Standard.Environment.Production)
    .Build();

Authorization

This API uses the following authentication schemes.

• basic (Basic Authentication)

List of APIs

• Attributeid Terms
• Shippingclasses
• Productid Variations
• Groupid
• Instanceid
• Zoneid Methods
• Systemstatus
• Shippingmethods
• Paymentgateways
• Id
• Batch
• Coupons
• Customers
• Notes
• Refunds
• Orders
• Attributes
• Categories
• Reviews
• Tags
• Products
• Reports
• Settings
• Locations
• Shipping Zones
• Classes
• Taxes
• Webhooks
• Tools
• Continents
• Countries
• Currencies
• Data

SDK Infrastructure

Configuration

• HttpClientConfiguration
• HttpClientConfigurationBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiHelper