Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.quickshops.app/llms.txt

Use this file to discover all available pages before exploring further.

The Products endpoints let you retrieve your store’s public profile and its active product catalog. These are typically called server-side when rendering storefront pages. All three endpoints require a valid x-api-key header, but a public key is sufficient — you do not need a secret key.

​
Get store

Retrieves the public profile of the store associated with your API key. 
GET /v1/products/store

​
Request

curl https://api.quickshops.app/v1/products/store \
  -H "x-api-key: qk_your_key_here"

​
Response

{
  "data": {
    "_id": "store_01j...",
    "slug": "my-store",
    "name": "My Store",
    "description": "The best products on the internet.",
    "logoUrl": "https://cdn.example.com/logo.png",
    "isPublished": true,
    "paymentsConfigured": true
  }
}
​
_id
string
required
Unique identifier for the store.
​
slug
string
required
URL-safe identifier for the store, used in storefronts and public URLs.
​
name
string
required
Display name of the store.
​
description
string
Optional description of the store.
​
logoUrl
string
URL of the store’s logo image, if one has been uploaded.
​
isPublished
boolean
required
Whether the store is live and publicly accessible.
​
paymentsConfigured
boolean
required
Whether Stripe payments have been connected. Checkout will fail if this is false.

​
List products

Returns all active products for the store. 
GET /v1/products

​
Request

curl https://api.quickshops.app/v1/products \
  -H "x-api-key: qk_your_key_here"

​
Response

Returns an object with a data array of product objects. 
{
  "data": [
    {
      "_id": "prod_01j...",
      "storeId": "store_01j...",
      "name": "Pro Plan",
      "description": "Access to all premium features.",
      "priceInCents": 1999,
      "currency": "usd",
      "type": "subscription",
      "billingInterval": "month",
      "imageUrl": "https://cdn.example.com/pro-plan.png",
      "isActive": true,
      "category": "plans",
      "details": ["Unlimited projects", "Priority support"]
    }
  ]
}
​
_id
string
required
Unique identifier for the product.
​
storeId
string
required
Identifier of the store this product belongs to.
​
name
string
required
Display name of the product.
​
description
string
Description of the product. May be null.
​
priceInCents
number
required
Price in the smallest unit of the currency (e.g. cents for USD). Divide by 100 to get the display amount.
​
currency
string
required
ISO 4217 currency code in lowercase (e.g. "usd", "eur").
​
type
string
required
Product type. One of "digital" or "subscription".
​
billingInterval
string
For subscription products, the billing frequency: "month" or "year". null for digital products.
​
imageUrl
string
URL of the product image. May be null.
​
isActive
boolean
required
Whether the product is active and available for purchase.
​
category
string
Optional category label for grouping products in your storefront. May be null.
​
details
string[]
Array of short feature or detail strings to display on the product listing. May be null.

​
Get product

Retrieves a single product by its ID. 
GET /v1/products/:productId

​
Path parameters

​
productId
string
required
The unique identifier of the product to retrieve.

​
Request

curl https://api.quickshops.app/v1/products/prod_01j... \
  -H "x-api-key: qk_your_key_here"

​
Response

Returns a data object containing the product. 
{
  "data": {
    "_id": "prod_01j...",
    "storeId": "store_01j...",
    "name": "Pro Plan",
    "description": "Access to all premium features.",
    "priceInCents": 1999,
    "currency": "usd",
    "type": "subscription",
    "billingInterval": "month",
    "imageUrl": "https://cdn.example.com/pro-plan.png",
    "isActive": true,
    "category": "plans",
    "details": ["Unlimited projects", "Priority support"]
  }
}