API Reference

Reseller, Affiliate, and Partner APIs

Verified external Partner API behavior, scopes, idempotency, order/license endpoints, relationship terminology, and currently documented partner webhook routes.

Start with getting started Explore API docs

SoundSync

Verified external Partner API endpoints

These routes require scoped partner API keys and per-category rate limits.

GET /api/partner/v1/products

List products assigned to the authenticated partner relationship.

Auth: Scoped partner API key.
Scope: Partner relationship and products:read scope.
Request fields: Authorization partner API key
products:read scope
Returns: products[].
Side effects: None for GET endpoints unless noted.

GET /api/partner/v1/products/:sku

Fetch one partner-visible product by SKU.

Auth: Scoped partner API key.
Scope: Public, customer-token, developer-user, or scoped partner API surface as noted.
Request fields: partner API key
products:read scope
sku path parameter
Returns: product.
Side effects: None for GET endpoints unless noted.

POST /api/partner/v1/orders

Create/fulfill an external partner order.

Auth: Scoped partner API key.
Scope: Partner relationship and orders:write scope.
Request fields: partner API key
orders:write scope
Idempotency-Key recommended
external_order_id/externalOrderId
items/customer fields
Returns: 201 order fulfillment payload, or 200 idempotent replay/duplicate external order.
Side effects: Creates external order, serial/license fulfillment, audit log, webhook event order.fulfilled, notifications, and idempotency record.

GET /api/partner/v1/orders/:externalOrderId

Look up an external partner order by partner external ID.

Auth: Scoped partner API key.
Scope: Public, customer-token, developer-user, or scoped partner API surface as noted.
Request fields: partner API key
orders:read scope
Returns: Order fulfillment payload.
Side effects: None for GET endpoints unless noted.

POST /api/partner/v1/orders/:externalOrderId/refund

Record partner refund/reversal effects for an external order.

Auth: Scoped partner API key.
Scope: Public, customer-token, developer-user, or scoped partner API surface as noted.
Request fields: partner API key
licenses:revoke scope
reason/metadata body
Returns: Refund/revocation response.
Side effects: Applies refund/revoke behavior and logs the API request.

GET /api/partner/v1/licenses/:serial

Fetch partner-visible license status.

Auth: Scoped partner API key.
Scope: Public, customer-token, developer-user, or scoped partner API surface as noted.
Request fields: partner API key
licenses:read scope
serial path parameter
Returns: license.
Side effects: None for GET endpoints unless noted.

POST /api/partner/v1/licenses/:serial/revoke

Revoke a partner-visible license/serial.

Auth: Scoped partner API key.
Scope: Public, customer-token, developer-user, or scoped partner API surface as noted.
Request fields: partner API key
licenses:revoke scope
reason/metadata body
Returns: Revocation payload.
Side effects: Revokes partner-visible license according to partner service policy.

SoundSync

Create external order

Use an Idempotency-Key so retries do not duplicate fulfillment.

curl

curl -sS -X POST "$SOUNDSYNC_API_BASE/api/partner/v1/orders" \
  -H "Authorization: Bearer $PARTNER_API_KEY" \
  -H "Idempotency-Key: demo-order-2048" \
  -H "Content-Type: application/json" \
  -d '{"external_order_id":"DEMO-2048","items":[{"sku":"nebula-keys","quantity":1}]}'

SoundSync

Terminology boundary

Current implementation terminology is intentionally documented as-is.

Term	Current verified meaning
Developer	SoundSync account that owns products and relationships.
Partner/reseller	External relationship that can receive assigned products, use scoped API keys, fulfill external orders, and receive webhooks.
Affiliate	No affiliate-named public API routes were verified in this pass; do not publish affiliate automation as complete.
Customer	Buyer/end user who receives entitlements, serials, library access, and downloads.