2 API Critical Flows

Greg edited this page 2021-10-06 08:10:26 -06:00

Unescape Escape

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

We have identified what we consider to be our most critical user flows within the WooCommerce Core API. These flows will help us focus and prioritize our testing efforts. They will also help us consider the impact of changes and priority of issues.

These flows will continually evolve as the platform evolves with flows updated, added or re-prioritised.

Route	Flow name
Products	Can add a simple product
Products	Can view a single product
Products	Can view all products
Products	Can update a product
Products	Can delete a product
Products	Can search products
Products	Can add a variable product
Products	Can add a virtual product
Orders	Can create an order
Orders	Can update an order
Orders	Can view a single order
Orders	Can view all orders
Orders	Can delete an order
Orders	Can search orders
Orders	Can add new Order complex – multiple product types & tax classes
Refunds	Can refund an order
Coupons	Can create a coupon
Coupons	Can update a coupon
Coupons	Can delete a coupon
Coupons	Can add a coupon to order
Shipping zones	Can add shipping zones
Shipping methods	Can add shipping methods
Shipping classes	Can add shipping classes

Contribution

• Set up development environment
• Our Git Flow
• SCSS and JS minification
• Naming conventions
• CSS SASS coding guidelines and naming conventions
• Critical Flows
• API Critical Flows
• String localisation guidelines
• Translating WooCommerce
• Deprecation in core
• Adding Actions and Filters
• Common Issues
• Writing high-quality testing instructions

Release Notes

• Release Testing Instructions
• 3.6.x notes/FAQ
• 2.6.x to 3.0.0 Developer Migration Notes
• Select2 fields not working in 3.0.x
• Thumbnail Image Regeneration in 3.3+
• Customizing image sizes in 3.3+

REST API and CLI

• Getting started with the REST API
• Contributing to the REST API
• WC CLI Overview
• WC CLI Commands

CRUD & Data Descriptions

• Database Description
• CRUD Objects in 3.0
• Order and Order Line Item Data
• Coupon Data
• Customer Data
• Product Data
• Data Stores

Internal APIs

• Settings API
• Payment Token API
• Shipping Method API
• WC_Queue - WooCommerce Queue API

Theming

• Enabling product gallery features (zoom, swipe, lightbox)
• Template File Guidelines for Devs and Theme Authors

Examples / Guides

• How Taxes Work in WooCommerce
• Customising account page tabs
• End-to-end Testing
• wc_get_orders and WC_Order_Query
• wc_get_products and WC_Product_Query
• Importer and Exporter
• Testing Action Scheduler
• Core Profiler Testing Instructions

WooCommerce is an open source commerce platform built for WordPress and lovingly crafted by Automattic and the WooCommerce community 💜. Come and work with us!