Storeshift API reference walkthrough

How to generate an API key, create preview runs, inspect items, save overrides, cancel runs, and receive signed webhooks.

6 min readUpdated 5/10/2026Storeshift API reference

Short answer

The Storeshift API uses bearer API keys for preview-run creation, run inspection, item overrides, sync subscription listing, and webhook subscription management.

In this guide

Generate an API key
Create preview runs first
Use item overrides for review
Verify webhook signatures

Key topics

Storeshift API referenceStoreshift API keyStoreshift webhooksStoreshift CLI

Generate an API key

Create a key in account settings and store it as STORESHIFT_API_KEY. The raw token is shown once; Storeshift stores only the hash.

Create preview runs first

API-created runs are preview-only. Full paid runs still go through Checkout so billing cannot be bypassed by automation.

Use item overrides for review

After a run succeeds, PATCH item fields to save title, body, or SEO-description overrides. The normal regeneration path emits updated CSV output.

Verify webhook signatures

Outbound webhooks include a timestamp and HMAC signature. Verify the signature over timestamp plus raw body before trusting the payload.

Topic hub

This guide belongs to the developer hub.

Visit the hub page

Sources

Storeshift OpenAPI spec

FAQ

Can the API create paid full runs?

Not yet. Full paid runs require Checkout approval in the app.

Where is the OpenAPI spec?

The public contract is served at /api/v1/openapi.json and stored in the repo beside the API implementation.

Can I use a CLI?

Yes. The CLI package wraps the public API for preview runs, listing runs, exporting items, and cancelling runs.

Product

Platform

Proof

Resources