OpenParable
Skip to content
← Back to skills

Shopify Debug Bundle

Testing & Quality
shopify-debug-bundle

Shopify Debug Bundle is an Agent Skill for testing & quality published in the jeremylongshore/claude-code-plugins-plus-skills repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Collect Shopify debug evidence including API versions, scopes, rate limit state, and request logs. Use when encountering persistent issues, preparing support tickets, or collecting diagnostic information for Shopify problems. Trigger with phrases like "shopify debug", "shopify support bundle", "collect shopify logs", "shopify diagnostic".

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/jeremylongshore/claude-code-plugins-plus-skills/blob/HEAD/plugins/saas-packs/shopify-pack/skills/shopify-debug-bundle/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/shopify-debug-bundle, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Shopify Debug Bundle

Overview

Collect all diagnostic information needed for Shopify support tickets: API version compatibility, access scopes, rate limit state, recent errors, and connectivity checks.

Prerequisites

  • Shopify access token (shpat_xxx) available
  • curl and jq installed
  • Store domain known (*.myshopify.com)

Instructions

Step 1: Create and Run Debug Bundle

The debug bundle script collects shop info, access scopes, supported API versions, GraphQL and REST rate limit state, environment details (Node/npm versions, SDK version, env vars), then packages everything into a tarball with tokens automatically redacted.

See Debug Bundle Script for the complete bash script.

Set these environment variables before running:

export SHOPIFY_STORE="your-store.myshopify.com"
export SHOPIFY_ACCESS_TOKEN="shpat_xxx"
export SHOPIFY_API_VERSION="2025-04"  # Update quarterly — see shopify.dev/docs/api/usage/versioning

Output

  • shopify-debug-YYYYMMDD-HHMMSS.tar.gz containing:
    • summary.txt — shop info, scopes, API versions, rate limits, environment
    • All secrets automatically redacted

Error Handling

DiagnosticWhat It RevealsIf It Fails
Shop infoStore name, plan, timezoneToken invalid or store unreachable
Access scopesWhat your app can accessToken expired or revoked
API versionsWhich versions the store supportsNetwork issue
Rate limit stateCurrent bucket fill levelToken or network issue
SDK versionWhether SDK needs updatingPackage not installed

Examples

Sensitive Data Checklist

ALWAYS REDACT before sharing:

  • Access tokens (shpat_xxx)
  • API keys and secrets
  • Customer PII (emails, names, addresses)
  • Order details with customer data

Safe to include:

  • Store name and plan
  • API version and scopes
  • Error messages and X-Request-Id values
  • Rate limit headers
  • SDK/runtime versions

Quick One-Liner Health Check

curl -sf -H "X-Shopify-Access-Token: $SHOPIFY_ACCESS_TOKEN" \
  "https://$SHOPIFY_STORE/admin/api/2025-04/shop.json" \
  | jq '{name: .shop.name, plan: .shop.plan_name}' \
  && echo "HEALTHY" || echo "UNHEALTHY"

Resources