Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Version section of Introduction for readability and utility #26

Merged
merged 2 commits into from
Feb 23, 2016
Merged

Update Version section of Introduction for readability and utility #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
614edef
Introduction: Diff. between v3 and older versions
Feb 23, 2016
1776c99
Prioritizing v3 content
Feb 23, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions source/includes/v3/_introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,18 @@ The current API version is `v3` which takes a first-order position in endpoints.

The `v1` and `v2` APIs will be removed in future versions.

### What's changed in v3? ###

* v3 implements full basic authentication ([conforms to the Basic auth spec)](http://tools.ietf.org/html/rfc2617)).
* v3 fixes the OAuth implementation to be compliant with the [Oauth 1.0a specs](http://tools.ietf.org/html/rfc5849).
* v3 includes a new endpoint to [get all product orders](#view-list-of-product-orders).
* v3 has new endpoints for bulk creation and updating of [products](#create-update-multiple-products), [orders](#create-update-multiple-orders), [customers](#create-update-multiple-customers) and [coupons](#create-update-multiple-coupons).
* v3 introduces new [product attribute endpoints](#product-attributes) (`GET`, `POST`, `PUT` and `DELETE`).
* v3 deprecated the product/sku/<id> endpoint (because a SKU can be generated with any character and there is a filter, `filter[sku]`, that covers this use case).
* v3 includes category thumbnails with requests for `product/categories`.
* v3 can auto generate passwords for new customers if the "automatically generate customer password" option is enabled.


### Differences between v1 and v2 ###

* v1 supports XML response format, v2 only supports JSON.
Expand All @@ -33,17 +45,6 @@ The `v1` and `v2` APIs will be removed in future versions.
* v1 does not include any endpoints for getting valid order statuses, v2 includes an endpoint for listing valid order statuses (`GET /orders/statuses`).
* v2 supports the core features added in WooCommerce 2.2, primarily order refunds (via the `/orders/refunds` endpoint) and Webhooks (via the `/webhooks`).

### Differences between v3 and older versions ###

* v3 implements full basic authentication ([conforms to the Basic auth spec)](http://tools.ietf.org/html/rfc2617)).
* v3 fixes the OAuth implementation to be compliant with the [Oauth 1.0a specs](http://tools.ietf.org/html/rfc5849).
* v3 includes a new endpoint to get all product orders.
* v3 has new endpoints to allow bulk actions as edition and creation of products, orders, customers and coupons.
* v3 introduces new product attribute endpoints (`GET`, `POST`, `PUT` and `DELETE`).
* v3 deprecated the product/sku/<id> endpoint (because a SKU can be generated with any character, besides that there is a filter callend `filter[sku]`).
* v3 includes category thumbnails on the requests for `product/categories`.
* v3 uses our option to auto generate passwords for new customers.

### API Docs for past versions ###

* [WooCommerce REST API v1 docs](v1.html)
Expand Down