Agent skill

WooCommerce Store API Routes

by woocommerce in woocommerce/woocommerce

Guidelines for adding or changing routes in the WooCommerce Store API under /wc/store/v1, covering authentication, REST design, schemas and variations.

Custom licenceAuto-check passedBackend & APIs

Install WooCommerce Store API Routes

skills CLI
$ npx skills add woocommerce/woocommerce --skill woocommerce-store-api -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install woocommerce/woocommerce woocommerce-store-api --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/woocommerce/woocommerce.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.ai/skills/woocommerce-store-api .claude/skills/woocommerce-store-api && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
woocommerce-store-api
GitHub stars
11k
Token cost
~932 tokens
SKILL.md length
336 words
Files
6
Skills in repo
11
Repo updated
First seen
Licence
Custom licence

At a glance

Guidelines for adding or changing routes in the WooCommerce Store API under /wc/store/v1, covering authentication, REST design, schemas and variations.

  • Adding a new endpoint under the Store API
  • SKILL.md covers When to use this skill, Topics, Key principles and Reference files
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Changing the response schema or status codes of an existing Store API route

What it does

The Store API is the public REST surface used by the Cart, Checkout and Mini-Cart blocks and by external integrations, with conventions separate from the older admin REST API. The skill applies to adding a route, changing a response shape, status codes or argument schema, designing a schema for a new resource and wiring a block to an endpoint. It builds on two sibling skills for general PHP conventions and performance patterns.

Its key principles are that schemas are the public contract and a route must return exactly what its schema declares, that routes changing per-user state through cookies should extend `AbstractCartRoute`, which enforces nonces, while `AbstractRoute` alone suits read-only routes or those with their own authentication, that GET stays free of side effects, that the server is authoritative on variation identity instead of trusting client attribute payloads, and that dead schema fields are not shipped. Five reference files cover authentication, REST conventions, schema design, variation handling and performance.

When your agent uses it

  • Adding a new endpoint under the Store API
  • Changing the response schema or status codes of an existing Store API route
  • Choosing the right abstract route class and nonce handling for a mutating endpoint

Example prompts

  • “Add a Store API route that returns a customer's saved shipping options and define its schema.”
  • “This cart route changes state on POST, make sure it enforces nonces correctly.”
  • “Align the response of this endpoint with its declared schema and remove the unused field.”

Requirements

  • A WooCommerce checkout with the Store API source

What it can do on your machine

Read from SKILL.md and the folder at commit b41b964. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

WooCommerce Store API Routes loads about 932 tokens when it runs. Until then it costs about 87 tokens; SKILL.md has 336 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~87
When it runs · the whole SKILL.md, loaded when a task matches
~932

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 336 words (~932 tokens).

