wp-graphql-woocommerce/docs/README.md

WPGraphQL for eCommerce

WPGraphQL for eCommerce (WooGraphQL) is a free, open-source WordPress plugin that extends the WPGraphQL plugin, allowing you to access WooCommerce data through GraphQL queries and mutations.

Table of Contents

Getting Started

• Installation
• Settings
• Configuring GraphQL Client For the User Session
• Handling User Authentication

WooGraphQL

• Routing by URI
• Using Product Data
• Creating Session Provider and using Cart Mutations
• Using Cart Data
• Harmonizing with WordPress
• Using Checkout Mutation + Order Mutations
• Using Order Data
• Using Customer Data + Mutations
• Building a WooCommerce Admin App

WooGraphQL Pro

For premium WooCommerce extension support (Subscriptions, Composite Products, Bundles, Add-ons), see the WooGraphQL Pro Documentation.

Contributing

• Testing Quick-Start Guide
• Local CLI Testing
• Development with Docker
• CLI Testing with Docker

Introduction

WooGraphQL brings the power of GraphQL to WooCommerce, enabling developers to build modern, performant headless e-commerce applications. With WooGraphQL, you can:

• Query products, categories, tags, and attributes
• Manage shopping carts with session-based mutations
• Handle user authentication and customer accounts
• Process checkouts and manage orders
• Access WooCommerce settings and configurations

Whether you're building a React, Vue, or any other frontend application, WooGraphQL provides a flexible and efficient API to interact with your WooCommerce store.

Key Features

• Complete WooCommerce Integration: Access all WooCommerce data types including products, orders, customers, coupons, and more
• Session Management: Built-in support for guest and authenticated user sessions
• Cart Operations: Full cart functionality with add, remove, update, and clear operations
• Checkout Process: Complete checkout mutation with payment gateway integration
• Extensible: Hooks and filters to customize the schema and responses

Requirements

• WordPress 6.3+
• WooCommerce 9.0+
• WPGraphQL 2.0+
• PHP 8.1+

Get started by following the Installation Guide.