/co-cart

Provides additional REST-API endpoints for WooCommerce to enable the ability to add, view, count, update and delete items from the cart.

Primary LanguagePHPGNU General Public License v3.0GPL-3.0

CoCart

WP Plugin Page License GitHub forks WordPress.org downloads WordPress.org rating Tweet

Contributors: sebd86
Tags: woocommerce, cart, endpoint, JSON, rest, api, REST API
Requires at least: 4.4
Tested up to: 4.9.8
Requires PHP: 5.6
WC requires at least: 3.2.0
WC tested up to: 3.4.4
Stable tag: 1.0.6
License: GPL v2 or later

Provides additional REST API endpoints for WooCommerce to enable the ability to add, view, count, update and delete items from the cart.

🔔 Overview

CoCart, also written as co-cart, is a REST API for WooCommerce. Accessing the cart via the REST API was highly requested by mobile and app developers and was missing from the core of WooCommerce.

So I built it. Tada!

It allows you to use WooCommerce’s REST API to its full potential providing the option to create a full web or mobile app 📱 for your store powered by WooCommerce.

Is This Free?

Yes, it's free. But here's what you should really care about:

  • The code adheres to the WordPress Coding Standards and follows best practices and conventions.
  • The project is experimental at this time.

At this time, none of the official WooCommerce library wrappers can be used with this REST API as they all require authentication which makes it difficult to use along with the other official REST API endpoints that WooCommerce provides.

What's the Catch?

This is a non-commercial plugin. As such:

  • Development time for it is effectively being donated and is, therefore, limited.
  • Support inquiries may not be answered in a timely manner.
  • Critical issues may not be resolved promptly.

If you have a customization/integration requirement then I'd love to hear from you!

Please understand that this repository is not a place to seek help with configuration-related issues. Use it to report bugs or propose improvements.

📘 Guide

📖 Documentation

Documentation for CoCart is a working progress.

Documentation for CoCart
The official WooCommerce REST API Documentation

✅ Requirements

To use this plugin you will need:

  • PHP v5.6+ (Recommend PHP v7.0+)
  • WordPress v4.4+
  • WooCommerce v3.0.0+
  • Pretty permalinks in Settings > Permalinks so that the custom endpoints are supported. Default permalinks will not work.
  • You may access the API over either HTTP or HTTPS, but HTTPS is recommended where possible.

💽 Installation

Manual
  1. Download a .zip file with the latest version.
  2. Go to WordPress Admin > Plugins > Add New.
  3. Click Upload Plugin at the top.
  4. Choose File and select the .zip file you downloaded in Step 1.
  5. Click Install Now and Activate the plugin.
Automatic
  1. Go to WordPress Admin > Plugins > Add New.
  2. Search for CoCart
  3. Click Install Now on the plugin and Activate the plugin.

Usage

To view the cart endpoint, go to yourdomainname.xyz/wp-json/wc/v2/cart/

See documentation on how to use all endpoints.

⭐ Support

CoCart is released freely and openly. Feedback or ideas and approaches to solving limitations in CoCart is greatly appreciated.

CoCart is not supported via the WooCommerce Helpdesk. As the plugin is not sold via WooCommerce.com, the support team at WooCommerce.com is not familiar with it and may not be able to assist.

At present, I do not offer a dedicated, premium support channel for CoCart but will soon. Please understand this is a non-commercial plugin. As such:

  • Development time for it is effectively being donated and is, therefore, limited.
  • Support inquiries may not be answered in a timely manner.
  • Critical issues may not be resolved promptly.

📝 Reporting Issues

If you think you have found a bug in the plugin, a problem with the documentation, or want to see a new feature added, please open a new issue and I will do my best to help you out.

Contribute

If you or your company use CoCart or appreciate the work I’m doing in open source, please consider supporting me directly so I can continue maintaining it and keep evolving the project. It's pretty clear that software actually costs something, and even though it may be offered freely, somebody is paying the cost.

You'll be helping to ensure I can spend the time not just fixing bugs, adding features, releasing new versions, but also keeping the project afloat. Any contribution you make is a big help and is greatly appreciated.

Please also consider starring ✨ and sharing 👍 the repo! This helps the project getting known and grow with the community. 🙏

If you want to do a one-time donation, you can donate to:

If you have special requirements for a sponsorship, you can email me and we can talk.

If you would like to contribute code to this project then please follow these contribution guidelines.

Thank you for your support! 🙌

License

CoCart is released under GNU General Public License v3.0.

Credits

CoCart is developed and maintained by Sébastien Dumont.