“The Store API is the public REST surface used by Woo blocks (Cart, Checkout, Mini-Cart) and external integrations. It lives under /wc/store/v1/* and has its own conventions distinct from the older /wc/v3/* admin REST API.”

— opening of SKILL.md by woocommerce, Custom licence
name
woocommerce-store-api

Read the full SKILL.md on GitHub

Files

SKILL.md and 5 other files in .ai/skills/woocommerce-store-api of woocommerce/woocommerce.

  • SKILL.md
  • authentication.md
  • performance.md
  • rest-conventions.md
  • schema-design.md
  • variation-handling.md

Open the folder on GitHubat commit b41b964

Compare with similar skills

WooCommerce Store API Routes next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

WooCommerce Store API Routes compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
WooCommerce Store API Routes this skillwoocommerce/woocommerce11k—~932Automated safety check: PassCustom licence
WordPress ProJeffallan/claude-skills12k—~1.6kAutomated safety check: PassMIT
Laravel SpecialistJeffallan/claude-skills12k1 repos~2.1kAutomated safety check: PassMIT
Cb Realtime APIBlkLeg/CircuitBreaker201—~1.7kAutomated safety check: PassMIT
API Conventionshuangjia2019/claude-code-engineering1.1k1 repos~398Automated safety check: PassNone
Discover APIrand/cc-polymath1811 repos~1.5kAutomated safety check: PassMIT

Similar skills

  • WordPress Pro

    Jeffallan/claude-skills

    Develops WordPress themes, plugins, Gutenberg blocks and WooCommerce features with nonce, escaping and capability checks, phpcs linting and caching tuned for speed.

    12k GitHub stars~1.6k tokensUpdated 4 days ago
    DevelopmentAuto-check passed
  • Laravel Specialist

    Jeffallan/claude-skills

    Builds Laravel 10+ applications with Eloquent models, Sanctum authentication, Horizon queues, API resources and Livewire components, tested with Pest or PHPUnit.

    12k GitHub starsUsed in 1 repo~2.1k tokens
    Backend & APIsAuto-check passed
  • Cb Realtime API

    BlkLeg/CircuitBreaker

    How Circuit Breaker moves data between backend and frontend — the NATS internal bus, Redis pub/sub, the WebSocket stream endpoints and their first-message JWT handshake, SSE log/event streams, and…

    201 GitHub stars~1.7k tokensUpdated 2 days ago
    Backend & APIsAuto-check passed
  • API Conventions

    huangjia2019/claude-code-engineering

    API design patterns and conventions for this project. An agent skill from huangjia2019/claude-code-engineering.

    1.1k GitHub starsUsed in 1 repo~398 tokens
    Backend & APIsAuto-check passed
  • Discover API

    rand/cc-polymath

    Automatically discover API design skills when working with REST APIs, GraphQL schemas, API authentication, OAuth, JWT, rate limiting, API versioning, error handling, or endpoint design.

    181 GitHub starsUsed in 1 repo~1.5k tokens
    Backend & APIsAuto-check passed
  • Wp REST API

    gambitph/Stackable

    A skill your agent uses when building, extending, or debugging WordPress REST API endpoints/routes: registerrestroute, WPRESTController/controller classes, schema/argument validation…

    350 GitHub starsUsed in 2 repos~1.2k tokens
    Backend & APIsAuto-check passed

More from woocommerce/woocommerce

All 11 skills in this repo
  • WooCommerce Code Review

    woocommerce/woocommerce

    Reviews WooCommerce code changes against the project's standards, flagging backend PHP architecture, naming, documentation, data integrity and testing violations.

    11k GitHub starsUsed in 3 repos~1.1k tokens
    Auto-check passed
  • WooCommerce Markdown Guidelines

    woocommerce/woocommerce

    Rules for writing and editing markdown in the WooCommerce repository, with the project's markdownlint settings for headings, lists and code blocks.

    11k GitHub starsUsed in 1 repo~1.7k tokens
    Auto-check passed
  • Sets up a local environment for the WooCommerce block email editor, with a watcher, Mailpit email capture and build and test commands for its PHP and JS packages.

    11k GitHub stars~893 tokensUpdated today
    Auto-check passed
  • WooCommerce Dev Cycle

    woocommerce/woocommerce

    Workflow for WooCommerce development: run PHP and JavaScript tests, lint and fix code style on the current branch, and follow guides for i18n and markdown.

    11k GitHub starsUsed in 3 repos~431 tokens
    Auto-check passed
  • WooCommerce Git Commit

    woocommerce/woocommerce

    Commits pending changes with short, verb-first messages that follow WooCommerce repository conventions, splitting commits only when changes are clearly unrelated.

    11k GitHub stars~1.2k tokensUpdated today
    Auto-check passed
  • WooCommerce Draft PR Creator

    woocommerce/woocommerce

    Opens a concise draft pull request for the current branch, working out change type, base branch, title and body from the commits and diff.

    11k GitHub stars~1.1k tokensUpdated today
    Auto-check passed

Categories

Questions about WooCommerce Store API Routes

What does WooCommerce Store API Routes do?

Guidelines for adding or changing routes in the WooCommerce Store API under /wc/store/v1, covering authentication, REST design, schemas and variations. The Store API is the public REST surface used by the Cart, Checkout and Mini-Cart blocks and by external integrations, with conventions separate from the older admin REST API. The skill applies to adding a route, changing a response shape, status codes or argument schema, designing a schema for a new resource and wiring a block to an endpoint.

When should I use WooCommerce Store API Routes?

WooCommerce Store API Routes fits situations like: adding a new endpoint under the Store API; changing the response schema or status codes of an existing Store API route; choosing the right abstract route class and nonce handling for a mutating endpoint.

How do I install WooCommerce Store API Routes in Claude Code?

Run `npx skills add woocommerce/woocommerce --skill woocommerce-store-api -a claude-code`. Or copy the skill folder (.ai/skills/woocommerce-store-api in woocommerce/woocommerce) into .claude/skills/woocommerce-store-api in your project. Claude Code loads it when a task matches its description.

How do I install WooCommerce Store API Routes in Codex?

Run `npx skills add woocommerce/woocommerce --skill woocommerce-store-api -a codex`. Or copy the skill folder (.ai/skills/woocommerce-store-api in woocommerce/woocommerce) into .agents/skills/woocommerce-store-api in your project. Codex loads it when a task matches its description.

Can I use WooCommerce Store API Routes in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add woocommerce/woocommerce --skill woocommerce-store-api -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/woocommerce-store-api, .gemini/skills/woocommerce-store-api, .github/skills/woocommerce-store-api and .opencode/skills/woocommerce-store-api in your project.

What does WooCommerce Store API Routes need to run?

SKILL.md names no scripts, command-line tools or credentials: WooCommerce Store API Routes is instructions for the agent only. Our summary lists: A WooCommerce checkout with the Store API source.

Does WooCommerce Store API Routes access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is WooCommerce Store API Routes safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does WooCommerce Store API Routes use?

WooCommerce Store API Routes has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does WooCommerce Store API Routes use?

About 932 tokens (SKILL.md is roughly 3.7k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to WooCommerce Store API Routes?

Skills that share tags, products or a category with WooCommerce Store API Routes: WordPress Pro (Jeffallan/claude-skills, 12k stars), Laravel Specialist (Jeffallan/claude-skills, 12k stars), Cb Realtime API (BlkLeg/CircuitBreaker, 201 stars) and API Conventions (huangjia2019/claude-code-engineering, 1.1k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains WooCommerce Store API Routes?

woocommerce (a GitHub organization) maintains it in woocommerce/woocommerce, which has 10,540 GitHub stars. The repository holds 11 skills in this directory. The repository was last updated on October 8, 2026.

Source: woocommerce/woocommerce on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.