Official agent skill

Adding API Versions

A skill your agent uses when adding a new API version to the shopify-api package, creating REST resource files for a new version, updating API version constants, or handling breaking changes like…

OfficialMITAuto-check passed

Install Adding API Versions

skills CLI

$ npx skills add Shopify/shopify-app-js --skill adding-api-versions -a claude-code

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

GitHub CLI

$ gh skill install Shopify/shopify-app-js adding-api-versions --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/Shopify/shopify-app-js.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/adding-api-versions .claude/skills/adding-api-versions && 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/

Paste into Claude Code

Install the "adding-api-versions" agent skill from https://github.com/Shopify/shopify-app-js/tree/main/.claude/skills/adding-api-versions into .claude/skills/adding-api-versions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "adding-api-versions", then confirm the skill loads.

Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

$skill-installer

$skill-installer install https://github.com/Shopify/shopify-app-js/tree/main/.claude/skills/adding-api-versions

Type this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.

skills CLI

$ npx skills add Shopify/shopify-app-js --skill adding-api-versions -a codex

Project install goes to .agents/skills/; add -g for ~/.codex/skills/.

GitHub CLI

$ gh skill install Shopify/shopify-app-js adding-api-versions --agent codex

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/Shopify/shopify-app-js.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.claude/skills/adding-api-versions .agents/skills/adding-api-versions && rm -rf skills-src

Use ~/.agents/skills/ instead of .agents/skills for a personal install.

Codex skills documentation · loads skills from .agents/skills/

Paste into Codex

Install the "adding-api-versions" agent skill from https://github.com/Shopify/shopify-app-js/tree/main/.claude/skills/adding-api-versions into .agents/skills/adding-api-versions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "adding-api-versions", then confirm the skill loads.

Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add Shopify/shopify-app-js --skill adding-api-versions -a cursor

Project install goes to .agents/skills/; add -g for ~/.cursor/skills/.

GitHub CLI

$ gh skill install Shopify/shopify-app-js adding-api-versions --agent cursor

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/Shopify/shopify-app-js.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.claude/skills/adding-api-versions .cursor/skills/adding-api-versions && rm -rf skills-src

Use ~/.cursor/skills/ instead of .cursor/skills for a personal install.

Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/

Paste into Cursor

Install the "adding-api-versions" agent skill from https://github.com/Shopify/shopify-app-js/tree/main/.claude/skills/adding-api-versions into .cursor/skills/adding-api-versions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "adding-api-versions", then confirm the skill loads.

Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

gemini skills install

$ gemini skills install https://github.com/Shopify/shopify-app-js.git --path .claude/skills/adding-api-versions

--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.

skills CLI

$ npx skills add Shopify/shopify-app-js --skill adding-api-versions -a gemini-cli

Project install goes to .agents/skills/; add -g for ~/.gemini/skills/.

GitHub CLI

$ gh skill install Shopify/shopify-app-js adding-api-versions --agent gemini-cli

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/Shopify/shopify-app-js.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.claude/skills/adding-api-versions .gemini/skills/adding-api-versions && rm -rf skills-src

Use ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.

Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/

Paste into Gemini CLI

Install the "adding-api-versions" agent skill from https://github.com/Shopify/shopify-app-js/tree/main/.claude/skills/adding-api-versions into .gemini/skills/adding-api-versions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "adding-api-versions", then confirm the skill loads.

Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

GitHub CLI

$ gh skill install Shopify/shopify-app-js adding-api-versions

Installs for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).

skills CLI

$ npx skills add Shopify/shopify-app-js --skill adding-api-versions -a github-copilot

Project install goes to .agents/skills/; add -g for ~/.copilot/skills/.

Manual copy

$ git clone --depth 1 https://github.com/Shopify/shopify-app-js.git skills-src && mkdir -p .github/skills && cp -r skills-src/.claude/skills/adding-api-versions .github/skills/adding-api-versions && rm -rf skills-src

Use ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.

GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/

Paste into GitHub Copilot

Install the "adding-api-versions" agent skill from https://github.com/Shopify/shopify-app-js/tree/main/.claude/skills/adding-api-versions into .github/skills/adding-api-versions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "adding-api-versions", then confirm the skill loads.

GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add Shopify/shopify-app-js --skill adding-api-versions -a opencode

OpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.

GitHub CLI

$ gh skill install Shopify/shopify-app-js adding-api-versions --agent opencode

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/Shopify/shopify-app-js.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.claude/skills/adding-api-versions .opencode/skills/adding-api-versions && rm -rf skills-src

Use ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.

OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/

Paste into OpenCode

Install the "adding-api-versions" agent skill from https://github.com/Shopify/shopify-app-js/tree/main/.claude/skills/adding-api-versions into .opencode/skills/adding-api-versions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "adding-api-versions", then confirm the skill loads.

OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

Facts

Skill name: adding-api-versions
GitHub stars: 543
Token cost: ~923 tokens
SKILL.md length: 262 words
Files: 1
Skills in repo: 3
Repo updated: Oct 2, 2026
First seen: Oct 7, 2026
Licence: MIT

At a glance

A skill your agent uses when adding a new API version to the shopify-api package, creating REST resource files for a new version, updating API version constants, or handling breaking changes like…

Works in 7 steps: Update API Version Constants → Create Directory Structure → Copy and Update Resource Files → …
Adding a new API version to the shopify-api package
SKILL.md covers Prerequisites, Step 1: Update API Version…, Step 2: Create Directory… and Step 3: Copy and Update…, plus 5 more sections
Calls pnpm

What it does

Adding API Versions is an agent skill from Shopify/shopify-app-js, published by the product's own GitHub organization. Use when adding a new API version to the shopify-api package, creating REST resource files for a new version, updating API version constants, or handling breaking changes like removed or modified resources between versions.

Its SKILL.md is about 920 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It works with Shopify. The licence is MIT.

When your agent uses it

Adding a new API version to the shopify-api package
Creating REST resource files for a new version
Updating API version constants
Handling breaking changes like removed

Example prompts

“/adding-api-versions”

Workflow steps

7 steps, taken from the step headings in SKILL.md.

Update API Version Constants
Create Directory Structure
Copy and Update Resource Files
Update Test Files
Update Index File
Handle Breaking Changes
Run Tests and Build

What it can do on your machine

Read from SKILL.md and the folder at commit 07cdf94. 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
Shell commands in SKILL.md call:
- pnpm
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md. Its commands use pnpm, which can reach the network depending on how they are called.
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

Adding API Versions loads about 923 tokens when it runs. Until then it costs about 61 tokens; SKILL.md has 262 words of instructions outside code blocks.

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

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

The full file from Shopify/shopify-app-js at commit 07cdf94, republished under its MIT licence (© Shopify). 262 words, ~923 tokens.

