Getting Started

WPGraphQL WooCommerce (WooGraphQL) is a both WPGraphQL extension and a WooCommerce extension so both plugins are required for its use, and support manually installation and installation through composer.

Installing Manually

  1. Install and activate WPGraphQL and WooCommerce
  2. Download wp-graphql-woocommerce.zip file under the Assets section for the most stable release from the repository into your WordPress plugin directory & activate the plugin.
  3. Set the GraphQL client endpoint to the GraphQL endpoint of the WP site. Typically, this is your-store.domain/graphql.

Installing with Composer

This is the recommend way for users using unique installations like WP Bedrock or SpinupWP.

  1. Install WordPress and WooCommerce.
  2. Install WPGraphQL and WooGraphQL by running composer require wp-graphql/wp-graphql wp-graphql/wp-graphql-woocommerce
  3. Set the GraphQL client endpoint to the GraphQL endpoint of the WP site. Typically, this is your-store.domain/graphql.

What next?

  • If you are looking to develop a client-side application, take a look at the Guides. They walk through the process of developing some common components in a React /Apollo application using data provided by WooGraphQL.
  • If you wish to customize the WooGraphQL schema to fit your particular store, try the Contributing section. You can find tools/utilities for setting a development environment and testing locally and with Docker, as well as tips for extending and changing the behavior of the WooGraphQL schema.

A Quick Tip

Use WPGraphiQL to build your queries during development. WPGraphiQL comes equipped with an Explorer component for quick query building and a Schema Viewer component so individual types’ information can be searched.