Introduction

The Simple Product Feeds API lets you programmatically access your shop data, feeds, and exports. It follows REST conventions and returns JSON responses.

Base URL

All API requests use the following base URL:

https://app.simpleproductfeeds.com/v1

Versioning

The API is versioned via the URL path. The current version is v1. When breaking changes are introduced, a new version will be released and the previous version will continue to work for a deprecation period.

Request format

• All requests must use HTTPS
• Request bodies (where applicable) must be JSON with Content-Type: application/json
• All responses are JSON encoded as UTF-8

Response format

Successful responses wrap data in a data key:

{
  "data": {
    "id": "shop_4kx8m",
    "object": "shop",
    "domain": "my-store.myshopify.com",
    "name": "My Store"
  }
}

Collection endpoints include pagination metadata:

{
  "data": [...],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 142,
    "total_pages": 6,
    "has_more": true
  }
}

Resource model

The API is organized around feeds as the primary resource. Here’s how the key resources relate:

• Feed — An independently configured product data output. Each shop has a primary feed and can create additional feeds for different languages or markets. Feeds own their own rules, settings, and column mappings.
• Extract — A snapshot of your product data pulled from Shopify. Extracts are shared across all feeds — one extraction provides source data for every feed.
• Run — The output of applying a feed’s transformations to an extract. Each time an extract completes, every active feed generates a new run. The latest completed run is the published feed file.

The pipeline flows: Extract (pull from Shopify) → Feed Transform (apply rules, mappings, settings) → Run (output file at feed URL).

Feed sub-resources are nested under the feed they belong to:

/v1/feeds/:feed_id/rules
/v1/feeds/:feed_id/settings
/v1/feeds/:feed_id/column_mappings
/v1/feeds/:feed_id/extra_columns
/v1/feeds/:feed_id/runs

Request IDs

Every response includes an X-Request-Id header. Include this value when contacting support about a specific request — it helps us locate your request in our logs quickly.

Quick example

# Get shop info
curl https://app.simpleproductfeeds.com/v1/shop \
  -H "Authorization: Bearer spf_live_sk_your_key_here"

# List all feeds
curl https://app.simpleproductfeeds.com/v1/feeds \
  -H "Authorization: Bearer spf_live_sk_your_key_here"