woocommerce/plugins/woocommerce-blocks/docs/third-party-developers/extensibility/rest-api
Saad Tarhi 8f99863a2e Create add to custom fields documentation (https://github.com/woocommerce/woocommerce-blocks/pull/11787)
* Create add to custom fields documentation

* Update the checkout custom field docs

* Add back end steps and examples

* Make it clear that we are building a field block

* Update docs/third-party-developers/extensibility/rest-api/extend-rest-api-add-custom-fields.md

Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com>

* Update docs/third-party-developers/extensibility/rest-api/extend-rest-api-add-custom-fields.md

Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com>

* Update docs/third-party-developers/extensibility/rest-api/extend-rest-api-add-custom-fields.md

Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com>

* Update docs/third-party-developers/extensibility/rest-api/extend-rest-api-add-custom-fields.md

Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com>

* Mention that the block will not render if parent isn't required

* Add more details about `seExtensionData`

* Add additional code examples for the backend

* Avoid extending store API inside an IntegrationInterface

* Add code example that invokes the extend store endpoint class

---------

Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com>
2023-12-01 15:16:46 +01:00
..
README.md Add readme file to extend-rest-api directory and move internal doc into internal folder (https://github.com/woocommerce/woocommerce-blocks/pull/10926) 2023-09-14 05:47:35 -07:00
available-endpoints-to-extend.md Examples and use cases for ExtendSchema (https://github.com/woocommerce/woocommerce-blocks/pull/11245) 2023-10-16 13:32:26 +01:00
extend-rest-api-add-custom-fields.md Create add to custom fields documentation (https://github.com/woocommerce/woocommerce-blocks/pull/11787) 2023-12-01 15:16:46 +01:00
extend-rest-api-add-data.md Fixed newly detected broken links (https://github.com/woocommerce/woocommerce-blocks/pull/10537) 2023-08-22 11:51:18 +02:00
extend-rest-api-formatters.md Add examples and background to formatters doc (https://github.com/woocommerce/woocommerce-blocks/pull/11242) 2023-10-17 12:49:59 +01:00
extend-rest-api-update-cart.md Docs: Update examples to use window global imports (https://github.com/woocommerce/woocommerce-blocks/pull/11577) 2023-11-03 16:30:19 +00:00

README.md

Extending the Store API

Your application can change the way the Store API works by extending certain endpoints. It can add data to certain endpoints to make your server-side data available to the client-side.

You can also use the Store API trigger a server-side cart update from the client which will then update the client-side cart with the data returned by the API.

The documents listed below contain further details on how to achieve the above.

Document Description
Exposing your data in the Store API Explains how you can add additional data to Store API endpoints.
Available endpoints to extend with ExtendSchema A list of all available endpoints to extend.
Available Formatters Available Formatters to format data for use in the Store API.
Updating the cart with the Store API Update the server-side cart following an action from the front-end.