Download SKILL.mdSave it as .claude/skills/adding-api-versions/SKILL.md (or your agent's skills folder).

name: adding-api-versions
description: Use when adding a new API version to the shopify-api package, creating REST resource files for a new version, updating API version constants, or handling breaking changes like removed or modified resources between versions.

Adding a New API Version

Step-by-step process for adding a new API version to packages/apps/shopify-api. Uses 2025-07 as a reference example.

Prerequisites

Know which resources are removed or modified in the new version

Step 1: Update API Version Constants

Edit packages/apps/shopify-api/lib/types.ts:

typescript

export enum ApiVersion {
  // ... existing versions ...
  April25 = '2025-04',
  July25 = '2025-07',      // New version
  October25 = '2025-10',   // Release candidate (next version)
}

Naming convention: {Month}{YY} (e.g., April25, July25). Value format: YYYY-MM.

Also add the next quarterly version as a release candidate enum value (no REST resources needed yet).

Step 2: Create Directory Structure

bash

mkdir packages/apps/shopify-api/rest/admin/{YYYY-MM}/
mkdir packages/apps/shopify-api/rest/admin/__tests__/{YYYY-MM}/

Step 3: Copy and Update Resource Files

Copy from the most recent version:

bash

cp -r packages/apps/shopify-api/rest/admin/{PREVIOUS_VERSION}/* \
      packages/apps/shopify-api/rest/admin/{NEW_VERSION}/

cp -r packages/apps/shopify-api/rest/admin/__tests__/{PREVIOUS_VERSION}/* \
      packages/apps/shopify-api/rest/admin/__tests__/{NEW_VERSION}/

In every resource file, update the apiVersion property:

typescript

// From
public static apiVersion = ApiVersion.April25;
// To
public static apiVersion = ApiVersion.July25;

Step 4: Update Test Files

Two changes in every test file:

testConfig calls:

typescript

testConfig({apiVersion: ApiVersion.July25, restResources})

URL paths in expectations:

typescript

`https://test-shop.myshopify.com/admin/api/2025-07/...`

Step 5: Update Index File

Edit packages/apps/shopify-api/rest/admin/{NEW_VERSION}/index.ts:

Import all resources (except removed ones)
Update RestResources interface
Update restResources export

For removed resources, delete their imports and exports:

typescript

// Remove from interface and export
export interface RestResources extends ShopifyRestResources {
  // CustomerAddress: typeof CustomerAddress;  // Removed in 2025-07
}

Step 6: Handle Breaking Changes

For removed resources (e.g., CustomerAddress in 2025-07):

Delete the resource file from rest/admin/{NEW_VERSION}/
Delete the test file from rest/admin/__tests__/{NEW_VERSION}/
Remove imports/exports from index.ts

For modified resources:

Update class properties
Modify paths array if endpoints changed
Update method signatures if parameters changed
Adjust tests accordingly

Step 7: Run Tests and Build

bash

# Test the new version
pnpm test -- packages/apps/shopify-api/rest/admin/__tests__/{NEW_VERSION}

# Run all tests
pnpm test

Checklist

New enum value in ApiVersion (packages/apps/shopify-api/lib/types.ts)
Next quarterly release candidate enum value added (no REST resources needed)
Source directory created: rest/admin/{NEW_VERSION}/
Test directory created: rest/admin/__tests__/{NEW_VERSION}/
All resource files copied and apiVersion updated
All test files updated (testConfig + URL paths)
index.ts updated with correct imports/exports
Removed resources and their tests deleted
Modified resources updated
All tests pass
Package builds without errors

Files

Just SKILL.md in .claude/skills/adding-api-versions of Shopify/shopify-app-js.

Open the folder on GitHubat commit 07cdf94

Compare with similar skills

Adding API Versions 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.

Adding API Versions compared with similar skills
Skill	Stars	Used in	Tokens	Auto-check	Licence	Repo updated
Adding API Versions this skillShopify/shopify-app-js	543	—	~923	Automated safety check: Pass	MIT	5 days ago
ShopifyShopify/Shopify-AI-Toolkit	588	—	~4.2k	Automated safety check: Pass	MIT	5 days ago
E-commerce Visual Copywritingfeichanggege/ecommerce-visual-copywriting-skill	852	—	~1.3k	Automated safety check: Pass	MIT	20 days ago
Better Designmarvkr/better-design	252	—	~1.2k	Automated safety check: Pass	MIT	15 days ago
Tracking Discoverjtrackingai/analytics-tracking-automation	142	1 repos	~614	Automated safety check: Pass	Apache-2.0	5 mo ago
Liquid Theme A11ybenjaminsehl/liquid-skills	120	—	~3.2k	Automated safety check: Pass	None	2 mo ago

Similar skills

Shopify
Shopify/Shopify-AI-Toolkit
Official
Build anything on Shopify. An agent skill from Shopify/Shopify-AI-Toolkit.
588 GitHub stars~4.2k tokensUpdated 5 days ago
Backend & APIsAuto-check passed
E-commerce Visual Copywriting
feichanggege/ecommerce-visual-copywriting-skill
Turns product details, packaging, target platform and audience into an executable e-commerce image plan with copy, storyboards, image prompts and a compliance review.
852 GitHub stars~1.3k tokensUpdated 20 days ago
Writing & ContentAuto-check passed
Better Design
marvkr/better-design
Build, improve, and review production interfaces with the Better Design MCP.
252 GitHub stars~1.2k tokensUpdated 15 days ago
Frontend & DesignAuto-check passed
Tracking Discover
jtrackingai/analytics-tracking-automation
A skill your agent uses when the user wants crawl coverage, platform detection, dataLayer discovery, or a fresh artifact directory before grouping and schema work.
142 GitHub starsUsed in 1 repo~614 tokens
Marketing & SEOAuto-check passed
Liquid Theme A11y
benjaminsehl/liquid-skills
Implement WCAG 2.2 accessibility patterns in Shopify Liquid themes.
120 GitHub stars~3.2k tokensUpdated 2 mo ago
Frontend & DesignAuto-check passed
Analytics Tracking Automation
jtrackingai/analytics-tracking-automation
A skill your agent uses when you need GA4 + GTM tracking delivery from site discovery through publish, or when the right phase entry point is still unclear.
142 GitHub stars~2.8k tokensUpdated 5 mo ago
Data & AnalyticsAuto-check passed

More from Shopify/shopify-app-js

Reviewing Pull Requests
Shopify/shopify-app-js
Official
Reviews pull requests for Shopify/shopify-app-js with comprehensive analysis including semver compliance (MAJOR/MINOR/PATCH classification), single responsibility validation, pattern consistency…
543 GitHub stars~1.9k tokensUpdated 5 days ago
Auto-check passed
Investigating GitHub Issues
Shopify/shopify-app-js
Official
Read-only investigation and analysis of GitHub issues for Shopify/shopify-app-js.
543 GitHub stars~1.5k tokensUpdated 5 days ago
Auto-check: warnings

Works with

Shopify

Questions about Adding API Versions

What does Adding API Versions do?

A skill your agent uses when adding a new API version to the shopify-api package, creating REST resource files for a new version, updating API version constants, or handling breaking changes like…. Adding API Versions is an agent skill from Shopify/shopify-app-js, published by the product's own GitHub organization. Use when adding a new API version to the shopify-api package, creating REST resource files for a new version, updating API version constants, or handling breaking changes like removed or modified resources between versions.

When should I use Adding API Versions?

Adding API Versions fits situations like: adding a new API version to the shopify-api package; creating REST resource files for a new version; updating API version constants; handling breaking changes like removed.

How do I install Adding API Versions in Claude Code?

Run `npx skills add Shopify/shopify-app-js --skill adding-api-versions -a claude-code`. Or copy the skill folder (.claude/skills/adding-api-versions in Shopify/shopify-app-js) into .claude/skills/adding-api-versions in your project. Claude Code loads it when a task matches its description.

How do I install Adding API Versions in Codex?

Run `npx skills add Shopify/shopify-app-js --skill adding-api-versions -a codex`. Or copy the skill folder (.claude/skills/adding-api-versions in Shopify/shopify-app-js) into .agents/skills/adding-api-versions in your project. Codex loads it when a task matches its description.

Can I use Adding API Versions 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 Shopify/shopify-app-js --skill adding-api-versions -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/adding-api-versions, .gemini/skills/adding-api-versions, .github/skills/adding-api-versions and .opencode/skills/adding-api-versions in your project.

What does Adding API Versions need to run?

Going by SKILL.md and its folder, Adding API Versions needs the command-line tools its instructions call (pnpm).

Does Adding API Versions 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 Adding API Versions 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 Adding API Versions use?

Adding API Versions is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Adding API Versions use?

About 923 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 Adding API Versions?

Skills that share tags, products or a category with Adding API Versions: Shopify (Shopify/Shopify-AI-Toolkit, 588 stars), E-commerce Visual Copywriting (feichanggege/ecommerce-visual-copywriting-skill, 852 stars), Better Design (marvkr/better-design, 252 stars) and Tracking Discover (jtrackingai/analytics-tracking-automation, 142 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Adding API Versions?

Shopify (a GitHub organization, an official publisher) maintains it in Shopify/shopify-app-js, which has 543 GitHub stars. The repository holds 3 skills in this directory. The repository was last updated on October 2, 2026.

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

Install Adding API Versions

Facts

At a glance

What it does

When your agent uses it

Example prompts

Workflow steps

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

Adding a New API Version

Prerequisites

Step 1: Update API Version Constants

Step 2: Create Directory Structure

Step 3: Copy and Update Resource Files

Step 4: Update Test Files

Step 5: Update Index File

Step 6: Handle Breaking Changes

Step 7: Run Tests and Build

Checklist

Files

Compare with similar skills

Similar skills

More from Shopify/shopify-app-js

Related

Questions about Adding API Versions