spree-legacy-api-v2

Migrate legacy Spree API v2 integrations to API v3.

4|Updated Jun 9, 2026
One-click install
npx skills add https://github.com/spree/agent-skills --skill spree-legacy-api-v2
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: spree-legacy-api-v2
Source: https://github.com/spree/agent-skills/tree/main/skills/spree-legacy-api-v2
Command: npx skills add https://github.com/spree/agent-skills --skill spree-legacy-api-v2

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill helps users maintain and migrate away from the legacy Spree Platform/Storefront API v2, providing guidance and tools for coexistence with API v3.

Core Features & Use Cases

  • API v2 Maintenance: Offers guidance on maintaining existing v2 integrations.
  • Migrating to v3: Assists in understanding and executing the migration from v2 to v3.
  • Use Case: If you have a legacy Spree application relying on API v2, this Skill can help you understand the differences between v2 and v3, and how to migrate your codebase to the newer API.

Quick Start

Use the spree-legacy-api-v2 skill to get information on migrating your Spree application from API v2 to API v3.

Frequently Asked Questions about spree-legacy-api-v2

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I migrate my Spree application from API v2 to v3?

Migrating from Spree API v2 to v3 requires understanding the structural differences, authentication updates, and data handling changes between the two versions. This Skill provides guidance and scripts to map legacy v2 endpoints to v3 equivalents for a smooth codebase transition.

What are the main differences between Spree API v2 and v3?

The differences between Spree API v2 and v3 include changes to endpoint structures, authentication methods, and data payload handling. This Skill details these specific variations to help you identify breaking changes in your existing Spree integrations.

Can I maintain my existing Spree API v2 integrations while migrating to v3?

Yes, you can maintain legacy Spree API v2 integrations during migration. This Skill offers guidance on coexistence strategies, allowing your v2 integrations to function while you progressively transition codebases to the newer v3 API.

Do I need prior knowledge of Spree to use this migration guidance?

Yes, understanding the Spree platform and its API structure is required. This Skill targets users with legacy Spree applications, assuming existing familiarity with API v2 to effectively process the migration and maintenance instructions provided.

What is the best way to handle authentication changes when migrating Spree API v2?

Handling Spree API v2 authentication changes during migration involves mapping legacy v2 credentials to v3 methods. This Skill provides references on the specific authentication differences between versions to update your integration security protocols.

Why does my Spree API v2 data handling break after upgrading to v3?

Spree API v2 data handling breaks after upgrading to v3 due to modified data structures and payload formats. This Skill identifies these specific data handling variations to help you adjust your integration's request and response parsing logic.