Products API — Quickshops Headless REST API

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 bearer token.

Get store

Retrieves the public profile of the store associated with your API key.

GET /products/store

Request

curl https://api.quickshops.app/v1/products/store \
  -H "Authorization: Bearer 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
  }
}

string

required

Unique identifier for the store.

string

required

URL-safe identifier for the store, used in storefronts and public URLs.

string

required

Display name of the store.

string

Optional description of the store.

string

URL of the store’s logo image, if one has been uploaded.

boolean

required

Whether the store is live and publicly accessible.

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 /products

Request

curl https://api.quickshops.app/v1/products \
  -H "Authorization: Bearer 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"]
    }
  ]
}

string

required

Unique identifier for the product.

string

required

Identifier of the store this product belongs to.

string

required

Display name of the product.

string

Description of the product. May be null.

number

required

Price in the smallest unit of the currency (e.g. cents for USD). Divide by 100 to get the display amount.

string

required

ISO 4217 currency code in lowercase (e.g. "usd", "eur").

string

required

Product type. One of "digital" or "subscription".

string

For subscription products, the billing frequency: "month" or "year". null for digital products.

string

URL of the product image. May be null.

boolean

required

Whether the product is active and available for purchase.

string

Optional category label for grouping products in your storefront. May be null.

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 /products/:productId

Path parameters

string

required

The unique identifier of the product to retrieve.

Request

curl https://api.quickshops.app/v1/products/prod_01j... \
  -H "Authorization: Bearer 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"]
  }
}

Get Started

Your Store

Products & Sales

Integrations

Developers

Products API — Quickshops Headless REST API

Get store

Request

Response

List products

Request

Response

Get product

Path parameters

Request

Response

​Get store

​Request

​Response

​List products

​Request

​Response

​Get product

​Path parameters

​Request

​Response

Get store

Request

Response

List products

Request

Response

Get product

Path parameters

Request

Response