Discovery needs no key. Ratings and market analysis are Pro.
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.
openapi: 3.2.0
info:
title: YourMembership Commerce and Sales API
description: A description of the YourMembership developer API surface.
version: '1.0'
contact:
name: YourMembership (Momentive Software)
url: https://www.yourmembership.com/api/
servers:
- url: https://ws.yourmembership.com
description: YourMembership REST API (YM AMS)
- url: https://api.careerwebsite.com/v1
description: YMCareers REST API (job board / career center)
security:
- oauth2: []
tags:
- name: Commerce and Sales
description: YM Store orders, transactions, dues, and donation exports. Modeled.
paths:
/Ams/Store/Orders:
get:
tags:
- Commerce and Sales
summary: List store orders
description: Modeled from the legacy XML API store-order calls. Returns YM Store orders filterable by status (open, processed, shipped, closed, cancelled).
operationId: listOrders
parameters:
- name: status
in: query
required: false
schema:
type: string
enum:
- open
- processed
- shipped
- closed
- cancelled
responses:
'200':
description: A list of store orders.
/Ams/Store/Orders/{orderId}:
get:
tags:
- Commerce and Sales
summary: Get a store order
description: Modeled. Returns details for a single store order.
operationId: getOrder
parameters:
- name: orderId
in: path
required: true
schema:
type: string
responses:
'200':
description: A single store order.
/Ams/Exports/Transactions:
get:
tags:
- Commerce and Sales
summary: Export transactions and donations
description: Modeled from the legacy XML API system-admin (Sa) export calls, which expose donation and transaction exports for finance reconciliation.
operationId: exportTransactions
responses:
'200':
description: A transactions / donations export.
components:
securitySchemes:
oauth2:
type: oauth2
description: OAuth authentication for the YM REST API, established via POST /Ams/Authenticate. The YMCareers API instead uses an API_ACCESS_TOKEN (15-minute) Authorization header or a non-expiring X-API-KEY header.
flows:
clientCredentials:
tokenUrl: https://ws.yourmembership.com/Ams/Authenticate
scopes: {}