Simple Product Feeds
Menu — OpenAPI Specification

OpenAPI Specification

Machine-readable API specification in OpenAPI 3.1 format for code generation and tooling integration.

The full API specification is available in OpenAPI 3.1 format at:

GET /v1/openapi.json

This endpoint is unauthenticated — no API key is required.

Usage

Fetch the spec

curl https://app.simpleproductfeeds.com/v1/openapi.json

Import into tools

The OpenAPI spec can be imported into:

  • Postman — Import → Link → paste the URL
  • Swagger UI — Use the spec URL as the input
  • Code generators — Use OpenAPI Generator to generate client SDKs in any language

Generate a client

# Install OpenAPI Generator
npm install @openapitools/openapi-generator-cli -g

# Generate a TypeScript client
openapi-generator-cli generate \
  -i https://app.simpleproductfeeds.com/v1/openapi.json \
  -g typescript-fetch \
  -o ./spf-client

What’s included

The spec covers all API endpoints across merchant and admin scopes:

  • Authentication schemes (Bearer token)
  • All request/response schemas
  • Error response shapes (400, 401, 403, 404, 422, 429)
  • Rate limit headers
  • Pagination metadata
  • Webhook event types