Eden Sales API
The Sales API from Eden — 3 operation(s) for sales.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/eden-so:eden-so-sales-api"
All apis
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.
Get an API 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 Specification
openapi: 3.2.0
info:
title: Eden store Sales 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: Sales
paths:
/store-app/v1/discount-codes:
post:
operationId: postDiscountCodes
summary: Make a discount code
description: Answers the `code` and a `checkout_url` with it filled in.
tags:
- Sales
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- product
- kind
- value
properties:
product:
minLength: 1
maxLength: 240
type: string
code:
nullable: true
anyOf:
- maxLength: 60
type: string
- type: 'null'
kind:
anyOf:
- const: percent
type: string
- const: amount
type: string
value:
exclusiveMinimum: 0
maximum: 1000000
type: number
max_uses:
nullable: true
anyOf:
- minimum: 1
maximum: 1000000
anyOf:
- format: integer
default: 0
type: string
- minimum: 1
maximum: 1000000
type: integer
- type: 'null'
expires_at:
nullable: true
anyOf:
- anyOf:
- maxLength: 64
type: string
- type: number
- type: 'null'
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/sales:
get:
operationId: getSales
summary: List sales
description: 'Every sale line from Eden checkout and your own checkout, newest first, paged. Filters: `product`, `email`, `status` (paid, refunded, free).'
tags:
- Sales
parameters:
- name: limit
in: query
required: false
schema:
anyOf:
- maxLength: 4
type: string
- type: number
- name: starting_after
in: query
required: false
schema:
maxLength: 600
type: string
- name: created_after
in: query
required: false
schema:
anyOf:
- maxLength: 64
type: string
- type: number
- name: created_before
in: query
required: false
schema:
anyOf:
- maxLength: 64
type: string
- type: number
- name: product
in: query
required: false
schema:
maxLength: 240
type: string
- name: status
in: query
required: false
schema:
maxLength: 20
type: string
- name: email
in: query
required: false
schema:
maxLength: 320
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'
post:
operationId: postSales
summary: Record a sale, renewal, cancel, end, or refund
description: 'From your own checkout. `event` is sale, renewal, cancel, end, or refund. The same `order_id` twice counts once. A turned-away sale answers 200 with `ok: false` and a `reason`.'
tags:
- Sales
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- event
- product
- email
properties:
event:
anyOf:
- const: sale
type: string
- const: renewal
type: string
- const: cancel
type: string
- const: end
type: string
- const: refund
type: string
product:
minLength: 1
maxLength: 240
type: string
email:
minLength: 3
maxLength: 320
type: string
name:
maxLength: 120
type: string
order_id:
maxLength: 200
type: string
subscription_id:
maxLength: 200
type: string
paid_until:
anyOf:
- maxLength: 64
type: string
- type: number
ends_at:
anyOf:
- maxLength: 64
type: string
- type: number
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/sales/{saleId}:
get:
operationId: getSalesSaleId
summary: Get one sale
tags:
- Sales
parameters:
- name: saleId
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'
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.