skills.rest
spree
spreeOFFICIAL
Explore all skills by this author →
Website𝕏@spreecommerceGitHub

spree-api-v3

Integrate with Spree v3 REST API using key-based authentication, pagination, and filtering.

4|Updated Jun 9, 2026
Search Tags:#authentication#filtering#api integration#pagination#spree commerce
One-click install
npx skills add https://github.com/spree/agent-skills --skill spree-api-v3
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: spree-api-v3
Source: https://github.com/spree/agent-skills/tree/main/skills/spree-api-v3
Command: npx skills add https://github.com/spree/agent-skills --skill spree-api-v3

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill unit helps streamline integration with Spree's v3 REST API, simplifying authentication processes, managing pagination and filtering, and ensuring a seamless API interaction experience.

Core Features & Use Cases

  • Authentication Management: Simplify API authentication using publishable keys or secret keys with scoped authorization.
  • Pagination Handling: Manage API response pagination effectively with limit and page parameters.
  • Filtering and Sorting: Apply advanced filtering and sorting options to manipulate API data efficiently.
  • Use Case: A developer looking to integrate a custom storefront with Spree's Store API for customer-facing interactions, utilizing the X-Spree-Api-Key for public access.

Quick Start

To retrieve products from the Store API, use the spree-api-v3 skill with the following command: use spree-api-v3 products retrieve

Frequently Asked Questions about spree-api-v3

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

FAQPage Schema
How do I authenticate with the Spree v3 REST API?▼

To authenticate with the Spree v3 REST API, you use key-based authentication by passing your publishable or secret key via the `X-Spree-Api-Key` header. This provides scoped authorization for both customer-facing and admin API interactions.

How do I handle pagination when retrieving data from the Spree Store API?▼

You handle pagination in the Spree Store API by applying the `limit` and `page` query parameters to your REST requests. This manages API response pagination effectively, allowing you to control the volume of data returned per query.

Can I use advanced filtering and sorting with Spree API integration?▼

Yes, you can apply advanced filtering and sorting options to manipulate Spree API data efficiently. This is achieved by passing specific query parameters within your REST requests to narrow down and order your product or customer results.

What's the best way to integrate a custom storefront with Spree's customer-facing APIs?▼

The best way to integrate a custom storefront is by connecting to Spree's Store API using the `X-Spree-Api-Key` for public access. This allows seamless customer-facing interactions and product retrieval directly through the v3 REST API.

Do I need a secret key to retrieve products from the Spree Store API?▼

No, you do not need a secret key to retrieve products from the Store API. You can use a publishable key with the `X-Spree-Api-Key` header to gain public access for customer-facing product retrieval and interactions.

Related Skills

Explore More Software Engineering Skills→
usehiveloopusehiveloop
1

vercel

Manage Vercel projects, deployments, domains, env vars, DNS, and logs via REST API.

Official
Intermediate
henkisdabrohenkisdabro
77

shopify-liquid

Render Liquid templates with Shopify objects and filters for dynamic storefront content.

Community
Basic
christianearle01christianearle01

api-debugging

Diagnose API requests and responses to resolve HTTP errors and network failures.

Community
Basic
jacexhjacexh

api-design

Design REST and GraphQL APIs with OpenAPI specifications and pagination strategies.

Community
Intermediate