-
Notifications
You must be signed in to change notification settings - Fork 21
Home
This is a generalized JSON api to connect to woocommerce for thirdparty non PHP apps, that may or may not be running on the same server. It was built to integrate Salor Retail and Salor Hospitality into a Wordpress/WooCommerce webstore.
Due to many users having issues setting up the API, the dependency on a "API" page has been removed. The root URL to the site is now an API entry point. This is less secure, and I will try to hatch up some kind of security feature to prevent illegitimate access.
{
action: "woocommerce_json_api",
proc: "get_system_time"
arguments: {
token: 'xyz",
},
}You will receive:
{
"action":"woocommerce_json_api",
"proc":"get_system_time",
"arguments":{
"token":"1234"
},
"status":true,
"errors":[],
"payload":[
{
"timezone":"UTC",
"date":"2013-06-04",
"time":"04:46:29"
}
]
}All requests and responses rigidly follow this format. The main reason being that you should be able to bounce the same object back and forth, requesting some products from the site, then making some edits directly on the result set, then pushing them back to the server to be saved. Path of least resistance.
From a development standpoint it makes it much easier on the API side to simply ignore irrelevant inputs via a whitelist, so the superfluous arguments to a call are simply ignored.
Sending a request is always in this format:
{
action: "woocommerce_json_api",
proc: "api_method_here"
arguments: {
token: "YourUserToken",
arg1: "xxx",
arg2: true,
argn: ...,
},
}You will always receive a JSON object in this format:
{
action: "woocommerce_json_api",
proc: "api_method_here",
status: true|false,
errors: [], // always an empty collection,
// when errors are present, they are represented as
// {text: 'text', code: 12344, retry: true|false ... }
warnings: [], // warnings about what you did that didn't succeed, such as not finding one of many products by sku or some such
arguments: {
token: "YourUserToken"
}
payload: [
// may be a collection of objects,
// arrays, strings, or JS values, or
// could be empty, even on success
], // Always a collection, even if empty
}The JSON API is very general, and works from it's own idiom about products because it was created to work with different types of software that may work and think about sales differently, the JSON communication medium is an intermediate representation of Products, Categories and so on. This is to facilitate a simple communication between 3rd party software that is not part of the plugin ecosystem of woocommerce.
One question you might have, is how do I write some data to the database. For instance, you may wonder, how do I set categories on a Product.
Products are a complex resource, that is they are actually a resource of resources, Product have Tags, Reviews, Categories and so on. These additional resources are provided, like all things, as a collection on the Product. If you want to change something about one of these categories, just edit it in place on the object and send it back to the server with the set_products call. If you want to add a new on, just append a new hash to the collection WITHOUT an id attribute.
To see an example of this, open up some of the tests, like tests/set_products.php. You can also open up tests/interface/index.html to see javascript examples.
Here is a list of all API Calls currently supported. All What you receive JSON is what is actually output from a request. It should not be necessary for you to even look at the PHP code.
This call is essentially a test to see if the JSON API is up and running.
{
action: "woocommerce_json_api",
proc: "get_system_time"
arguments: {
token: "Your User Token",
},
} {
"action":"woocommerce_json_api",
"proc":"get_system_time",
"arguments":{
"token":"1234"
},
"status":true,
"errors":[],
"warnings":[],
"payload":[
{
"timezone":"UTC",
"date":"2013-06-04",
"time":"04:46:29"
}
]
}If you want so simply iterate over all products (bad idea unless you know that you really need this), use this call.
{
"action": "woocommerce_json_api",
"proc": "get_products",
"arguments": {
"token": "1234",
"per_page": 2,
"page": 1
}
}
{
"action": "woocommerce_json_api",
"proc": "get_products",
"arguments": {
"token": "1234",
"per_page": "2",
"page": "1"
},
"status": true,
"errors": [
],
"warnings": [
],
"payload": [
{
"id": "1461",
"name": "Api created product 14",
"slug": "",
"type": "product",
"description": "",
"status": "",
"sku": "A349",
"downloadable": "",
"virtual": "",
"manage_stock": "",
"sold_individually": "",
"featured": "",
"allow_backorders": "",
"quantity": 0,
"height": "",
"weight": "",
"length": "",
"price": "15.95",
"regular_price": "15.95",
"sale_price": "",
"sale_from": "",
"sale_to": "",
"attributes": "",
"tax_class": "",
"tax_status": "",
"categories": [
],
"tags": [
],
"featured_image": false
},
{
"id": "1462",
"name": "Api created product 26",
"slug": "",
"type": "product",
"description": "<b>Hello World!<\/b>",
"status": "",
"sku": "A241",
"downloadable": "",
"virtual": "",
"manage_stock": "",
"sold_individually": "",
"featured": "",
"allow_backorders": "",
"quantity": 0,
"height": "",
"weight": "",
"length": "",
"price": "15.95",
"regular_price": "15.95",
"sale_price": "",
"sale_from": "",
"sale_to": "",
"attributes": "",
"tax_class": "",
"tax_status": "none",
"categories": [
],
"tags": [
],
"featured_image": false
}
],
}You can keep and store the product id, and then use it in later calls. The JSON API always returns a collection even if all you wanted was a single item.
{
"action": "woocommerce_json_api",
"proc": "get_products",
"arguments": {
"token": "1234",
"ids": [
1288
]
}
} {
"action": "woocommerce_json_api",
"proc": "get_products",
"arguments": {
"token": "1234",
"skus": [
"W021",
"DOESNTEXIST"
]
}
} {
"action": "woocommerce_json_api",
"proc": "get_products_by_tags",
"arguments": {
"token": "1234",
"tags": [
'slug-1',
'another-slug'
]
}
} {
"action": "woocommerce_json_api",
"proc": "get_tags",
"arguments": {
"token": "1234",
}
}