Eden Products API
The Products API from Eden — 6 operation(s) for products.
The Products API from Eden — 6 operation(s) for products.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/eden-so:eden-so-products-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Eden store Products API
version: 1.0.0
summary: Sales, customers, products, communities, email list, and webhooks for an Eden store.
description: 'Record sales from any checkout, give and remove access, list every sale and customer, make and publish products, post in your communities, manage the store''s email list, and get events by webhook.
**Sign in:** `Authorization: Bearer `, an Eden API key from Settings → API with Full access, or Custom with Store on Edit (Store on Read can only make GET calls). A key reaches one store, picked when it''s made. Store calls need Starter or above.
**Lists** take `limit` (1 to 100), `starting_after` (the last page''s `next_cursor`), `created_after`, and `created_before`, and answer `{ ok, data, has_more, next_cursor }`.
Your workspace (Discover, scheduling, boards, notes, Custom AIs) is a separate spec: https://mcp.eden.so/v1/openapi.json'
contact:
name: Eden
url: https://eden.so/help/api/api-reference/
termsOfService: https://eden.so/terms/
servers:
- url: https://api.eden.so
description: Eden store API
security:
- apiKey: []
tags:
- name: Products
paths:
/store-app/v1/products/{productId}/cohorts:
get:
operationId: getProductsProductIdCohorts
summary: List a product's cohorts
tags:
- Products
parameters:
- name: productId
in: path
required: true
schema:
minLength: 1
maxLength: 240
type: string
responses:
'200':
description: 'Done. Most answers carry `ok: true`.'
content:
application/json:
schema:
type: object
'400':
$ref: '#/components/responses/Failure'
'401':
$ref: '#/components/responses/Failure'
'402':
$ref: '#/components/responses/Failure'
'403':
$ref: '#/components/responses/Failure'
'404':
$ref: '#/components/responses/Failure'
'409':
$ref: '#/components/responses/Failure'
'422':
$ref: '#/components/responses/Failure'
'429':
$ref: '#/components/responses/Failure'
'500':
$ref: '#/components/responses/Failure'
/store-app/v1/products:
get:
operationId: getProducts
summary: List products
description: 'With any paging field (`limit`, `starting_after`, `created_after`, `created_before`) or `status` (draft, live, off): every product, drafts included, paged. With none: the short list Zapier''s product dropdown reads.'
tags:
- Products
responses:
'200':
description: 'Done. Most answers carry `ok: true`.'
content:
application/json:
schema:
type: object
'400':
$ref: '#/components/responses/Failure'
'401':
$ref: '#/components/responses/Failure'
'402':
$ref: '#/components/responses/Failure'
'403':
$ref: '#/components/responses/Failure'
'404':
$ref: '#/components/responses/Failure'
'409':
$ref: '#/components/responses/Failure'
'422':
$ref: '#/components/responses/Failure'
'429':
$ref: '#/components/responses/Failure'
'500':
$ref: '#/components/responses/Failure'
post:
operationId: postProducts
summary: Make a product draft
description: Same rules as the store editor. Answers 201 with `product`, `can_publish`, and `publish_checklist`. 409 `product_exists` when that Custom AI already has a product. Needs an API key, not the Zapier connection.
tags:
- Products
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
custom_ai_id:
type: string
description: From GET /store-app/v1/custom-ais.
title:
type: string
minLength: 1
slug:
type: string
minLength: 1
tagline:
type:
- string
- 'null'
headline:
type:
- string
- 'null'
subheadline:
type:
- string
- 'null'
price_cents:
type: integer
minimum: 0
yearly_price_cents:
type:
- integer
- 'null'
minimum: 0
compare_at_cents:
type:
- integer
- 'null'
minimum: 0
trial_days:
type:
- integer
- 'null'
minimum: 0
first_payment_cents:
type:
- integer
- 'null'
minimum: 0
quantity_limit:
type:
- integer
- 'null'
minimum: 0
quantity_show_left:
type: boolean
quantity_waitlist:
type: boolean
waitlist_mode:
type: boolean
waitlist_opens_at:
type:
- string
- 'null'
included_credits:
type: integer
minimum: 0
accent:
type:
- string
- 'null'
hero_image_url:
type:
- string
- 'null'
video_url:
type:
- string
- 'null'
body_markdown:
type:
- string
- 'null'
creator_bio:
type:
- string
- 'null'
faq_markdown:
type:
- string
- 'null'
refund_policy:
type:
- string
- 'null'
cta_label:
type:
- string
- 'null'
sign_off:
type:
- string
- 'null'
welcome_markdown:
type:
- string
- 'null'
chat_enabled:
type: boolean
checkout_url:
type:
- string
- 'null'
landing_page_url:
type:
- string
- 'null'
billing:
type: string
enum:
- one-time
- monthly
- yearly
payment_plan:
type:
- object
- 'null'
properties:
count:
type: integer
amount_cents:
type: integer
required:
- count
- amount_cents
theme:
type: string
enum:
- light
- dark
checkout_mode:
type: string
enum:
- eden
- external
whats_included:
type:
- array
- 'null'
items:
type: string
maxItems: 12
sections:
type: object
properties:
description:
type: boolean
whats_included:
type: boolean
whats_inside:
type: boolean
what_this_is:
type: boolean
what_you_can_ask:
type: boolean
works_in_ai_apps:
type: boolean
reviews:
type: boolean
bundle_offer:
type: boolean
creator_bio:
type: boolean
faq:
type: boolean
refund_policy:
type: boolean
purchase_count:
type: boolean
hero_image_on_page:
type: boolean
order:
type: array
items:
type: string
enum:
- description
- whats_included
- whats_inside
- what_this_is
- what_you_can_ask
- works_in_ai_apps
- reviews
- bundle_offer
- creator_bio
- faq
- refund_policy
- purchase_count
- hero_image_on_page
- offer
additionalProperties: false
additionalProperties: false
required:
- custom_ai_id
responses:
'200':
description: 'Done. Most answers carry `ok: true`.'
content:
application/json:
schema:
type: object
'201':
description: Made.
content:
application/json:
schema:
type: object
'400':
$ref: '#/components/responses/Failure'
'401':
$ref: '#/components/responses/Failure'
'402':
$ref: '#/components/responses/Failure'
'403':
$ref: '#/components/responses/Failure'
'404':
$ref: '#/components/responses/Failure'
'409':
$ref: '#/components/responses/Failure'
'422':
$ref: '#/components/responses/Failure'
'429':
$ref: '#/components/responses/Failure'
'500':
$ref: '#/components/responses/Failure'
/store-app/v1/custom-ais:
get:
operationId: getCustomAis
summary: List what can become a product
description: The Custom AIs and courses this store can sell, with `product_id` once one has a product.
tags:
- Products
responses:
'200':
description: 'Done. Most answers carry `ok: true`.'
content:
application/json:
schema:
type: object
'400':
$ref: '#/components/responses/Failure'
'401':
$ref: '#/components/responses/Failure'
'402':
$ref: '#/components/responses/Failure'
'403':
$ref: '#/components/responses/Failure'
'404':
$ref: '#/components/responses/Failure'
'409':
$ref: '#/components/responses/Failure'
'422':
$ref: '#/components/responses/Failure'
'429':
$ref: '#/components/responses/Failure'
'500':
$ref: '#/components/responses/Failure'
/store-app/v1/products/{productId}:
get:
operationId: getProductsProductId
summary: Get one product
description: Every field, plus `can_publish` and `publish_checklist`.
tags:
- Products
parameters:
- name: productId
in: path
required: true
schema:
type: string
responses:
'200':
description: 'Done. Most answers carry `ok: true`.'
content:
application/json:
schema:
type: object
'400':
$ref: '#/components/responses/Failure'
'401':
$ref: '#/components/responses/Failure'
'402':
$ref: '#/components/responses/Failure'
'403':
$ref: '#/components/responses/Failure'
'404':
$ref: '#/components/responses/Failure'
'409':
$ref: '#/components/responses/Failure'
'422':
$ref: '#/components/responses/Failure'
'429':
$ref: '#/components/responses/Failure'
'500':
$ref: '#/components/responses/Failure'
patch:
operationId: patchProductsProductId
summary: Change a product
description: 'Leave a field out to keep it; send null to clear it. `waitlist_mode: true` makes the page take waitlist emails instead of selling; `false` opens sales (a paid product on Eden checkout needs Stripe then). `landing_page_url` (an https page on your own site, never an Eden link) sends everyone who opens the product''s Eden link there instead; put `direct_checkout_url` on that page''s buy button so checkout stays on Eden.'
tags:
- Products
parameters:
- name: productId
in: path
required: true
schema:
type: string
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
title:
type: string
minLength: 1
slug:
type: string
minLength: 1
tagline:
type:
- string
- 'null'
headline:
type:
- string
- 'null'
subheadline:
type:
- string
- 'null'
price_cents:
type: integer
minimum: 0
yearly_price_cents:
type:
- integer
- 'null'
minimum: 0
compare_at_cents:
type:
- integer
- 'null'
minimum: 0
trial_days:
type:
- integer
- 'null'
minimum: 0
first_payment_cents:
type:
- integer
- 'null'
minimum: 0
quantity_limit:
type:
- integer
- 'null'
minimum: 0
quantity_show_left:
type: boolean
quantity_waitlist:
type: boolean
waitlist_mode:
type: boolean
waitlist_opens_at:
type:
- string
- 'null'
included_credits:
type: integer
minimum: 0
accent:
type:
- string
- 'null'
hero_image_url:
type:
- string
- 'null'
video_url:
type:
- string
- 'null'
body_markdown:
type:
- string
- 'null'
creator_bio:
type:
- string
- 'null'
faq_markdown:
type:
- string
- 'null'
refund_policy:
type:
- string
- 'null'
cta_label:
type:
- string
- 'null'
sign_off:
type:
- string
- 'null'
welcome_markdown:
type:
- string
- 'null'
chat_enabled:
type: boolean
checkout_url:
type:
- string
- 'null'
landing_page_url:
type:
- string
- 'null'
billing:
type: string
enum:
- one-time
- monthly
- yearly
payment_plan:
type:
- object
- 'null'
properties:
count:
type: integer
amount_cents:
type: integer
required:
- count
- amount_cents
theme:
type: string
enum:
- light
- dark
checkout_mode:
type: string
enum:
- eden
- external
whats_included:
type:
- array
- 'null'
items:
type: string
maxItems: 12
sections:
type: object
properties:
description:
type: boolean
whats_included:
type: boolean
whats_inside:
type: boolean
what_this_is:
type: boolean
what_you_can_ask:
type: boolean
works_in_ai_apps:
type: boolean
reviews:
type: boolean
bundle_offer:
type: boolean
creator_bio:
type: boolean
faq:
type: boolean
refund_policy:
type: boolean
purchase_count:
type: boolean
hero_image_on_page:
type: boolean
order:
type: array
items:
type: string
enum:
- description
- whats_included
- whats_inside
- what_this_is
- what_you_can_ask
- works_in_ai_apps
- reviews
- bundle_offer
- creator_bio
- faq
- refund_policy
- purchase_count
- hero_image_on_page
- offer
additionalProperties: false
additionalProperties: false
responses:
'200':
description: 'Done. Most answers carry `ok: true`.'
content:
application/json:
schema:
type: object
'400':
$ref: '#/components/responses/Failure'
'401':
$ref: '#/components/responses/Failure'
'402':
$ref: '#/components/responses/Failure'
'403':
$ref: '#/components/responses/Failure'
'404':
$ref: '#/components/responses/Failure'
'409':
$ref: '#/components/responses/Failure'
'422':
$ref: '#/components/responses/Failure'
'429':
$ref: '#/components/responses/Failure'
'500':
$ref: '#/components/responses/Failure'
/store-app/v1/products/{productId}/publish:
post:
operationId: postProductsProductIdPublish
summary: Publish a product
description: Puts it live. A paid product needs Stripe or your own checkout link (not while `waitlist_mode` is on), and every product needs the store's support email. Buyers who already own it get the new version.
tags:
- Products
parameters:
- name: productId
in: path
required: true
schema:
type: string
responses:
'200':
description: 'Done. Most answers carry `ok: true`.'
content:
application/json:
schema:
type: object
'400':
$ref: '#/components/responses/Failure'
'401':
$ref: '#/components/responses/Failure'
'402':
$ref: '#/components/responses/Failure'
'403':
$ref: '#/components/responses/Failure'
'404':
$ref: '#/components/responses/Failure'
'409':
$ref: '#/components/responses/Failure'
'422':
$ref: '#/components/responses/Failure'
'429':
$ref: '#/components/responses/Failure'
'500':
$ref: '#/components/responses/Failure'
/store-app/v1/products/{productId}/unpublish:
post:
operationId: postProductsProductIdUnpublish
summary: Stop selling a product
description: New sales stop; buyers keep what they have.
tags:
- Products
parameters:
- name: productId
in: path
required: true
schema:
type: string
responses:
'200':
description: 'Done. Most answers carry `ok: true`.'
content:
application/json:
schema:
type: object
'400':
$ref: '#/components/responses/Failure'
'401':
$ref: '#/components/responses/Failure'
'402':
$ref: '#/components/responses/Failure'
'403':
$ref: '#/components/responses/Failure'
'404':
$ref: '#/components/responses/Failure'
'409':
$ref: '#/components/responses/Failure'
'422':
$ref: '#/components/responses/Failure'
'429':
$ref: '#/components/responses/Failure'
'500':
$ref: '#/components/responses/Failure'
components:
schemas:
Failure:
type: object
required:
- ok
- error
properties:
ok:
type: boolean
const: false
error:
type: string
description: A machine code, like `product_not_found`.
message:
type: string
responses:
Failure:
description: The call failed. `error` and `message` say why.
content:
application/json:
schema:
$ref: '#/components/schemas/Failure'
securitySchemes:
apiKey:
type: http
scheme: bearer
bearerFormat: eden_pat_…
description: An Eden API key from Settings → API, or the Zapier app's OAuth token.