Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/plugins/woocommerce-blocks/src/RestApi/StoreApi/README.md

1378 lines
46 KiB
Markdown
Raw Normal View History

Introduce a Cart API on top of the REST API (https://github.com/woocommerce/woocommerce-blocks/pull/1046) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item
2019-10-21 11:11:52 +00:00
# WooCommerce Store API
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
The WooCommerce Store API is a public-facing REST API; unlike the main WooCommerce REST API, this API does not require authentication. It is intended to be used by client side code to provide functionality to customers.
Introduce a Cart API on top of the REST API (https://github.com/woocommerce/woocommerce-blocks/pull/1046) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item
2019-10-21 11:11:52 +00:00
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
Documentation in this readme file assumes knowledge of REST concepts.
Introduce a Cart API on top of the REST API (https://github.com/woocommerce/woocommerce-blocks/pull/1046) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item
2019-10-21 11:11:52 +00:00
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
## Current status
Introduce a Cart API on top of the REST API (https://github.com/woocommerce/woocommerce-blocks/pull/1046) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item
2019-10-21 11:11:52 +00:00
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
This API is used internally by Blocks--it is still in flux and may be subject to revisions. There is currently no versioning system and this should be used at your own risk. Eventually, it will be moved to the main WooCommerce REST API at which point it will be versioned and safe to use in other projects.
## Basic usage
Example of a valid API request using cURL:
```http
curl "https://example-store.com/wp-json/wc/store/products"
```
The API uses JSON to serialize data. You don’t need to specify `.json` at the end of an API URL.
## Namespace
Resources in the Store API are all found within the `wc/store/` namespace, and since this API extends the WordPress API, accessing it requires the `/wp-json/` base. Examples:
```http
GET /wp-json/wc/store/products
GET /wp-json/wc/store/cart
```
## Authentication
Requests to the store API do not require authentication. Only public data is returned, and most endpoints are read-only, with the exception of the cart API which only lets you manipulate data for the current user.
## Status codes
The following table gives an overview of how the API functions generally behave.
| Request type | Description |
| :----------- | :---------------------------------------------------------------------------------------------------------- |
| `GET` | Access one or more resources and return `200 OK` and the result as JSON. |
| `POST` | Return `201 Created` if the resource is successfully created and return the newly created resource as JSON. |
| `PUT` | Return `200 OK` if the resource is modified successfully. The modified result is returned as JSON. |
| `DELETE` | Returns `204 No Content` if the resource was deleted successfully. |
The following table shows the possible return codes for API requests.
| Response code | Description |
| :----------------------- | :------------------------------------------------------------------------------------------------------------------------------ |
| `200 OK` | The request was successful, the resource(s) itself is returned as JSON. |
| `204 No Content` | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. |
| `201 Created` | The POST request was successful and the resource is returned as JSON. |
| `400 Bad Request` | A required attribute of the API request is missing. | |
| `403 Forbidden` | The request is not allowed. |
| `404 Not Found` | A resource could not be accessed, for example it doesn't exist. |
| `405 Method Not Allowed` | The request is not supported. |
| `500 Server Error` | While handling the request something went wrong server-side. |
## Pagination
If collections contain many results, they may be paginated. When listing resources you can pass the following parameters:
| Parameter | Description |
| :--------- | :------------------------------------------------------------------------------------- |
| `page` | Current page of the collection. Defaults to `1`. |
| `per_page` | Maximum number of items to be returned in result set. Defaults to `10`. Maximum `100`. |
In the example below, we list 20 products per page and return page 2.
```http
curl "https://example-store.com/wp-json/wc/store/products?page=2&per_page=20"
```
### Pagination headers
Additional pagination headers are also sent back.
| Header | Description |
| :---------------- | :------------------------------------------------------------------------ |
| `X-WP-Total` | The total number of items in the collection. |
| `X-WP-TotalPages` | The total number of pages in the collection. |
| `Link` | Contains links to other pages; `next`, `prev`, and `up` where applicable. |
## API resources
Available resources in the Store API include:
Filter all products block by attribute (https://github.com/woocommerce/woocommerce-blocks/pull/1127) * Block setup * Working filtering and intersection of arrays * Implement block settings and no attribute placeholder * Correctly toggle counts * Implement filtering * Fix price slider constraints * Fix price slider constraints * Edit mode * Rename ProductAttributeControl to ProductAttributeTermControl * Attribute ID saving * fix incorrect test fixtures * fix incorrect regex for parsing model (or resource names) from the route. * Fix query classes for some endpoints * Style improvements * Update inline comments * use previous tests * Show attribute control in sidebar * Remove displayStyle option * Sort attributes by name * Show more/less toggle * Use renderFrontend * Only sort when adding values * Rename memo placeholder * More specific CSS for pointer * Update assets/js/base/hooks/use-query-state.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Remove always true taxonomy check * Update assets/js/blocks/attribute-filter/block.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Remove lodash join * native js for string casting * Move internal deps * hyphenate attributes * Correct data set names * Remove unwanted dependency * Moving imports * Missing deps * replace yoda conditonal * Missing deps * Missing deps * Check value exists * Remove undefined filter * renderedOptions usememo * Set defaults in checkbox list * Show more/less refactor * Use getAdminLink * Fix object length check * Correct AND query handling for counts * useQueryStateByContext * Add store rest endpoints * Update assets/js/base/components/checkbox-list/index.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Update assets/js/base/components/checkbox-list/index.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Update assets/js/base/components/checkbox-list/index.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Update assets/js/blocks/attribute-filter/block.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Feedback * feedback * API readme * Fix API relation queries for multiple attributes * Prevent all options flashing visible during loads * null check * Improve loading state * Remove null options change - it's no longer needed
2019-11-11 10:32:56 +00:00
| Resource | Available endpoints |
| :--------------------------------------------------------- | :-------------------------------------- |
| [`Product Collection Data`](#products-collection-data-api) | `/wc/store/products/collection-data` |
| [`Products`](#products-api) | `/wc/store/products` |
| [`Cart`](#cart-api) | `/wc/store/cart` |
| [`Cart Items`](#cart-items-api) | `/wc/store/cart/items` |
Store API: Add cart coupon endpoints (https://github.com/woocommerce/woocommerce-blocks/pull/1378) * Correct docblock * Implement coupons endpoint with add/delete/get functionality * Add totals * Use money formatting * Added tests for new endpoints * Add coupons to main cart endpoint and update docs to match * Fix indenting in readme * is_a to instanceof * Update coupon_exists logic * Documentation/tidy class * Update currency responses for coupon totals w/ tests
2019-12-19 12:41:34 +00:00
| [`Cart Coupons`](#cart-coupons-api) | `/wc/store/cart/coupons` |
Store API: Add shipping rate api (https://github.com/woocommerce/woocommerce-blocks/pull/1344) * Add basic controllers * Schema * Collections * Updated schema * Remove package ID * Destination handling * Destination validation * Rename method for extra clarity * Tests * RestContoller type * typos * Fix object/array definitions * Fix shipping-rate definition * Fix tests * Add docs * Tweak description
2019-12-10 13:54:18 +00:00
| [`Cart Shipping Rates`](#cart-shipping-rates-api) | `/wc/store/cart/shipping-rates` |
Filter all products block by attribute (https://github.com/woocommerce/woocommerce-blocks/pull/1127) * Block setup * Working filtering and intersection of arrays * Implement block settings and no attribute placeholder * Correctly toggle counts * Implement filtering * Fix price slider constraints * Fix price slider constraints * Edit mode * Rename ProductAttributeControl to ProductAttributeTermControl * Attribute ID saving * fix incorrect test fixtures * fix incorrect regex for parsing model (or resource names) from the route. * Fix query classes for some endpoints * Style improvements * Update inline comments * use previous tests * Show attribute control in sidebar * Remove displayStyle option * Sort attributes by name * Show more/less toggle * Use renderFrontend * Only sort when adding values * Rename memo placeholder * More specific CSS for pointer * Update assets/js/base/hooks/use-query-state.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Remove always true taxonomy check * Update assets/js/blocks/attribute-filter/block.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Remove lodash join * native js for string casting * Move internal deps * hyphenate attributes * Correct data set names * Remove unwanted dependency * Moving imports * Missing deps * replace yoda conditonal * Missing deps * Missing deps * Check value exists * Remove undefined filter * renderedOptions usememo * Set defaults in checkbox list * Show more/less refactor * Use getAdminLink * Fix object length check * Correct AND query handling for counts * useQueryStateByContext * Add store rest endpoints * Update assets/js/base/components/checkbox-list/index.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Update assets/js/base/components/checkbox-list/index.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Update assets/js/base/components/checkbox-list/index.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Update assets/js/blocks/attribute-filter/block.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Feedback * feedback * API readme * Fix API relation queries for multiple attributes * Prevent all options flashing visible during loads * null check * Improve loading state * Remove null options change - it's no longer needed
2019-11-11 10:32:56 +00:00
| [`Product Attributes`](#product-attributes-api) | `/wc/store/products/attributes` |
| [`Product Attribute Terms`](#product-attribute-terms-api) | `/wc/store/products/attributes/1/terms` |
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
## Product Collection Data API
This endpoint allows you to get aggregate data from a collection of products, for example, the min and max price in a collection of products (ignoring pagination). This is used by blocks for product filtering widgets, since counts are based on the product catalog being viewed.
```http
GET /products/collection-data
GET /products/collection-data?calculate_price_range=true
Prevent multiple collection data requests using debounce (https://github.com/woocommerce/woocommerce-blocks/pull/1233) * Add context for collection data query * Introduce useCollectionData hook * Implement hook in filter blocks * Update API to handle nuances of counts instead of client side * Clone requests so original is untouched * Prevent dupe requests is working * Cleanup * Update assets/js/base/hooks/use-collection-data.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Update assets/js/base/hooks/use-collection-data.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Feedback * Remove context
2019-11-23 17:04:30 +00:00
GET /products/collection-data?calculate_attribute_counts[0][query_type]=or&calculate_attribute_counts[0][taxonomy]=pa_color
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
GET /products/collection-data?calculate_rating_counts=true
```
Prevent multiple collection data requests using debounce (https://github.com/woocommerce/woocommerce-blocks/pull/1233) * Add context for collection data query * Introduce useCollectionData hook * Implement hook in filter blocks * Update API to handle nuances of counts instead of client side * Clone requests so original is untouched * Prevent dupe requests is working * Cleanup * Update assets/js/base/hooks/use-collection-data.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Update assets/js/base/hooks/use-collection-data.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Feedback * Remove context
2019-11-23 17:04:30 +00:00
| Attribute | Type | Required | Description |
| :--------------------------- | :----- | :------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `calculate_price_range` | bool | No | Returns the min and max price for the product collection. If false, only `null` will be returned. |
| `calculate_attribute_counts` | object | No | Returns attribute counts for a list of attribute taxonomies you pass in via this parameter. Each should be provided as an object with keys "taxonomy" and "query_type". If empty, `null` will be returned. |
| `calculate_rating_counts` | bool | No | Returns the counts of products with a certain average rating, 1-5. If false, only `null` will be returned. |
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
**In addition to the above attributes**, all product list attributes are supported. This allows you to get data for a certain subset of products. See [the products API list products section](#list-products) for the full list.
```http
curl "https://example-store.com/wp-json/wc/store/products/collection-data?calculate_price_range=true&calculate_attribute_counts=pa_size,pa_color&calculate_rating_counts=true"
```
Example response:
```json
{
More API price formatting and currency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1394) * Consistent currency data and formatting for product prices * Consistent get_store_currency_properties usage * Update tests with schema changes * min_price and max_price to subunit format * Product query of min and max prices using subunit * Cart item totals * Collection data schema object and currency data inclusion * Handle subunits and new API in product prices * Update price slider to format numbers using library and new API responses for subunits * Product query of min and max prices using subunit * Fix indents in readme * Add todo for currency formatting * Handle step for subunits, fixes min/max constraints * Handle subunit conversion on display, using consistent currency object and wrapped NumberFormat component. * Prettier ran * Update usePriceConstraints tests so rounding doesn't make all values be 0 * Rename to minorUnitValue * Move currencyToNumberFormat to index file * siteCurrencySettings to constant rather than function * remove cents term * cents->minor unit * typo in todo note * Switch to FormattedMonetaryAmount * Formatting * wrong case
2019-12-18 11:29:20 +00:00
"price_range": [
"currency_minor_unit": 2,
"min_price": "0",
"max_price": "9000",
],
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
"attribute_counts": [
{
"term": 22,
"count": 4
},
{
"term": 23,
"count": 3
},
{
"term": 24,
"count": 4
}
],
"rating_counts": [
{
"rating": 3,
"count": 1
},
{
"rating": 4,
"count": 1
}
]
}
```
## Products API
### List products
```http
GET /products
GET /products?search=product%20name
GET /products?after=2017-03-22&date_column=date
GET /products?before=2017-03-22&date_column=date
GET /products?exclude=10,44,33
GET /products?include=10,44,33
GET /products?offset=10
GET /products?order=asc&orderby=price
GET /products?parent=10
GET /products?parent_exclude=10
GET /products?type=simple
GET /products?sku=sku-1,sku-2
GET /products?featured=true
GET /products?category=t-shirts
GET /products?tag=special-items
GET /products?attributes[0][attribute]=pa_color&attributes[0][slug]=red
GET /products?on_sale=true
More API price formatting and currency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1394) * Consistent currency data and formatting for product prices * Consistent get_store_currency_properties usage * Update tests with schema changes * min_price and max_price to subunit format * Product query of min and max prices using subunit * Cart item totals * Collection data schema object and currency data inclusion * Handle subunits and new API in product prices * Update price slider to format numbers using library and new API responses for subunits * Product query of min and max prices using subunit * Fix indents in readme * Add todo for currency formatting * Handle step for subunits, fixes min/max constraints * Handle subunit conversion on display, using consistent currency object and wrapped NumberFormat component. * Prettier ran * Update usePriceConstraints tests so rounding doesn't make all values be 0 * Rename to minorUnitValue * Move currencyToNumberFormat to index file * siteCurrencySettings to constant rather than function * remove cents term * cents->minor unit * typo in todo note * Switch to FormattedMonetaryAmount * Formatting * wrong case
2019-12-18 11:29:20 +00:00
GET /products?min_price=5000
GET /products?max_price=10000
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
GET /products?stock_status=outofstock
GET /products?catalog_visibility=search
GET /products?rating=4,5
GET /products?return_price_range=true
GET /products?return_attribute_counts=pa_size,pa_color
GET /products?return_rating_counts=true
```
| Attribute | Type | Required | Description |
| :------------------- | :------ | :------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `search` | integer | no | Limit results to those matching a string. |
| `after` | string | no | Limit response to resources created after a given ISO8601 compliant date. |
| `before` | string | no | Limit response to resources created before a given ISO8601 compliant date. |
| `date_column` | string | no | When limiting response using after/before, which date column to compare against. Allowed values: `date`, `date_gmt`, `modified`, `modified_gmt` |
| `exclude` | array | no | Ensure result set excludes specific IDs. |
| `include` | array | no | Limit result set to specific ids. |
| `offset` | integer | no | Offset the result set by a specific number of items. |
| `order` | string | no | Order sort attribute ascending or descending. Allowed values: `asc`, `desc` |
| `orderby` | string | no | Sort collection by object attribute. Allowed values: `date`, `modified`, `id`, `include`, `title`, `slug`, `price`, `popularity`, `rating`, `menu_order`, `comment_count` |
| `parent` | array | no | Limit result set to those of particular parent IDs. |
| `parent_exclude` | array | no | Limit result set to all items except those of a particular parent ID. |
| `type` | string | no | Limit result set to products assigned a specific type. |
| `sku` | string | no | Limit result set to products with specific SKU(s). Use commas to separate. |
| `featured` | boolean | no | Limit result set to featured products. |
| `category` | string | no | Limit result set to products assigned a specific category ID. |
| `category_operator` | string | no | Operator to compare product category terms. Allowed values: `in`, `not_in`, `and` |
| `tag` | string | no | Limit result set to products assigned a specific tag ID. |
| `tag_operator` | string | no | Operator to compare product tags. Allowed values: `in`, `not_in`, `and` |
| `attributes` | array | no | Limit result set to specific attribute terms. Expects an array of objects containing `attribute` (taxonomy), `term_id` or `slug`, and optional `operator` for comparison. |
| `on_sale` | boolean | no | Limit result set to products on sale. |
More API price formatting and currency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1394) * Consistent currency data and formatting for product prices * Consistent get_store_currency_properties usage * Update tests with schema changes * min_price and max_price to subunit format * Product query of min and max prices using subunit * Cart item totals * Collection data schema object and currency data inclusion * Handle subunits and new API in product prices * Update price slider to format numbers using library and new API responses for subunits * Product query of min and max prices using subunit * Fix indents in readme * Add todo for currency formatting * Handle step for subunits, fixes min/max constraints * Handle subunit conversion on display, using consistent currency object and wrapped NumberFormat component. * Prettier ran * Update usePriceConstraints tests so rounding doesn't make all values be 0 * Rename to minorUnitValue * Move currencyToNumberFormat to index file * siteCurrencySettings to constant rather than function * remove cents term * cents->minor unit * typo in todo note * Switch to FormattedMonetaryAmount * Formatting * wrong case
2019-12-18 11:29:20 +00:00
| `min_price` | string | no | Limit result set to products based on a minimum price, provided using the smallest unit of the currency. |
| `max_price` | string | no | Limit result set to products based on a maximum price, provided using the smallest unit of the currency. |
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
| `stock_status` | string | no | Limit result set to products with specified stock status. |
| `catalog_visibility` | string | no | Determines if hidden or visible catalog products are shown. Allowed values: `any`, `visible`, `catalog`, `search`, `hidden` |
| `rating` | boolean | no | Limit result set to products with a certain average rating. |
```http
curl "https://example-store.com/wp-json/wc/store/products"
```
Example response:
```json
[
{
"id": 95,
"name": "WordPress Pennant",
"variation": "",
"permalink": "http://local.wordpress.test/product/wordpress-pennant/",
"sku": "wp-pennant",
"description": "<p>This is an external product.</p>\n",
Move "prices" data from rest API to store API (https://github.com/woocommerce/woocommerce-blocks/pull/1128)
2019-11-05 16:47:32 +00:00
"prices": {
"currency_code": "GBP",
"decimal_separator": ".",
"thousand_separator": ",",
"decimals": 2,
"price_prefix": "£",
"price_suffix": "",
"price": 18,
"regular_price": 18,
"sale_price": 18,
"price_range": null
},
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
"average_rating": "3.60",
"review_count": 5,
"images": [
{
"id": 60,
"src": "http://local.wordpress.test/wp-content/uploads/2019/07/pennant-1.jpg",
"name": "pennant-1.jpg",
"alt": ""
}
]
}
]
```
### Single product
Get a single product.
```http
GET /products/:id
```
| Attribute | Type | Required | Description |
| :-------- | :------ | :------: | :--------------------------------- |
| `id` | integer | Yes | The ID of the product to retrieve. |
```http
curl "https://example-store.com/wp-json/wc/store/products/95"
```
Example response:
```json
{
"id": 95,
"name": "WordPress Pennant",
"variation": "",
"permalink": "http://local.wordpress.test/product/wordpress-pennant/",
"sku": "wp-pennant",
"description": "<p>This is an external product.</p>\n",
Move "prices" data from rest API to store API (https://github.com/woocommerce/woocommerce-blocks/pull/1128)
2019-11-05 16:47:32 +00:00
"prices": {
"currency_code": "GBP",
"decimal_separator": ".",
"thousand_separator": ",",
"decimals": 2,
"price_prefix": "£",
"price_suffix": "",
"price": 18,
"regular_price": 18,
"sale_price": 18,
"price_range": null
},
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
"average_rating": "3.60",
"review_count": 5,
"images": [
{
"id": 60,
"src": "http://local.wordpress.test/wp-content/uploads/2019/07/pennant-1.jpg",
"name": "pennant-1.jpg",
"alt": ""
}
]
}
```
## Cart API
ensure cart totals update when items are removed or quantity changed (https://github.com/woocommerce/woocommerce-blocks/pull/1840) * ensure cart totals update when items are removed (prototype): - return complete cart object from DELETE cart/items/:key - use receiveCart on client to update whole cart including total * move API endpoint for removing cart items to cart controller: - returns full cart schema so should be part of cart controller - is now a POST request with param - not strict REST - fix up client action to use new API * move API test for removing cart items (API has moved) * use correct path for remove API in tests (doh!) * add extra API test for remove_cart_item with bad key => 404 (experiment) * experiment: delete test_remove_cart_item, does test_remove_bad_cart_item work? * reinstate test_remove_cart_item with single valid request * remove unnecessary newline * tidy comments in PHP api tests, rerun travis? * remove test_remove_cart_item which may be causing problems * reinstate troublesome remove cart item api test (experiment): - see if this works now travis issue is resolved * whitespace * show correct total when changing cart item quantity: - move update cart item quantity API to cart controller - & return full cart response - update js action to new API route & receive full cart response * simplify test_remove_cart_item API test - now just tests a valid remove succeeds * remove test_update_item (API has moved) + + experimentally remove test_remove_bad_cart_item - testing if cart remove tests interact with each other * fix tests (🤞) - pass params in body, not as query params * reinstate test for re-deleting same item * update API docs - update/delete cart item have moved to /cart * add response data checks to new cart API tests: - extra protection against expected 404 "false positives" * reinstate API test for changing cart item quantity * fix remove cart item body tests - MIA items return error code, not cart * fix test - quantity param is int not string * attempt fix 404ing test_update_item: - only allow POST, remove trailing `/` - align array equals for good measure :) * fix action for update-item - method=POST, now takes body params * fix response body asserts in test_update_item * reinstate update_item and delete_item on CartItems controller * typos + examples in new cart items API docs * reorder previous cart item docs to minimise diff/churn * reinstate tabs in docs response example
2020-03-05 19:11:39 +00:00
### Get the cart
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
```http
GET /cart
```
There are no parameters required for this endpoint.
```http
curl "https://example-store.com/wp-json/wc/store/cart"
```
Example response:
```json
{
Store API: Add cart coupon endpoints (https://github.com/woocommerce/woocommerce-blocks/pull/1378) * Correct docblock * Implement coupons endpoint with add/delete/get functionality * Add totals * Use money formatting * Added tests for new endpoints * Add coupons to main cart endpoint and update docs to match * Fix indenting in readme * is_a to instanceof * Update coupon_exists logic * Documentation/tidy class * Update currency responses for coupon totals w/ tests
2019-12-19 12:41:34 +00:00
"coupons": [],
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
"items": [
{
More API price formatting and currency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1394) * Consistent currency data and formatting for product prices * Consistent get_store_currency_properties usage * Update tests with schema changes * min_price and max_price to subunit format * Product query of min and max prices using subunit * Cart item totals * Collection data schema object and currency data inclusion * Handle subunits and new API in product prices * Update price slider to format numbers using library and new API responses for subunits * Product query of min and max prices using subunit * Fix indents in readme * Add todo for currency formatting * Handle step for subunits, fixes min/max constraints * Handle subunit conversion on display, using consistent currency object and wrapped NumberFormat component. * Prettier ran * Update usePriceConstraints tests so rounding doesn't make all values be 0 * Rename to minorUnitValue * Move currencyToNumberFormat to index file * siteCurrencySettings to constant rather than function * remove cents term * cents->minor unit * typo in todo note * Switch to FormattedMonetaryAmount * Formatting * wrong case
2019-12-18 11:29:20 +00:00
"key": "6512bd43d9caa6e02c990b0a82652dca",
"id": 11,
"quantity": 1,
"name": "Beanie",
"sku": "woo-beanie",
"permalink": "http://local.wordpress.test/product/beanie/",
"images": [
{
"id": "40",
"src": "http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2.jpg",
"thumbnail": "http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2-450x450.jpg",
"srcset": "http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2.jpg 801w, http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2-300x300.jpg 300w, http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2-150x150.jpg 150w, http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2-768x768.jpg 768w, http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2-450x450.jpg 450w, http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2-600x600.jpg 600w, http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2-100x100.jpg 100w",
"sizes": "(max-width: 801px) 100vw, 801px",
"name": "beanie-2.jpg",
"alt": ""
}
],
"variation": [],
"totals": {
"currency_code": "GBP",
"currency_symbol": "£",
"currency_minor_unit": 2,
"currency_decimal_separator": ".",
"currency_thousand_separator": ",",
"currency_prefix": "£",
"currency_suffix": "",
"line_subtotal": "1500",
"line_subtotal_tax": "300",
"line_total": "1500",
"line_total_tax": "300"
}
},
{
"key": "1f0e3dad99908345f7439f8ffabdffc4",
"id": 19,
"quantity": 1,
"name": "Album",
"sku": "woo-album",
"permalink": "http://local.wordpress.test/product/album/",
"images": [
{
"id": "48",
"src": "http://local.wordpress.test/wp-content/uploads/2019/12/album-1.jpg",
"thumbnail": "http://local.wordpress.test/wp-content/uploads/2019/12/album-1-450x450.jpg",
"srcset": "http://local.wordpress.test/wp-content/uploads/2019/12/album-1.jpg 800w, http://local.wordpress.test/wp-content/uploads/2019/12/album-1-300x300.jpg 300w, http://local.wordpress.test/wp-content/uploads/2019/12/album-1-150x150.jpg 150w, http://local.wordpress.test/wp-content/uploads/2019/12/album-1-768x768.jpg 768w, http://local.wordpress.test/wp-content/uploads/2019/12/album-1-450x450.jpg 450w, http://local.wordpress.test/wp-content/uploads/2019/12/album-1-600x600.jpg 600w, http://local.wordpress.test/wp-content/uploads/2019/12/album-1-100x100.jpg 100w",
"sizes": "(max-width: 800px) 100vw, 800px",
"name": "album-1.jpg",
"alt": ""
}
],
"variation": [],
"totals": {
"currency_code": "GBP",
"currency_symbol": "£",
"currency_minor_unit": 2,
"currency_decimal_separator": ".",
"currency_thousand_separator": ",",
"currency_prefix": "£",
"currency_suffix": "",
"line_subtotal": "1250",
"line_subtotal_tax": "250",
"line_total": "1250",
"line_total_tax": "250"
}
},
{
"key": "c20ad4d76fe97759aa27a0c99bff6710",
"id": 12,
"quantity": 1,
"name": "Belt",
"sku": "woo-belt",
"permalink": "http://local.wordpress.test/product/belt/",
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
"images": [
{
More API price formatting and currency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1394) * Consistent currency data and formatting for product prices * Consistent get_store_currency_properties usage * Update tests with schema changes * min_price and max_price to subunit format * Product query of min and max prices using subunit * Cart item totals * Collection data schema object and currency data inclusion * Handle subunits and new API in product prices * Update price slider to format numbers using library and new API responses for subunits * Product query of min and max prices using subunit * Fix indents in readme * Add todo for currency formatting * Handle step for subunits, fixes min/max constraints * Handle subunit conversion on display, using consistent currency object and wrapped NumberFormat component. * Prettier ran * Update usePriceConstraints tests so rounding doesn't make all values be 0 * Rename to minorUnitValue * Move currencyToNumberFormat to index file * siteCurrencySettings to constant rather than function * remove cents term * cents->minor unit * typo in todo note * Switch to FormattedMonetaryAmount * Formatting * wrong case
2019-12-18 11:29:20 +00:00
"id": "41",
"src": "http://local.wordpress.test/wp-content/uploads/2019/12/belt-2.jpg",
"thumbnail": "http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-450x450.jpg",
"srcset": "http://local.wordpress.test/wp-content/uploads/2019/12/belt-2.jpg 801w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-300x300.jpg 300w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-150x150.jpg 150w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-768x768.jpg 768w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-450x450.jpg 450w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-600x600.jpg 600w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-100x100.jpg 100w",
"sizes": "(max-width: 801px) 100vw, 801px",
"name": "belt-2.jpg",
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
"alt": ""
}
],
More API price formatting and currency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1394) * Consistent currency data and formatting for product prices * Consistent get_store_currency_properties usage * Update tests with schema changes * min_price and max_price to subunit format * Product query of min and max prices using subunit * Cart item totals * Collection data schema object and currency data inclusion * Handle subunits and new API in product prices * Update price slider to format numbers using library and new API responses for subunits * Product query of min and max prices using subunit * Fix indents in readme * Add todo for currency formatting * Handle step for subunits, fixes min/max constraints * Handle subunit conversion on display, using consistent currency object and wrapped NumberFormat component. * Prettier ran * Update usePriceConstraints tests so rounding doesn't make all values be 0 * Rename to minorUnitValue * Move currencyToNumberFormat to index file * siteCurrencySettings to constant rather than function * remove cents term * cents->minor unit * typo in todo note * Switch to FormattedMonetaryAmount * Formatting * wrong case
2019-12-18 11:29:20 +00:00
"variation": [],
"totals": {
"currency_code": "GBP",
"currency_symbol": "£",
"currency_minor_unit": 2,
"currency_decimal_separator": ".",
"currency_thousand_separator": ",",
"currency_prefix": "£",
"currency_suffix": "",
"line_subtotal": "4583",
"line_subtotal_tax": "917",
"line_total": "4583",
"line_total_tax": "917"
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
}
}
],
More API price formatting and currency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1394) * Consistent currency data and formatting for product prices * Consistent get_store_currency_properties usage * Update tests with schema changes * min_price and max_price to subunit format * Product query of min and max prices using subunit * Cart item totals * Collection data schema object and currency data inclusion * Handle subunits and new API in product prices * Update price slider to format numbers using library and new API responses for subunits * Product query of min and max prices using subunit * Fix indents in readme * Add todo for currency formatting * Handle step for subunits, fixes min/max constraints * Handle subunit conversion on display, using consistent currency object and wrapped NumberFormat component. * Prettier ran * Update usePriceConstraints tests so rounding doesn't make all values be 0 * Rename to minorUnitValue * Move currencyToNumberFormat to index file * siteCurrencySettings to constant rather than function * remove cents term * cents->minor unit * typo in todo note * Switch to FormattedMonetaryAmount * Formatting * wrong case
2019-12-18 11:29:20 +00:00
"items_count": 3,
"items_weight": 0,
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
"needs_shipping": true,
More API price formatting and currency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1394) * Consistent currency data and formatting for product prices * Consistent get_store_currency_properties usage * Update tests with schema changes * min_price and max_price to subunit format * Product query of min and max prices using subunit * Cart item totals * Collection data schema object and currency data inclusion * Handle subunits and new API in product prices * Update price slider to format numbers using library and new API responses for subunits * Product query of min and max prices using subunit * Fix indents in readme * Add todo for currency formatting * Handle step for subunits, fixes min/max constraints * Handle subunit conversion on display, using consistent currency object and wrapped NumberFormat component. * Prettier ran * Update usePriceConstraints tests so rounding doesn't make all values be 0 * Rename to minorUnitValue * Move currencyToNumberFormat to index file * siteCurrencySettings to constant rather than function * remove cents term * cents->minor unit * typo in todo note * Switch to FormattedMonetaryAmount * Formatting * wrong case
2019-12-18 11:29:20 +00:00
"totals": {
"currency_code": "GBP",
"currency_symbol": "£",
"currency_minor_unit": 2,
"currency_decimal_separator": ".",
"currency_thousand_separator": ",",
"currency_prefix": "£",
"currency_suffix": "",
"total_items": "7333",
"total_items_tax": "1467",
"total_fees": "0",
"total_fees_tax": "0",
"total_discount": "0",
"total_discount_tax": "0",
"total_shipping": "998",
"total_shipping_tax": "200",
"total_tax": "1667",
"total_price": "9998",
"tax_lines": [
{
"name": "Tax",
"price": "1667"
}
]
}
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
}
```
ensure cart totals update when items are removed or quantity changed (https://github.com/woocommerce/woocommerce-blocks/pull/1840) * ensure cart totals update when items are removed (prototype): - return complete cart object from DELETE cart/items/:key - use receiveCart on client to update whole cart including total * move API endpoint for removing cart items to cart controller: - returns full cart schema so should be part of cart controller - is now a POST request with param - not strict REST - fix up client action to use new API * move API test for removing cart items (API has moved) * use correct path for remove API in tests (doh!) * add extra API test for remove_cart_item with bad key => 404 (experiment) * experiment: delete test_remove_cart_item, does test_remove_bad_cart_item work? * reinstate test_remove_cart_item with single valid request * remove unnecessary newline * tidy comments in PHP api tests, rerun travis? * remove test_remove_cart_item which may be causing problems * reinstate troublesome remove cart item api test (experiment): - see if this works now travis issue is resolved * whitespace * show correct total when changing cart item quantity: - move update cart item quantity API to cart controller - & return full cart response - update js action to new API route & receive full cart response * simplify test_remove_cart_item API test - now just tests a valid remove succeeds * remove test_update_item (API has moved) + + experimentally remove test_remove_bad_cart_item - testing if cart remove tests interact with each other * fix tests (🤞) - pass params in body, not as query params * reinstate test for re-deleting same item * update API docs - update/delete cart item have moved to /cart * add response data checks to new cart API tests: - extra protection against expected 404 "false positives" * reinstate API test for changing cart item quantity * fix remove cart item body tests - MIA items return error code, not cart * fix test - quantity param is int not string * attempt fix 404ing test_update_item: - only allow POST, remove trailing `/` - align array equals for good measure :) * fix action for update-item - method=POST, now takes body params * fix response body asserts in test_update_item * reinstate update_item and delete_item on CartItems controller * typos + examples in new cart items API docs * reorder previous cart item docs to minimise diff/churn * reinstate tabs in docs response example
2020-03-05 19:11:39 +00:00
### Edit single cart item
Change the quantity of a cart item.
```http
PUT /cart/update-item/
```
| Attribute | Type | Required | Description |
| :--------- | :------ | :------: | :--------------------------------- |
| `key` | string | Yes | The key of the cart item to edit. |
| `quantity` | integer | Yes | Quantity of this item in the cart. |
Returns the full cart object (same response as `GET /cart`).
```http
curl --request POST "https://example-store.com/wp-json/wc/store/cart/update-item?key=1ff1de774005f8da13f42943881c655f&quantity=3"
```
### Delete single cart item
Delete/remove an item from the cart.
```http
POST /cart/remove-item/
```
| Attribute | Type | Required | Description |
| :-------- | :----- | :------: | :-------------------------------- |
| `key` | string | Yes | The key of the cart item to edit. |
Returns the full cart object (same response as `GET /cart`).
```http
curl --request POST "https://example-store.com/wp-json/wc/store/cart/remove-item?key=1ff1de774005f8da13f42943881c655f"
```
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
## Cart items API
### List cart items
```http
GET /cart/items
```
There are no parameters required for this endpoint.
```http
curl "https://example-store.com/wp-json/wc/store/cart/items"
```
Example response:
```json
[
{
More API price formatting and currency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1394) * Consistent currency data and formatting for product prices * Consistent get_store_currency_properties usage * Update tests with schema changes * min_price and max_price to subunit format * Product query of min and max prices using subunit * Cart item totals * Collection data schema object and currency data inclusion * Handle subunits and new API in product prices * Update price slider to format numbers using library and new API responses for subunits * Product query of min and max prices using subunit * Fix indents in readme * Add todo for currency formatting * Handle step for subunits, fixes min/max constraints * Handle subunit conversion on display, using consistent currency object and wrapped NumberFormat component. * Prettier ran * Update usePriceConstraints tests so rounding doesn't make all values be 0 * Rename to minorUnitValue * Move currencyToNumberFormat to index file * siteCurrencySettings to constant rather than function * remove cents term * cents->minor unit * typo in todo note * Switch to FormattedMonetaryAmount * Formatting * wrong case
2019-12-18 11:29:20 +00:00
"key": "6512bd43d9caa6e02c990b0a82652dca",
"id": 11,
"quantity": 1,
"name": "Beanie",
"sku": "woo-beanie",
"permalink": "http://local.wordpress.test/product/beanie/",
"images": [
{
"id": "40",
"src": "http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2.jpg",
"thumbnail": "http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2-450x450.jpg",
"srcset": "http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2.jpg 801w, http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2-300x300.jpg 300w, http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2-150x150.jpg 150w, http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2-768x768.jpg 768w, http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2-450x450.jpg 450w, http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2-600x600.jpg 600w, http://local.wordpress.test/wp-content/uploads/2019/12/beanie-2-100x100.jpg 100w",
"sizes": "(max-width: 801px) 100vw, 801px",
"name": "beanie-2.jpg",
"alt": ""
}
],
"variation": [],
"totals": {
"currency_code": "GBP",
"currency_symbol": "£",
"currency_minor_unit": 2,
"currency_decimal_separator": ".",
"currency_thousand_separator": ",",
"currency_prefix": "£",
"currency_suffix": "",
"line_subtotal": "1500",
"line_subtotal_tax": "300",
"line_total": "1500",
"line_total_tax": "300"
},
"_links": {
"self": [
{
"href": "http://local.wordpress.test/wp-json/wc/store/cart/items/6512bd43d9caa6e02c990b0a82652dca"
}
],
"collection": [
{
"href": "http://local.wordpress.test/wp-json/wc/store/cart/items"
}
]
}
},
{
"key": "1f0e3dad99908345f7439f8ffabdffc4",
"id": 19,
"quantity": 1,
"name": "Album",
"sku": "woo-album",
"permalink": "http://local.wordpress.test/product/album/",
"images": [
{
"id": "48",
"src": "http://local.wordpress.test/wp-content/uploads/2019/12/album-1.jpg",
"thumbnail": "http://local.wordpress.test/wp-content/uploads/2019/12/album-1-450x450.jpg",
"srcset": "http://local.wordpress.test/wp-content/uploads/2019/12/album-1.jpg 800w, http://local.wordpress.test/wp-content/uploads/2019/12/album-1-300x300.jpg 300w, http://local.wordpress.test/wp-content/uploads/2019/12/album-1-150x150.jpg 150w, http://local.wordpress.test/wp-content/uploads/2019/12/album-1-768x768.jpg 768w, http://local.wordpress.test/wp-content/uploads/2019/12/album-1-450x450.jpg 450w, http://local.wordpress.test/wp-content/uploads/2019/12/album-1-600x600.jpg 600w, http://local.wordpress.test/wp-content/uploads/2019/12/album-1-100x100.jpg 100w",
"sizes": "(max-width: 800px) 100vw, 800px",
"name": "album-1.jpg",
"alt": ""
}
],
"variation": [],
"totals": {
"currency_code": "GBP",
"currency_symbol": "£",
"currency_minor_unit": 2,
"currency_decimal_separator": ".",
"currency_thousand_separator": ",",
"currency_prefix": "£",
"currency_suffix": "",
"line_subtotal": "1250",
"line_subtotal_tax": "250",
"line_total": "1250",
"line_total_tax": "250"
},
"_links": {
"self": [
{
"href": "http://local.wordpress.test/wp-json/wc/store/cart/items/1f0e3dad99908345f7439f8ffabdffc4"
}
],
"collection": [
{
"href": "http://local.wordpress.test/wp-json/wc/store/cart/items"
}
]
}
},
{
"key": "c20ad4d76fe97759aa27a0c99bff6710",
"id": 12,
"quantity": 1,
"name": "Belt",
"sku": "woo-belt",
"permalink": "http://local.wordpress.test/product/belt/",
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
"images": [
{
More API price formatting and currency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1394) * Consistent currency data and formatting for product prices * Consistent get_store_currency_properties usage * Update tests with schema changes * min_price and max_price to subunit format * Product query of min and max prices using subunit * Cart item totals * Collection data schema object and currency data inclusion * Handle subunits and new API in product prices * Update price slider to format numbers using library and new API responses for subunits * Product query of min and max prices using subunit * Fix indents in readme * Add todo for currency formatting * Handle step for subunits, fixes min/max constraints * Handle subunit conversion on display, using consistent currency object and wrapped NumberFormat component. * Prettier ran * Update usePriceConstraints tests so rounding doesn't make all values be 0 * Rename to minorUnitValue * Move currencyToNumberFormat to index file * siteCurrencySettings to constant rather than function * remove cents term * cents->minor unit * typo in todo note * Switch to FormattedMonetaryAmount * Formatting * wrong case
2019-12-18 11:29:20 +00:00
"id": "41",
"src": "http://local.wordpress.test/wp-content/uploads/2019/12/belt-2.jpg",
"thumbnail": "http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-450x450.jpg",
"srcset": "http://local.wordpress.test/wp-content/uploads/2019/12/belt-2.jpg 801w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-300x300.jpg 300w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-150x150.jpg 150w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-768x768.jpg 768w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-450x450.jpg 450w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-600x600.jpg 600w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-100x100.jpg 100w",
"sizes": "(max-width: 801px) 100vw, 801px",
"name": "belt-2.jpg",
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
"alt": ""
}
],
More API price formatting and currency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1394) * Consistent currency data and formatting for product prices * Consistent get_store_currency_properties usage * Update tests with schema changes * min_price and max_price to subunit format * Product query of min and max prices using subunit * Cart item totals * Collection data schema object and currency data inclusion * Handle subunits and new API in product prices * Update price slider to format numbers using library and new API responses for subunits * Product query of min and max prices using subunit * Fix indents in readme * Add todo for currency formatting * Handle step for subunits, fixes min/max constraints * Handle subunit conversion on display, using consistent currency object and wrapped NumberFormat component. * Prettier ran * Update usePriceConstraints tests so rounding doesn't make all values be 0 * Rename to minorUnitValue * Move currencyToNumberFormat to index file * siteCurrencySettings to constant rather than function * remove cents term * cents->minor unit * typo in todo note * Switch to FormattedMonetaryAmount * Formatting * wrong case
2019-12-18 11:29:20 +00:00
"variation": [],
"totals": {
"currency_code": "GBP",
"currency_symbol": "£",
"currency_minor_unit": 2,
"currency_decimal_separator": ".",
"currency_thousand_separator": ",",
"currency_prefix": "£",
"currency_suffix": "",
"line_subtotal": "4583",
"line_subtotal_tax": "917",
"line_total": "4583",
"line_total_tax": "917"
},
"_links": {
"self": [
{
"href": "http://local.wordpress.test/wp-json/wc/store/cart/items/c20ad4d76fe97759aa27a0c99bff6710"
}
],
"collection": [
{
"href": "http://local.wordpress.test/wp-json/wc/store/cart/items"
}
]
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
}
}
]
```
### Single cart item
Get a single cart item.
```http
GET /cart/items/:key
```
| Attribute | Type | Required | Description |
| :-------- | :----- | :------: | :------------------------------------ |
| `key` | string | Yes | The key of the cart item to retrieve. |
```http
curl "https://example-store.com/wp-json/wc/store/cart/items/11a7ec12ea1071fdecd917d6da5c87ae"
```
Example response:
```json
{
More API price formatting and currency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1394) * Consistent currency data and formatting for product prices * Consistent get_store_currency_properties usage * Update tests with schema changes * min_price and max_price to subunit format * Product query of min and max prices using subunit * Cart item totals * Collection data schema object and currency data inclusion * Handle subunits and new API in product prices * Update price slider to format numbers using library and new API responses for subunits * Product query of min and max prices using subunit * Fix indents in readme * Add todo for currency formatting * Handle step for subunits, fixes min/max constraints * Handle subunit conversion on display, using consistent currency object and wrapped NumberFormat component. * Prettier ran * Update usePriceConstraints tests so rounding doesn't make all values be 0 * Rename to minorUnitValue * Move currencyToNumberFormat to index file * siteCurrencySettings to constant rather than function * remove cents term * cents->minor unit * typo in todo note * Switch to FormattedMonetaryAmount * Formatting * wrong case
2019-12-18 11:29:20 +00:00
"key": "c20ad4d76fe97759aa27a0c99bff6710",
"id": 12,
"quantity": 1,
"name": "Belt",
"sku": "woo-belt",
"permalink": "http://local.wordpress.test/product/belt/",
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
"images": [
{
More API price formatting and currency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1394) * Consistent currency data and formatting for product prices * Consistent get_store_currency_properties usage * Update tests with schema changes * min_price and max_price to subunit format * Product query of min and max prices using subunit * Cart item totals * Collection data schema object and currency data inclusion * Handle subunits and new API in product prices * Update price slider to format numbers using library and new API responses for subunits * Product query of min and max prices using subunit * Fix indents in readme * Add todo for currency formatting * Handle step for subunits, fixes min/max constraints * Handle subunit conversion on display, using consistent currency object and wrapped NumberFormat component. * Prettier ran * Update usePriceConstraints tests so rounding doesn't make all values be 0 * Rename to minorUnitValue * Move currencyToNumberFormat to index file * siteCurrencySettings to constant rather than function * remove cents term * cents->minor unit * typo in todo note * Switch to FormattedMonetaryAmount * Formatting * wrong case
2019-12-18 11:29:20 +00:00
"id": "41",
"src": "http://local.wordpress.test/wp-content/uploads/2019/12/belt-2.jpg",
"thumbnail": "http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-450x450.jpg",
"srcset": "http://local.wordpress.test/wp-content/uploads/2019/12/belt-2.jpg 801w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-300x300.jpg 300w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-150x150.jpg 150w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-768x768.jpg 768w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-450x450.jpg 450w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-600x600.jpg 600w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-100x100.jpg 100w",
"sizes": "(max-width: 801px) 100vw, 801px",
"name": "belt-2.jpg",
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
"alt": ""
}
],
More API price formatting and currency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1394) * Consistent currency data and formatting for product prices * Consistent get_store_currency_properties usage * Update tests with schema changes * min_price and max_price to subunit format * Product query of min and max prices using subunit * Cart item totals * Collection data schema object and currency data inclusion * Handle subunits and new API in product prices * Update price slider to format numbers using library and new API responses for subunits * Product query of min and max prices using subunit * Fix indents in readme * Add todo for currency formatting * Handle step for subunits, fixes min/max constraints * Handle subunit conversion on display, using consistent currency object and wrapped NumberFormat component. * Prettier ran * Update usePriceConstraints tests so rounding doesn't make all values be 0 * Rename to minorUnitValue * Move currencyToNumberFormat to index file * siteCurrencySettings to constant rather than function * remove cents term * cents->minor unit * typo in todo note * Switch to FormattedMonetaryAmount * Formatting * wrong case
2019-12-18 11:29:20 +00:00
"variation": [],
"totals": {
"currency_code": "GBP",
"currency_symbol": "£",
"currency_minor_unit": 2,
"currency_decimal_separator": ".",
"currency_thousand_separator": ",",
"currency_prefix": "£",
"currency_suffix": "",
"line_subtotal": "4583",
"line_subtotal_tax": "917",
"line_total": "4583",
"line_total_tax": "917"
},
"_links": {
"self": [
{
"href": "http://local.wordpress.test/wp-json/wc/store/cart/items/c20ad4d76fe97759aa27a0c99bff6710"
}
],
"collection": [
{
"href": "http://local.wordpress.test/wp-json/wc/store/cart/items"
}
]
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
}
}
```
### New cart item
Add an item to the cart.
```http
POST /cart/items/
```
| Attribute | Type | Required | Description |
| :---------- | :------ | :------: | :--------------------------------------------------------------------------------------------------- |
| `id` | integer | Yes | The cart item product or variation ID. |
| `quantity` | integer | Yes | Quantity of this item in the cart. |
| `variation` | array | Yes | Chosen attributes (for variations) containing an array of objects with keys `attribute` and `value`. |
```http
curl --request POST https://example-store.com/wp-json/wc/store/cart/items?id=100&quantity=1
```
Example response:
```json
{
"key": "3ef815416f775098fe977004015c6193",
"id": 100,
"quantity": 1,
"name": "Single",
"sku": "woo-single",
"permalink": "http://local.wordpress.test/product/single/",
"images": [
{
"id": 56,
"src": "http://local.wordpress.test/wp-content/uploads/2019/07/single-1.jpg",
"name": "single-1.jpg",
"alt": ""
}
],
More API price formatting and currency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1394) * Consistent currency data and formatting for product prices * Consistent get_store_currency_properties usage * Update tests with schema changes * min_price and max_price to subunit format * Product query of min and max prices using subunit * Cart item totals * Collection data schema object and currency data inclusion * Handle subunits and new API in product prices * Update price slider to format numbers using library and new API responses for subunits * Product query of min and max prices using subunit * Fix indents in readme * Add todo for currency formatting * Handle step for subunits, fixes min/max constraints * Handle subunit conversion on display, using consistent currency object and wrapped NumberFormat component. * Prettier ran * Update usePriceConstraints tests so rounding doesn't make all values be 0 * Rename to minorUnitValue * Move currencyToNumberFormat to index file * siteCurrencySettings to constant rather than function * remove cents term * cents->minor unit * typo in todo note * Switch to FormattedMonetaryAmount * Formatting * wrong case
2019-12-18 11:29:20 +00:00
"product_price": "5500",
"line_subtotal": "4583",
"line_subtotal_tax": "917",
"line_total": "4583",
"line_total_tax": "917",
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
"variation": []
}
```
### Edit single cart item
Edit an item in the cart.
```http
PUT /cart/items/:key
```
| Attribute | Type | Required | Description |
| :--------- | :------ | :------: | :--------------------------------- |
| `key` | string | Yes | The key of the cart item to edit. |
| `quantity` | integer | Yes | Quantity of this item in the cart. |
```http
curl --request PUT https://example-store.com/wp-json/wc/store/cart/items/3ef815416f775098fe977004015c6193&quantity=10
```
Example response:
```json
{
"key": "3ef815416f775098fe977004015c6193",
"id": 100,
"quantity": 10,
"name": "Single",
"sku": "woo-single",
"permalink": "http://local.wordpress.test/product/single/",
"images": [
{
"id": 56,
"src": "http://local.wordpress.test/wp-content/uploads/2019/07/single-1.jpg",
"name": "single-1.jpg",
"alt": ""
}
],
More API price formatting and currency handling (https://github.com/woocommerce/woocommerce-blocks/pull/1394) * Consistent currency data and formatting for product prices * Consistent get_store_currency_properties usage * Update tests with schema changes * min_price and max_price to subunit format * Product query of min and max prices using subunit * Cart item totals * Collection data schema object and currency data inclusion * Handle subunits and new API in product prices * Update price slider to format numbers using library and new API responses for subunits * Product query of min and max prices using subunit * Fix indents in readme * Add todo for currency formatting * Handle step for subunits, fixes min/max constraints * Handle subunit conversion on display, using consistent currency object and wrapped NumberFormat component. * Prettier ran * Update usePriceConstraints tests so rounding doesn't make all values be 0 * Rename to minorUnitValue * Move currencyToNumberFormat to index file * siteCurrencySettings to constant rather than function * remove cents term * cents->minor unit * typo in todo note * Switch to FormattedMonetaryAmount * Formatting * wrong case
2019-12-18 11:29:20 +00:00
"product_price": "5500",
"line_subtotal": "4583",
"line_subtotal_tax": "917",
"line_total": "4583",
"line_total_tax": "917",
REST API - Store API - Product filtering data, products endpoint, and cart refinements (https://github.com/woocommerce/woocommerce-blocks/pull/1055) * Cart add endpoint and schema * Empty card DELETE method * Merge into single controller * Revise verb usage * PUT/update requests * Move under rest api namespace * Basic test coverage * Invalid tests with status check * Variation handling * Update src/RestApi/StoreApi/Schemas/CartItemSchema.php Co-Authored-By: Albert Juhé Lluveras <contact@albertjuhe.com> * Remove key arg for delete endpoint * code comment for creation * rename param to product_id * Renaming methods from _item to _cart_item * Prepare storeAPI products endpoint for public use * Price filter headers * Attribute counts * Add Rating filter * Rating counts * Fix counts * Moved utilities * API docs * Use correct response for cart item * Attributes filtering * Stats * Products/Stats unit tests * Rename stats to collection data * Remove `embed` from schema * Add since $VID:$ tags * Improve operator logic and add isset checks * Force cart schema to be readonly
2019-10-25 09:43:52 +00:00
"variation": []
}
```
### Delete single cart item
Delete/remove an item from the cart.
```http
DELETE /cart/items/:key
```
| Attribute | Type | Required | Description |
| :-------- | :----- | :------: | :-------------------------------- |
| `key` | string | Yes | The key of the cart item to edit. |
```http
curl --request DELETE https://example-store.com/wp-json/wc/store/cart/items/3ef815416f775098fe977004015c6193
```
### Delete all cart items
Delete/remove all items from the cart.
```http
DELETE /cart/items/
```
There are no parameters required for this endpoint.
```http
curl --request DELETE https://example-store.com/wp-json/wc/store/cart/items
```
Example response:
```json
[]
```
Filter all products block by attribute (https://github.com/woocommerce/woocommerce-blocks/pull/1127) * Block setup * Working filtering and intersection of arrays * Implement block settings and no attribute placeholder * Correctly toggle counts * Implement filtering * Fix price slider constraints * Fix price slider constraints * Edit mode * Rename ProductAttributeControl to ProductAttributeTermControl * Attribute ID saving * fix incorrect test fixtures * fix incorrect regex for parsing model (or resource names) from the route. * Fix query classes for some endpoints * Style improvements * Update inline comments * use previous tests * Show attribute control in sidebar * Remove displayStyle option * Sort attributes by name * Show more/less toggle * Use renderFrontend * Only sort when adding values * Rename memo placeholder * More specific CSS for pointer * Update assets/js/base/hooks/use-query-state.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Remove always true taxonomy check * Update assets/js/blocks/attribute-filter/block.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Remove lodash join * native js for string casting * Move internal deps * hyphenate attributes * Correct data set names * Remove unwanted dependency * Moving imports * Missing deps * replace yoda conditonal * Missing deps * Missing deps * Check value exists * Remove undefined filter * renderedOptions usememo * Set defaults in checkbox list * Show more/less refactor * Use getAdminLink * Fix object length check * Correct AND query handling for counts * useQueryStateByContext * Add store rest endpoints * Update assets/js/base/components/checkbox-list/index.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Update assets/js/base/components/checkbox-list/index.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Update assets/js/base/components/checkbox-list/index.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Update assets/js/blocks/attribute-filter/block.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Feedback * feedback * API readme * Fix API relation queries for multiple attributes * Prevent all options flashing visible during loads * null check * Improve loading state * Remove null options change - it's no longer needed
2019-11-11 10:32:56 +00:00
Store API: Add cart coupon endpoints (https://github.com/woocommerce/woocommerce-blocks/pull/1378) * Correct docblock * Implement coupons endpoint with add/delete/get functionality * Add totals * Use money formatting * Added tests for new endpoints * Add coupons to main cart endpoint and update docs to match * Fix indenting in readme * is_a to instanceof * Update coupon_exists logic * Documentation/tidy class * Update currency responses for coupon totals w/ tests
2019-12-19 12:41:34 +00:00
## Cart coupons API
### List cart coupons
```http
GET /cart/coupons
```
There are no parameters required for this endpoint.
```http
curl "https://example-store.com/wp-json/wc/store/cart/items"
```
Example response:
```json
[
REST API - Cart Order API (https://github.com/woocommerce/woocommerce-blocks/pull/1425) * Checkout/order WIP schema * Add _address suffix for billing/shipping * Rename schema, update endpoints, create tests * Fix POST in test * Fix test response checks * Stock reservation and draft order status * Add todo for shipping lines * Readme * Rename address fields in readme * 10 min timeout of stock * Fix broken test * Update src/RestApi/StoreApi/Controllers/CartOrder.php Co-Authored-By: Darren Ethier <darren@roughsmootheng.in> * Add typehinting where possible * Remove explicit pass by reference * Further typehinting * Clarify todo comment * Validate product instances * Specific phpcs exclusion rule * Exclusion rule * Move ReserveStock code to class * Correct shipping-rates schema to shipping_rates * Save shipping rates and lines if included with request * Insert todo for shipping rate code * Calculate shipping and selected shipping from order properties, not global cart properties * Prevent error when shipping is not needed * Update API readme * Added tests for stock reserve class * Fixes conflicts with draft statuses Co-authored-by: Darren Ethier <darren@roughsmootheng.in>
2020-01-10 13:53:16 +00:00
{
"code": "20off",
"totals": {
"currency_code": "GBP",
"currency_symbol": "£",
"currency_minor_unit": 2,
"currency_decimal_separator": ".",
"currency_thousand_separator": ",",
"currency_prefix": "£",
"currency_suffix": "",
"total_discount": "1667",
"total_discount_tax": "333"
},
"_links": {
"self": [
{
"href": "http://local.wordpress.test/wp-json/wc/store/cart/coupons/20off"
}
],
"collection": [
{
"href": "http://local.wordpress.test/wp-json/wc/store/cart/coupons"
}
]
}
}
Store API: Add cart coupon endpoints (https://github.com/woocommerce/woocommerce-blocks/pull/1378) * Correct docblock * Implement coupons endpoint with add/delete/get functionality * Add totals * Use money formatting * Added tests for new endpoints * Add coupons to main cart endpoint and update docs to match * Fix indenting in readme * is_a to instanceof * Update coupon_exists logic * Documentation/tidy class * Update currency responses for coupon totals w/ tests
2019-12-19 12:41:34 +00:00
]
```
### Single cart coupon
Get a single cart coupon.
```http
GET /cart/coupons/:code
```
| Attribute | Type | Required | Description |
| :-------- | :----- | :------: | :---------------------------------------------- |
| `code` | string | Yes | The coupon code of the cart coupon to retrieve. |
```http
curl "https://example-store.com/wp-json/wc/store/cart/coupons/20off"
```
Example response:
```json
{
REST API - Cart Order API (https://github.com/woocommerce/woocommerce-blocks/pull/1425) * Checkout/order WIP schema * Add _address suffix for billing/shipping * Rename schema, update endpoints, create tests * Fix POST in test * Fix test response checks * Stock reservation and draft order status * Add todo for shipping lines * Readme * Rename address fields in readme * 10 min timeout of stock * Fix broken test * Update src/RestApi/StoreApi/Controllers/CartOrder.php Co-Authored-By: Darren Ethier <darren@roughsmootheng.in> * Add typehinting where possible * Remove explicit pass by reference * Further typehinting * Clarify todo comment * Validate product instances * Specific phpcs exclusion rule * Exclusion rule * Move ReserveStock code to class * Correct shipping-rates schema to shipping_rates * Save shipping rates and lines if included with request * Insert todo for shipping rate code * Calculate shipping and selected shipping from order properties, not global cart properties * Prevent error when shipping is not needed * Update API readme * Added tests for stock reserve class * Fixes conflicts with draft statuses Co-authored-by: Darren Ethier <darren@roughsmootheng.in>
2020-01-10 13:53:16 +00:00
"code": "20off",
"totals": {
"currency_code": "GBP",
"currency_symbol": "£",
"currency_minor_unit": 2,
"currency_decimal_separator": ".",
"currency_thousand_separator": ",",
"currency_prefix": "£",
"currency_suffix": "",
"total_discount": "1667",
"total_discount_tax": "333"
}
Store API: Add cart coupon endpoints (https://github.com/woocommerce/woocommerce-blocks/pull/1378) * Correct docblock * Implement coupons endpoint with add/delete/get functionality * Add totals * Use money formatting * Added tests for new endpoints * Add coupons to main cart endpoint and update docs to match * Fix indenting in readme * is_a to instanceof * Update coupon_exists logic * Documentation/tidy class * Update currency responses for coupon totals w/ tests
2019-12-19 12:41:34 +00:00
}
```
### New cart coupon
Apply a coupon to the cart.
```http
POST /cart/coupons/
```
| Attribute | Type | Required | Description |
| :-------- | :----- | :------: | :--------------------------------------------- |
| `code` | string | Yes | The coupon code you wish to apply to the cart. |
```http
curl --request POST https://example-store.com/wp-json/wc/store/cart/coupons?code=20off
```
Example response:
```json
{
REST API - Cart Order API (https://github.com/woocommerce/woocommerce-blocks/pull/1425) * Checkout/order WIP schema * Add _address suffix for billing/shipping * Rename schema, update endpoints, create tests * Fix POST in test * Fix test response checks * Stock reservation and draft order status * Add todo for shipping lines * Readme * Rename address fields in readme * 10 min timeout of stock * Fix broken test * Update src/RestApi/StoreApi/Controllers/CartOrder.php Co-Authored-By: Darren Ethier <darren@roughsmootheng.in> * Add typehinting where possible * Remove explicit pass by reference * Further typehinting * Clarify todo comment * Validate product instances * Specific phpcs exclusion rule * Exclusion rule * Move ReserveStock code to class * Correct shipping-rates schema to shipping_rates * Save shipping rates and lines if included with request * Insert todo for shipping rate code * Calculate shipping and selected shipping from order properties, not global cart properties * Prevent error when shipping is not needed * Update API readme * Added tests for stock reserve class * Fixes conflicts with draft statuses Co-authored-by: Darren Ethier <darren@roughsmootheng.in>
2020-01-10 13:53:16 +00:00
"code": "20off",
"totals": {
"currency_code": "GBP",
"currency_symbol": "£",
"currency_minor_unit": 2,
"currency_decimal_separator": ".",
"currency_thousand_separator": ",",
"currency_prefix": "£",
"currency_suffix": "",
"total_discount": "1667",
"total_discount_tax": "333"
}
Store API: Add cart coupon endpoints (https://github.com/woocommerce/woocommerce-blocks/pull/1378) * Correct docblock * Implement coupons endpoint with add/delete/get functionality * Add totals * Use money formatting * Added tests for new endpoints * Add coupons to main cart endpoint and update docs to match * Fix indenting in readme * is_a to instanceof * Update coupon_exists logic * Documentation/tidy class * Update currency responses for coupon totals w/ tests
2019-12-19 12:41:34 +00:00
}
```
### Delete single cart coupon
Delete/remove a coupon from the cart.
```http
DELETE /cart/coupons/:code
```
| Attribute | Type | Required | Description |
| :-------- | :----- | :------: | :------------------------------------------------ |
| `code` | string | Yes | The coupon code you wish to remove from the cart. |
```http
curl --request DELETE https://example-store.com/wp-json/wc/store/cart/coupons/20off
```
### Delete all cart coupons
Delete/remove all coupons from the cart.
```http
DELETE /cart/coupons/
```
There are no parameters required for this endpoint.
```http
curl --request DELETE https://example-store.com/wp-json/wc/store/cart/coupons
```
Example response:
```json
[]
```
Store API: Add shipping rate api (https://github.com/woocommerce/woocommerce-blocks/pull/1344) * Add basic controllers * Schema * Collections * Updated schema * Remove package ID * Destination handling * Destination validation * Rename method for extra clarity * Tests * RestContoller type * typos * Fix object/array definitions * Fix shipping-rate definition * Fix tests * Add docs * Tweak description
2019-12-10 13:54:18 +00:00
## Cart shipping rates API
### Get shipping rates for current cart
```http
GET /cart/shipping-rates?address_1=&address_2=&city=&state=&postcode=90210&country=US
```
| Attribute | Type | Required | Description |
| :---------- | :----- | :------: | :--------------------------------------------------------------------------------------- |
| `address_1` | string | no | First line of the address being shipped to. |
| `address_2` | string | no | Second line of the address being shipped to. |
| `city` | string | no | City of the address being shipped to. |
| `state` | string | no | ISO code, or name, for the state, province, or district of the address being shipped to. |
| `postcode` | string | no | Zip or Postcode of the address being shipped to. |
| `country` | string | yes | ISO code for the country of the address being shipped to. |
```http
curl "https://example-store.com/wp-json/wc/store/cart/shipping-rates?country=US&state=AL"
```
Example response:
```json
[
{
"destination": {
"address_1": null,
"address_2": null,
"city": null,
"state": "AL",
"postcode": null,
"country": "US"
},
"items": [ "6512bd43d9caa6e02c990b0a82652dca" ],
REST API - Cart Order API (https://github.com/woocommerce/woocommerce-blocks/pull/1425) * Checkout/order WIP schema * Add _address suffix for billing/shipping * Rename schema, update endpoints, create tests * Fix POST in test * Fix test response checks * Stock reservation and draft order status * Add todo for shipping lines * Readme * Rename address fields in readme * 10 min timeout of stock * Fix broken test * Update src/RestApi/StoreApi/Controllers/CartOrder.php Co-Authored-By: Darren Ethier <darren@roughsmootheng.in> * Add typehinting where possible * Remove explicit pass by reference * Further typehinting * Clarify todo comment * Validate product instances * Specific phpcs exclusion rule * Exclusion rule * Move ReserveStock code to class * Correct shipping-rates schema to shipping_rates * Save shipping rates and lines if included with request * Insert todo for shipping rate code * Calculate shipping and selected shipping from order properties, not global cart properties * Prevent error when shipping is not needed * Update API readme * Added tests for stock reserve class * Fixes conflicts with draft statuses Co-authored-by: Darren Ethier <darren@roughsmootheng.in>
2020-01-10 13:53:16 +00:00
"shipping_rates": [
Store API: Add shipping rate api (https://github.com/woocommerce/woocommerce-blocks/pull/1344) * Add basic controllers * Schema * Collections * Updated schema * Remove package ID * Destination handling * Destination validation * Rename method for extra clarity * Tests * RestContoller type * typos * Fix object/array definitions * Fix shipping-rate definition * Fix tests * Add docs * Tweak description
2019-12-10 13:54:18 +00:00
{
"name": "International",
"description": "",
"delivery_time": "",
"price": "20.00",
"rate_id": "flat_rate:3",
"instance_id": 3,
"method_id": "flat_rate",
"meta_data": [
{
"key": "Items",
"value": "Beanie &times; 1"
}
]
}
]
}
]
```
REST API - Cart Order API (https://github.com/woocommerce/woocommerce-blocks/pull/1425) * Checkout/order WIP schema * Add _address suffix for billing/shipping * Rename schema, update endpoints, create tests * Fix POST in test * Fix test response checks * Stock reservation and draft order status * Add todo for shipping lines * Readme * Rename address fields in readme * 10 min timeout of stock * Fix broken test * Update src/RestApi/StoreApi/Controllers/CartOrder.php Co-Authored-By: Darren Ethier <darren@roughsmootheng.in> * Add typehinting where possible * Remove explicit pass by reference * Further typehinting * Clarify todo comment * Validate product instances * Specific phpcs exclusion rule * Exclusion rule * Move ReserveStock code to class * Correct shipping-rates schema to shipping_rates * Save shipping rates and lines if included with request * Insert todo for shipping rate code * Calculate shipping and selected shipping from order properties, not global cart properties * Prevent error when shipping is not needed * Update API readme * Added tests for stock reserve class * Fixes conflicts with draft statuses Co-authored-by: Darren Ethier <darren@roughsmootheng.in>
2020-01-10 13:53:16 +00:00
## Cart Order API
Create a new order from the items in the cart.
```http
POST /cart/order/
```
| Attribute | Type | Required | Description |
| :----------------- | :----- | :------: | :-------------------------------------------------------------------------------------- |
| `billing_address` | array | No | Billing address data to store to the new order. |
| `shipping_address` | array | No | Shipping address data to store to the new order. |
| `customer_note` | string | No | Customer note to store to the new order. |
| `shipping_rates` | array | No | Array of objects containing `rate_id` of selected shipping methods to add to the order. |
```http
curl --request POST https://example-store.com/wp-json/wc/store/cart/order
```
Example response:
```json
{
"id": 149,
"number": "149",
"status": "draft",
"order_key": "wc_order_9falc306dOkWb",
"created_via": "store-api",
"prices_include_tax": true,
"events": {
"date_created": "2020-01-07T12:33:23",
"date_created_gmt": "2020-01-07T12:33:23",
"date_modified": "2020-01-07T12:33:23",
"date_modified_gmt": "2020-01-07T12:33:23",
"date_completed": null,
"date_completed_gmt": null,
"date_paid": null,
"date_paid_gmt": null
},
"customer": {
"customer_id": 1,
"customer_ip_address": "192.168.50.1",
"customer_user_agent": "insomnia/7.0.5"
},
"customer_note": "This is a customer note.",
"billing_address": {
"first_name": "Margaret",
"last_name": "Thatchcroft",
"company": "",
"address_1": "123 South Street",
"address_2": "Apt 1",
"city": "Philadelphia",
"state": "PA",
"postcode": "19123",
"country": "US",
"email": "test@test.com",
"phone": ""
},
"shipping_address": {
"first_name": "Margaret",
"last_name": "Thatchcroft",
"company": "",
"address_1": "123 South Street",
"address_2": "Apt 1",
"city": "Philadelphia",
"state": "PA",
"postcode": "19123",
"country": "US"
},
"items": [
{
"id": 12,
"quantity": 1,
"name": "Belt",
"sku": "woo-belt",
"permalink": "http://local.wordpress.test/product/belt/",
"images": [
{
"id": "41",
"src": "http://local.wordpress.test/wp-content/uploads/2019/12/belt-2.jpg",
"thumbnail": "http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-300x300.jpg",
"srcset": "http://local.wordpress.test/wp-content/uploads/2019/12/belt-2.jpg 801w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-300x300.jpg 300w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-100x100.jpg 100w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-450x450.jpg 450w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-150x150.jpg 150w, http://local.wordpress.test/wp-content/uploads/2019/12/belt-2-768x768.jpg 768w",
"sizes": "(max-width: 801px) 100vw, 801px",
"name": "belt-2.jpg",
"alt": ""
}
],
"variation": [],
"totals": {
"currency_code": "GBP",
"currency_symbol": "£",
"currency_minor_unit": 2,
"currency_decimal_separator": ".",
"currency_thousand_separator": ",",
"currency_prefix": "£",
"currency_suffix": "",
"line_subtotal": "4583",
"line_subtotal_tax": "917",
"line_total": "4583",
"line_total_tax": "917"
}
}
],
"totals": {
"currency_code": "GBP",
"currency_symbol": "£",
"currency_minor_unit": 2,
"currency_decimal_separator": ".",
"currency_thousand_separator": ",",
"currency_prefix": "£",
"currency_suffix": "",
"total_items": "4583",
"total_items_tax": "917",
"total_fees": "0",
"total_fees_tax": "0",
"total_discount": "0",
"total_discount_tax": "0",
"total_shipping": "499",
"total_shipping_tax": "100",
"total_price": "6099",
"total_tax": "1017",
"tax_lines": [
{
"name": "Tax",
"price": "1017"
}
]
}
}
```
Store API: Add customer endpoints (https://github.com/woocommerce/woocommerce-blocks/pull/1417) * Add schema/GET endpoint * Customer data updates + create tests * Update docs * Unused method * Use ID from the customer object, rather than checking logged in user * PHP 5.6 incompatibility
2019-12-20 16:07:53 +00:00
## Customer API
### Get data for the current customer
```http
GET /cart/customer
```
There are no parameters required for this endpoint.
```http
curl "https://example-store.com/wp-json/wc/store/customer"
```
Example response:
```json
{
REST API - Cart Order API (https://github.com/woocommerce/woocommerce-blocks/pull/1425) * Checkout/order WIP schema * Add _address suffix for billing/shipping * Rename schema, update endpoints, create tests * Fix POST in test * Fix test response checks * Stock reservation and draft order status * Add todo for shipping lines * Readme * Rename address fields in readme * 10 min timeout of stock * Fix broken test * Update src/RestApi/StoreApi/Controllers/CartOrder.php Co-Authored-By: Darren Ethier <darren@roughsmootheng.in> * Add typehinting where possible * Remove explicit pass by reference * Further typehinting * Clarify todo comment * Validate product instances * Specific phpcs exclusion rule * Exclusion rule * Move ReserveStock code to class * Correct shipping-rates schema to shipping_rates * Save shipping rates and lines if included with request * Insert todo for shipping rate code * Calculate shipping and selected shipping from order properties, not global cart properties * Prevent error when shipping is not needed * Update API readme * Added tests for stock reserve class * Fixes conflicts with draft statuses Co-authored-by: Darren Ethier <darren@roughsmootheng.in>
2020-01-10 13:53:16 +00:00
"id": 0,
"billing_address": {
"first_name": "Margaret",
"last_name": "Thatchcroft",
"company": "",
"address_1": "123 South Street",
"address_2": "Apt 1",
"city": "Philadelphia",
"state": "PA",
"postcode": "19123",
"country": "US",
"email": "test@test.com",
"phone": ""
},
"shipping_address": {
"first_name": "Margaret",
"last_name": "Thatchcroft",
"company": "",
"address_1": "123 South Street",
"address_2": "Apt 1",
"city": "Philadelphia",
"state": "PA",
"postcode": "19123",
"country": "US"
}
Store API: Add customer endpoints (https://github.com/woocommerce/woocommerce-blocks/pull/1417) * Add schema/GET endpoint * Customer data updates + create tests * Update docs * Unused method * Use ID from the customer object, rather than checking logged in user * PHP 5.6 incompatibility
2019-12-20 16:07:53 +00:00
}
```
### Edit data for the current customer
Edit current customer data, such as billing and shipping addresses.
```http
PUT /cart/customer
```
REST API - Cart Order API (https://github.com/woocommerce/woocommerce-blocks/pull/1425) * Checkout/order WIP schema * Add _address suffix for billing/shipping * Rename schema, update endpoints, create tests * Fix POST in test * Fix test response checks * Stock reservation and draft order status * Add todo for shipping lines * Readme * Rename address fields in readme * 10 min timeout of stock * Fix broken test * Update src/RestApi/StoreApi/Controllers/CartOrder.php Co-Authored-By: Darren Ethier <darren@roughsmootheng.in> * Add typehinting where possible * Remove explicit pass by reference * Further typehinting * Clarify todo comment * Validate product instances * Specific phpcs exclusion rule * Exclusion rule * Move ReserveStock code to class * Correct shipping-rates schema to shipping_rates * Save shipping rates and lines if included with request * Insert todo for shipping rate code * Calculate shipping and selected shipping from order properties, not global cart properties * Prevent error when shipping is not needed * Update API readme * Added tests for stock reserve class * Fixes conflicts with draft statuses Co-authored-by: Darren Ethier <darren@roughsmootheng.in>
2020-01-10 13:53:16 +00:00
| Attribute | Type | Required | Description |
| :--------- | :----- | :------: | :--------------------------- |
| `billing` | object | No | Billing address properties. |
| `shipping` | object | No | Shipping address properties. |
Store API: Add customer endpoints (https://github.com/woocommerce/woocommerce-blocks/pull/1417) * Add schema/GET endpoint * Customer data updates + create tests * Update docs * Unused method * Use ID from the customer object, rather than checking logged in user * PHP 5.6 incompatibility
2019-12-20 16:07:53 +00:00
```http
curl --request PUT https://example-store.com/wp-json/wc/store/cart/customer?billing[company]=Test
```
Example response:
```json
{
REST API - Cart Order API (https://github.com/woocommerce/woocommerce-blocks/pull/1425) * Checkout/order WIP schema * Add _address suffix for billing/shipping * Rename schema, update endpoints, create tests * Fix POST in test * Fix test response checks * Stock reservation and draft order status * Add todo for shipping lines * Readme * Rename address fields in readme * 10 min timeout of stock * Fix broken test * Update src/RestApi/StoreApi/Controllers/CartOrder.php Co-Authored-By: Darren Ethier <darren@roughsmootheng.in> * Add typehinting where possible * Remove explicit pass by reference * Further typehinting * Clarify todo comment * Validate product instances * Specific phpcs exclusion rule * Exclusion rule * Move ReserveStock code to class * Correct shipping-rates schema to shipping_rates * Save shipping rates and lines if included with request * Insert todo for shipping rate code * Calculate shipping and selected shipping from order properties, not global cart properties * Prevent error when shipping is not needed * Update API readme * Added tests for stock reserve class * Fixes conflicts with draft statuses Co-authored-by: Darren Ethier <darren@roughsmootheng.in>
2020-01-10 13:53:16 +00:00
"id": 0,
"billing_address": {
"first_name": "Margaret",
"last_name": "Thatchcroft",
"company": "Test",
"address_1": "123 South Street",
"address_2": "Apt 1",
"city": "Philadelphia",
"state": "PA",
"postcode": "19123",
"country": "US",
"email": "test@test.com",
"phone": ""
},
"shipping_address": {
"first_name": "Margaret",
"last_name": "Thatchcroft",
"company": "",
"address_1": "123 South Street",
"address_2": "Apt 1",
"city": "Philadelphia",
"state": "PA",
"postcode": "19123",
"country": "US"
}
Store API: Add customer endpoints (https://github.com/woocommerce/woocommerce-blocks/pull/1417) * Add schema/GET endpoint * Customer data updates + create tests * Update docs * Unused method * Use ID from the customer object, rather than checking logged in user * PHP 5.6 incompatibility
2019-12-20 16:07:53 +00:00
}
```
Filter all products block by attribute (https://github.com/woocommerce/woocommerce-blocks/pull/1127) * Block setup * Working filtering and intersection of arrays * Implement block settings and no attribute placeholder * Correctly toggle counts * Implement filtering * Fix price slider constraints * Fix price slider constraints * Edit mode * Rename ProductAttributeControl to ProductAttributeTermControl * Attribute ID saving * fix incorrect test fixtures * fix incorrect regex for parsing model (or resource names) from the route. * Fix query classes for some endpoints * Style improvements * Update inline comments * use previous tests * Show attribute control in sidebar * Remove displayStyle option * Sort attributes by name * Show more/less toggle * Use renderFrontend * Only sort when adding values * Rename memo placeholder * More specific CSS for pointer * Update assets/js/base/hooks/use-query-state.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Remove always true taxonomy check * Update assets/js/blocks/attribute-filter/block.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Remove lodash join * native js for string casting * Move internal deps * hyphenate attributes * Correct data set names * Remove unwanted dependency * Moving imports * Missing deps * replace yoda conditonal * Missing deps * Missing deps * Check value exists * Remove undefined filter * renderedOptions usememo * Set defaults in checkbox list * Show more/less refactor * Use getAdminLink * Fix object length check * Correct AND query handling for counts * useQueryStateByContext * Add store rest endpoints * Update assets/js/base/components/checkbox-list/index.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Update assets/js/base/components/checkbox-list/index.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Update assets/js/base/components/checkbox-list/index.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Update assets/js/blocks/attribute-filter/block.js Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * Feedback * feedback * API readme * Fix API relation queries for multiple attributes * Prevent all options flashing visible during loads * null check * Improve loading state * Remove null options change - it's no longer needed
2019-11-11 10:32:56 +00:00
## Product Attributes API
```http
GET /products/attributes
```
There are no parameters required for this endpoint.
```http
curl "https://example-store.com/wp-json/wc/store/products/attributes"
```
Example response:
```json
[
{
"id": 1,
"name": "Color",
"slug": "pa_color",
"type": "select",
"order": "menu_order",
"has_archives": false
},
{
"id": 2,
"name": "Size",
"slug": "pa_size",
"type": "select",
"order": "menu_order",
"has_archives": false
}
]
```
### Single attribute
Get a single attribute taxonomy.
```http
GET /products/attributes/:id
```
| Attribute | Type | Required | Description |
| :-------- | :------ | :------: | :----------------------------------- |
| `id` | integer | Yes | The ID of the attribute to retrieve. |
```http
curl "https://example-store.com/wp-json/wc/store/products/attributes/1"
```
Example response:
```json
{
"id": 1,
"name": "Color",
"slug": "pa_color",
"type": "select",
"order": "menu_order",
"has_archives": false
}
```
## Product Attribute Terms API
```http
GET /products/attributes/:id/terms
GET /products/attributes/:id/terms&orderby=slug
```
| Attribute | Type | Required | Description |
| :-------- | :------ | :------: | :---------------------------------------------------------------------------- |
| `id` | integer | Yes | The ID of the attribute to retrieve terms for. |
| `order` | string | no | Order ascending or descending. Allowed values: `asc`, `desc` |
| `orderby` | string | no | Sort collection by object attribute. Allowed values: `name`, `slug`, `count`. |
```http
curl "https://example-store.com/wp-json/wc/store/products/attributes/1/terms"
```
Example response:
```json
[
{
"id": 22,
"name": "Blue",
"slug": "blue",
"count": 5
},
{
"id": 48,
"name": "Burgundy",
"slug": "burgundy",
"count": 1
}
]
```