API reference
Reseller Partner Portal API
Read reseller memberships and relationships, manage approved conversations and review external-sale records.
Choose the supported partner path
Reseller relationships, product assignments and reporting are separate from custom order fulfillment. Custom Partner API credentials, external-order submission, manual license issue, serial allocation and fulfillment webhooks require activation by SoundSync. These custom fulfillment operations are not currently enabled by default.
An approved WooCommerce connection has its own authorization, mapping and activation checks. Native affiliate and collaborator programs are separate again; the custom fulfillment setting does not switch those programs off. Historical records remain subject to their normal account permissions. Contact SoundSync before planning a custom fulfillment integration.
Sign in as the intended reseller account
These first-party /api/partner-portal calls use an account Bearer token, not a partner API key. me and invitation acceptance can be reached before membership exists. Other routes require eligible membership, and the services enforce active partner/relationship ownership for returned records and writes.
The reseller portal is separate from affiliate/collaborator program recipient routes. A program invitation does not grant reseller membership. Keep profile details, customer records, serials, key metadata, private connection links and conversations out of public logs or screenshots.
Relationship and profile decisions
Accept the private invitation as its intended signed-in recipient. Owner/admin members can submit a reseller profile for review, request a developer relationship and decide an eligible inbound request. Pending profile content does not automatically replace the approved public identity.
Read overview, directory, relationships and individual detail before taking an action. Historical order, license, campaign and statement lists remain reports; a reported external amount is not a funded managed-checkout balance or a completed payout.
Conversations and store connections have separate roles
Conversation writes allow eligible owner, admin, technical, support, accounting and marketing members. Starting a thread requires relationshipId, subject and body/message; replies use the thread ID and preserve partner ownership checks.
Store connection access is limited to active owner/admin/technical membership. Creating a connect link rotates private authorization state and can allow credential replacement; it is not a harmless read. The active relationship and connection state must allow it. Follow the WooCommerce guide before authorizing a store.
Fulfillment and webhook availability remain controlled
Manual issue and webhook creation/edit/deletion/test require the existing fulfillment availability setting and operation-specific member role. A disabled setting returns 410 PARTNER_FULFILLMENT_DISABLED; this reference does not enable it or promise general access. External partner API and WooCommerce approval are separate from developer-router retired writes.
An allowed manual issue can fulfill customer access under the external-order contract without collecting a SoundSync payment. An allowed portal webhook test queues a real outbound test; queue acceptance is not delivery, and this test is not a status-edit operation. Creating/rotating a webhook returns private signing material within webhook. Do not log it or bundle it in a plugin.
SoundSync
Use the right integration
Partner Hub Management API
Developer-side relationships and reporting.
External Partner API
API-key requests, order fields and idempotency.
WooCommerce
Store authorization, mapping and reconciliation.
Recipient programs
Affiliate and collaborator agreements and balances.
SoundSync
Requests and responses
/api/partner-portal/me
Read signed-in reseller memberships and configured API availability
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Returns
- HTTP 200: user, memberships, partner_api_enabled, portal.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Available before a membership has been accepted. No membership or partner_api_enabled:false is not permission to bypass approval. Affiliate/collaborator program routes have their own recipient checks.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"string"
]
},
"email": {
"type": "string",
"format": "email"
},
"role": {
"type": "string"
},
"is_reseller": {
"type": "boolean"
}
},
"additionalProperties": true
},
"memberships": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"partner_api_enabled": {
"type": "boolean"
},
"portal": {
"type": "string"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/invitations/accept
Accept the intended reseller invitation
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- token: string (required)
- Returns
- HTTP 200: partner_id, status.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Private token must match the signed-in intended recipient with verified email. An expired/used token returns 410. Acceptance does not guarantee owner approval, an active relationship or API credentials.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"token": {
"type": "string"
}
},
"required": [
"token"
],
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"partner_id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 409, 410, 500, 503.
Operation errors: INVITATION_EXPIRED, INVITED_EMAIL_REQUIRED, EMAIL_VERIFICATION_REQUIRED, MEMBERSHIP_CONFLICT.
/api/partner-portal/profile/{partnerId}
Submit reseller profile details for review
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- name: string (required)
- websiteUrl: string
- summary: string
- Returns
- HTTP 200: partner, status.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Reseller owner/admin membership is required. Saves a pending profile for review rather than automatically replacing approved public identity.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 2,
"maxLength": 160
},
"websiteUrl": {
"type": "string"
},
"summary": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"name"
],
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"partner": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"status": {
"const": "pending_review"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/overview
Read reseller overview and accessible relationships
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Returns
- HTTP 200: portal, memberships, pending_approval, overview, relationships.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"portal": {
"type": "string"
},
"memberships": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"pending_approval": {
"type": "boolean"
},
"overview": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/relationships
Read reseller relationships
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Returns
- HTTP 200: relationships.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"relationships": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/directory/developers
Read developers available for relationship requests
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Returns
- HTTP 200: developers.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"developers": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/requests
Request a relationship with a developer
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- developerId: integer
- developer_id: integer
- partnerId: integer
- partner_id: integer
- message: string
- note: string
- reason: string
- Returns
- HTTP 201: relationship.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Requires an active owner/admin reseller membership. developerId/developer_id is required; partnerId selects the authorized partner when needed. Reconcile an existing request instead of treating a repeated request as another approved relationship.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"developerId": {
"type": "integer",
"minimum": 1
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"partnerId": {
"type": "integer",
"minimum": 1
},
"partner_id": {
"type": "integer",
"minimum": 1
},
"message": {
"type": "string"
},
"note": {
"type": "string"
},
"reason": {
"type": "string"
}
},
"additionalProperties": true,
"anyOf": [
{
"required": [
"developerId"
]
},
{
"required": [
"developer_id"
]
}
]
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"relationship": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/relationships/{relationshipId}
Read one accessible relationship and its related records
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Returns
- HTTP 200: relationship, products, recent_orders, licenses, api_keys, conversations, statements.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"relationship": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"products": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"recent_orders": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"licenses": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"api_keys": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"conversations": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"statements": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/relationships/{relationshipId}/accept
Accept an eligible relationship request
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- reason: string
- Returns
- HTTP 200: relationship.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Requires eligible owner/admin membership, the correct request side and a supported current state.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"reason": {
"type": "string"
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"relationship": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/relationships/{relationshipId}/deny
Deny a relationship request
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- reason: string
- Returns
- HTTP 200: relationship.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Requires eligible owner/admin membership, the correct request side and a supported current state.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"reason": {
"type": "string"
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"relationship": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/products
Read reseller products
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- query relationshipId: integer
- Returns
- HTTP 200: products.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Returns only member-accessible partner records. Historical customer identity, serials, commercial terms and conversations are private. Lists do not execute a payout, authorize a download or grant product ownership.
Request, response and error reference
Query and header parameters
[
{
"name": "relationshipId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"products": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/campaigns
Read reseller campaigns
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- query relationshipId: integer
- Returns
- HTTP 200: campaigns.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Returns only member-accessible partner records. Historical customer identity, serials, commercial terms and conversations are private. Lists do not execute a payout, authorize a download or grant product ownership.
Request, response and error reference
Query and header parameters
[
{
"name": "relationshipId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"campaigns": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/api-keys
Read reseller api-keys
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- query relationshipId: integer
- Returns
- HTTP 200: api_keys.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Returns only member-accessible partner records. Historical customer identity, serials, commercial terms and conversations are private. Lists do not execute a payout, authorize a download or grant product ownership.
Request, response and error reference
Query and header parameters
[
{
"name": "relationshipId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"api_keys": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/webhooks
Read reseller webhooks
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- query relationshipId: integer
- Returns
- HTTP 200: webhooks.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Returns only member-accessible partner records. Historical customer identity, serials, commercial terms and conversations are private. Lists do not execute a payout, authorize a download or grant product ownership.
Request, response and error reference
Query and header parameters
[
{
"name": "relationshipId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"webhooks": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/orders
Read reseller orders
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- query relationshipId: integer
- query limit: integer
- Returns
- HTTP 200: orders.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Returns only member-accessible partner records. Historical customer identity, serials, commercial terms and conversations are private. Lists do not execute a payout, authorize a download or grant product ownership.
Request, response and error reference
Query and header parameters
[
{
"name": "relationshipId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/licenses
Read reseller licenses
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- query relationshipId: integer
- query limit: integer
- Returns
- HTTP 200: licenses.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Returns only member-accessible partner records. Historical customer identity, serials, commercial terms and conversations are private. Lists do not execute a payout, authorize a download or grant product ownership.
Request, response and error reference
Query and header parameters
[
{
"name": "relationshipId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"licenses": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/conversations
Read reseller conversations
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- query relationshipId: integer
- Returns
- HTTP 200: conversations.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Returns only member-accessible partner records. Historical customer identity, serials, commercial terms and conversations are private. Lists do not execute a payout, authorize a download or grant product ownership.
Request, response and error reference
Query and header parameters
[
{
"name": "relationshipId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"conversations": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/statements
Read reseller statements
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- query relationshipId: integer
- Returns
- HTTP 200: statements.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Returns only member-accessible partner records. Historical customer identity, serials, commercial terms and conversations are private. Lists do not execute a payout, authorize a download or grant product ownership.
Request, response and error reference
Query and header parameters
[
{
"name": "relationshipId",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"statements": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/conversations
Start a conversation with the related developer
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- relationshipId: integer
- relationship_id: integer
- subject: string (required)
- body: string
- message: string
- threadType: string
- linkedProductId: integer
- linkedExternalOrderId: integer
- attachments: array
- Returns
- HTTP 201: thread, message.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Eligible active owner/admin/technical/support/accounting/marketing membership is required for conversation writes. Never attach customer credentials or unnecessary personal records.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"relationshipId": {
"type": "integer",
"minimum": 1
},
"relationship_id": {
"type": "integer",
"minimum": 1
},
"subject": {
"type": "string"
},
"body": {
"type": "string"
},
"message": {
"type": "string"
},
"threadType": {
"type": "string"
},
"linkedProductId": {
"type": "integer",
"minimum": 1
},
"linkedExternalOrderId": {
"type": "integer",
"minimum": 1
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true,
"required": [
"subject"
],
"allOf": [
{
"anyOf": [
{
"required": [
"relationshipId"
]
},
{
"required": [
"relationship_id"
]
}
]
},
{
"anyOf": [
{
"required": [
"body"
]
},
{
"required": [
"message"
]
}
]
}
]
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"thread": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"message": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/conversations/{threadId}/messages
Reply to an accessible conversation
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- body: string
- message: string
- attachments: array
- Returns
- HTTP 201: message.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Uses the same conversation-write role check; a thread ID cannot expand partner access.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"body": {
"type": "string"
},
"message": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true,
"anyOf": [
{
"required": [
"body"
]
},
{
"required": [
"message"
]
}
]
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"message": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/stores
Read authorized WooCommerce store connections
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Returns
- HTTP 200: connections.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Requires active owner/admin/technical membership for the returned store connections.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"connections": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/stores/{connectionId}/connect-link
Rotate the private store authorization link
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Returns
- HTTP 200: connection.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Requires eligible store access, an active relationship and a connectable state. Rotates authorization state and may authorize credential replacement. The returned connection contains a private connect link; do not log, publish or poll it.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"connection": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/relationships/{relationshipId}/webhook-events
Read partner webhook events and delivery attempts
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- query limit: integer
- Returns
- HTTP 200: events, deliveries.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
Request, response and error reference
Query and header parameters
[
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"deliveries": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/relationships/{relationshipId}/webhooks
Manage the gated relationship webhook operation
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- url: string (required)
- events: array
- status: active | paused | disabled
- description: string
- rotateSecret: boolean
- Returns
- HTTP 201: webhook.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Requires fulfillment availability plus active owner/admin/technical membership. A disabled launch gate returns 410 PARTNER_FULFILLMENT_DISABLED before mutation. Creation requires a public HTTPS url; omitted events defaults to order.fulfilled, order.refunded, license.revoked and webhook.test. Creation or explicit rotateSecret/rotate_secret returns private signing material inside webhook, not a top-level secret. Test queues a synthetic event; accepted is not delivered and this portal test is not a status-edit operation.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"events": {
"type": "array",
"items": {
"type": "string",
"enum": [
"order.fulfilled",
"order.refunded",
"license.revoked",
"relationship.requested",
"relationship.updated",
"webhook.test"
]
}
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"disabled"
]
},
"description": {
"type": "string"
},
"rotateSecret": {
"type": "boolean"
}
},
"additionalProperties": true,
"required": [
"url"
]
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"webhook": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 410, 500, 503.
Operation errors: PARTNER_FULFILLMENT_DISABLED.
/api/partner-portal/relationships/{relationshipId}/webhooks/{webhookId}
Manage the gated relationship webhook operation
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- url: string
- events: array
- status: active | paused | disabled
- description: string
- rotateSecret: boolean
- Returns
- HTTP 200: webhook.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Requires fulfillment availability plus active owner/admin/technical membership. A disabled launch gate returns 410 PARTNER_FULFILLMENT_DISABLED before mutation. Creation requires a public HTTPS url; omitted events defaults to order.fulfilled, order.refunded, license.revoked and webhook.test. Creation or explicit rotateSecret/rotate_secret returns private signing material inside webhook, not a top-level secret. Test queues a synthetic event; accepted is not delivered and this portal test is not a status-edit operation.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"events": {
"type": "array",
"items": {
"type": "string",
"enum": [
"order.fulfilled",
"order.refunded",
"license.revoked",
"relationship.requested",
"relationship.updated",
"webhook.test"
]
}
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"disabled"
]
},
"description": {
"type": "string"
},
"rotateSecret": {
"type": "boolean"
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"webhook": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 410, 500, 503.
Operation errors: PARTNER_FULFILLMENT_DISABLED.
/api/partner-portal/relationships/{relationshipId}/webhooks/{webhookId}
Manage the gated relationship webhook operation
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Returns
- HTTP 200: deleted, id.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Requires fulfillment availability plus active owner/admin/technical membership. A disabled launch gate returns 410 PARTNER_FULFILLMENT_DISABLED before mutation. Creation requires a public HTTPS url; omitted events defaults to order.fulfilled, order.refunded, license.revoked and webhook.test. Creation or explicit rotateSecret/rotate_secret returns private signing material inside webhook, not a top-level secret. Test queues a synthetic event; accepted is not delivered and this portal test is not a status-edit operation.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"deleted": {
"type": "boolean"
},
"id": {
"type": [
"integer",
"string"
]
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 410, 500, 503.
Operation errors: PARTNER_FULFILLMENT_DISABLED.
/api/partner-portal/relationships/{relationshipId}/webhooks/{webhookId}/test
Manage the gated relationship webhook operation
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- message: string
- Returns
- HTTP 200: success, event.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Requires fulfillment availability plus active owner/admin/technical membership. A disabled launch gate returns 410 PARTNER_FULFILLMENT_DISABLED before mutation. Creation requires a public HTTPS url; omitted events defaults to order.fulfilled, order.refunded, license.revoked and webhook.test. Creation or explicit rotateSecret/rotate_secret returns private signing material inside webhook, not a top-level secret. Test queues a synthetic event; accepted is not delivered and this portal test is not a status-edit operation.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"event": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 410, 500, 503.
Operation errors: PARTNER_FULFILLMENT_DISABLED.
/api/partner-portal/relationships/{relationshipId}/manual-issue
Issue fulfillment through the gated reseller portal
- Auth
- Account Bearer session token
- Scope
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface.
- Request fields
- header Idempotency-Key: string
- environment: test | live. Omitted environment defaults to test. Availability and relationship checks still apply.
- external_order_id: string
- externalOrderId: string
- customer_email: string
- customer_name: string
- customer_country: string
- external_order_url: string
- currency: string
- payment_status: paid | refunded | partially_refunded | chargeback | cancelled | unknown
- purchased_at: string,null
- total_paid_cents: integer
- total_paid: number
- subtotal_cents: integer
- discount_total_cents: integer
- tax_total_cents: integer
- product_id: integer
- reseller_sku: string
- quantity: integer
- items: array
- idempotency_key: string
- metadata: object. Operation-specific extension data; do not put credentials or unnecessary personal information here.
- Returns
- HTTP 201: success, soundsync_order_id, external_order_id, relationship_id, source, label, financial_classification, soundsync_checkout_fee_cents, reported_total_paid_cents, currency, verification_status, fulfillment_event_created, idempotent_replay, duplicate_external_order, test_mode, would_fulfill, customer, items, manual_issue.
- Notes
- Signed-in account and eligible reseller membership; relationship and partner ownership apply. This is an account-session API, not the external partner API-key interface. Requires fulfillment availability, an active eligible relationship, manual_issue_enabled and owner/admin/technical/support membership. Disabled availability returns 410 PARTNER_FULFILLMENT_DISABLED. environment defaults to test; live must be selected explicitly. With test fulfillment disabled, a successful test result has test_mode:true, would_fulfill:true, fulfillment_event_created:false and test_validated items with null license, entitlement and claim_url: no customer access is issued. Enabled fulfillment reports the actual item access and event result. external_order_id/externalOrderId and at least one mapped product_id or reseller_sku are required; items supports multiple lines, otherwise the top-level product selection is used. A missing Idempotency-Key is derived from the relationship and external order ID; do not change the order ID to retry. manual_issue:true identifies this portal path. Serials and claim URLs are private. This does not charge a SoundSync-managed payment or absorb external processing fees.
Request, response and error reference
Query and header parameters
[
{
"name": "Idempotency-Key",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
}
]
Request (application/json)
{
"type": "object",
"properties": {
"environment": {
"type": "string",
"enum": [
"test",
"live"
],
"default": "test",
"description": "Omitted environment defaults to test. Availability and relationship checks still apply."
},
"external_order_id": {
"type": "string"
},
"externalOrderId": {
"type": "string"
},
"customer_email": {
"type": "string",
"format": "email"
},
"customer_name": {
"type": "string"
},
"customer_country": {
"type": "string"
},
"external_order_url": {
"type": "string"
},
"currency": {
"type": "string"
},
"payment_status": {
"type": "string",
"enum": [
"paid",
"refunded",
"partially_refunded",
"chargeback",
"cancelled",
"unknown"
]
},
"purchased_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"total_paid_cents": {
"type": "integer",
"minimum": 0
},
"total_paid": {
"type": "number"
},
"subtotal_cents": {
"type": "integer"
},
"discount_total_cents": {
"type": "integer"
},
"tax_total_cents": {
"type": "integer"
},
"product_id": {
"type": "integer",
"minimum": 1
},
"reseller_sku": {
"type": "string"
},
"quantity": {
"type": "integer",
"minimum": 1
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": 1
},
"reseller_sku": {
"type": "string"
},
"quantity": {
"type": "integer",
"minimum": 1
},
"unit_reported_price_cents": {
"type": "integer"
},
"line_total_cents": {
"type": "integer"
},
"external_line_item_id": {
"type": "string"
},
"external_product_id": {
"type": "string"
},
"external_variation_id": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"idempotency_key": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"soundsync_order_id": {
"type": "string"
},
"external_order_id": {
"type": "string"
},
"relationship_id": {
"type": "string"
},
"source": {
"type": "string"
},
"label": {
"type": "string"
},
"financial_classification": {
"type": "string"
},
"soundsync_checkout_fee_cents": {
"type": "integer",
"minimum": 0
},
"reported_total_paid_cents": {
"type": "integer",
"minimum": 0
},
"currency": {
"type": "string"
},
"verification_status": {
"type": "string"
},
"fulfillment_event_created": {
"type": "boolean"
},
"idempotent_replay": {
"type": "boolean"
},
"duplicate_external_order": {
"type": "boolean"
},
"test_mode": {
"type": "boolean"
},
"would_fulfill": {
"type": "boolean"
},
"customer": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"email": {
"type": "string",
"format": "email"
},
"name": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"product_id": {
"type": "integer",
"minimum": 1
},
"product_name": {
"type": "string"
},
"reseller_sku": {
"type": [
"string",
"null"
]
},
"fulfillment_status": {
"type": "string"
},
"license": {
"type": [
"object",
"null"
],
"properties": {
"serial": {
"type": "string"
},
"status": {
"type": "string"
},
"redemption_status": {
"type": "string"
}
},
"additionalProperties": true,
"description": "Private serial access when issued; null for validation-only test results."
},
"entitlement": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
}
},
"additionalProperties": true
},
"claim_url": {
"type": [
"string",
"null"
],
"description": "Private customer claim URL when issued; never log or publish it."
},
"commercial_model": {
"type": "string"
},
"wholesale_rate_cents": {
"type": "integer",
"minimum": 0
},
"commission_rate_bps": {
"type": "integer",
"minimum": 0
},
"developer_revenue_share_bps": {
"type": "integer",
"minimum": 0
},
"expected_payable_cents": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": true
}
},
"manual_issue": {
"const": true
}
},
"additionalProperties": true,
"required": [
"success",
"manual_issue",
"soundsync_order_id",
"external_order_id",
"customer",
"items",
"fulfillment_event_created"
]
}
Documented failures: 400, 401, 403, 404, 409, 410, 500, 503.
Operation errors: PARTNER_FULFILLMENT_DISABLED.
Inventory, reported sales and statements have different meanings
The partner workspace separates Overview, Licenses, Sales, Statements, Conversations and Settings. Available serial pools are inventory. Redemptions can estimate activity; they are not the same as a partner-reported sale or an actual statement.
Record a reseller statement with its period, currency, reported sales, amount due, reference and cumulative payment received. A payment record describes money received outside SoundSync; saving it does not initiate a SoundSync payout. Keep currencies separate. Private PDF, CSV or XLSX statement attachments can be up to 5 MB and remain relationship-scoped.
Custom external-order API availability and an approved WooCommerce connection are separate capabilities. A disabled custom fulfillment API does not mean an approved store connection is enabled or disabled. Test validation is not a real license issue. Disconnecting a store removes saved connection credentials and stops new fulfillment while keeping history; remove unused provider keys and webhooks separately.
SoundSync
Partner workspace, terms and connection actions
/api/partner-portal/workspace
Read scoped inventory, sales estimates and recorded statements
- Auth
- Account Bearer session token
- Scope
- Developer partners.view with all-products scope; writes additionally partners.manage. Partner views require active eligible reseller membership and the relevant relationship.
- Request fields
- query start: string
- query end: string
- query page: integer
- query kind: string
- query product_id: integer
- query pool_id: integer
- query relationship_id: integer
- Returns
- HTTP 200: can_record_statements, relationships, filters, sales, has_more, page, summary, daily, pools, products, statements, basis.
- Notes
- UTC date filters, zero-based page and 25 sales rows per page; follow has_more. Unused licenses are inventory. Redemptions are estimates, linked reported lines are counted separately, currencies are not added together and statements do not prove a SoundSync transfer.
Request, response and error reference
Query and header parameters
[
{
"name": "start",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "kind",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"all",
"estimated",
"reported"
]
}
},
{
"name": "product_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "pool_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "relationship_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
}
]
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"can_record_statements": {
"type": "boolean"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"filters": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"sales": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"has_more": {
"type": "boolean"
},
"page": {
"type": "integer",
"minimum": 0
},
"summary": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"daily": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"pools": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"statements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"relationship_id": {
"type": "integer",
"minimum": 1
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"partner_id": {
"type": "integer",
"minimum": 1
},
"period_start": {
"type": "string"
},
"period_end": {
"type": "string"
},
"currency": {
"type": "string"
},
"gross_reported_sales_cents": {
"type": "integer",
"minimum": 0
},
"expected_payable_cents": {
"type": "integer",
"minimum": 0
},
"payment_received_cents": {
"type": "integer",
"minimum": 0
},
"outstanding_balance_cents": {
"type": "integer",
"minimum": 0
},
"status": {
"type": "string"
},
"record_source": {
"type": "string"
},
"record_details": {
"type": "object",
"properties": {
"reference": {
"type": "string"
},
"notes": {
"type": "string"
},
"payment_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"document": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"bytes": {
"type": "integer",
"minimum": 0
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"basis": {
"type": "string"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/relationships/{relationshipId}/statement-records/{statementId}/document
Download the current relationship-scoped private statement document
- Auth
- Account Bearer session token
- Scope
- Developer partners.view with all-products scope; writes additionally partners.manage. Partner views require active eligible reseller membership and the relevant relationship.
- Returns
- HTTP 200: application/octet-stream.
- Notes
- Streams the current document with its actual type and Content-Disposition filename; responses are private/no-store. A missing file needs reattachment, while transient storage failure can be retried. Keep financial and personal information out of public screenshots.
Request, response and error reference
HTTP 200 response (application/pdf)
{
"type": "string",
"format": "binary"
}HTTP 200 response (text/csv)
{
"type": "string",
"format": "binary"
}HTTP 200 response (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet)
{
"type": "string",
"format": "binary"
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/relationships/{relationshipId}/terms/accept
Accept the currently reviewed relationship terms
- Auth
- Account Bearer session token
- Scope
- Signed-in eligible reseller member, relationship/store ownership and operation-specific mutation capability.
- Request fields
- accept_terms: true (required)
- terms_version: string (required)
- Returns
- HTTP 200: accepted, terms_version.
- Notes
- Owner/admin relationship mutation capability is required. Relationship must be active, terms cannot be draft and terms_version must match the current read. Acceptance does not issue a license or collect payment.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"accept_terms": {
"const": true
},
"terms_version": {
"type": "string"
}
},
"additionalProperties": true,
"required": [
"accept_terms",
"terms_version"
]
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"accepted": {
"type": "boolean"
},
"terms_version": {
"type": "string"
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/partner-portal/relationships/{relationshipId}/test-fulfillment
Validate a synthetic assigned-SKU setup order without issuing licenses
- Auth
- Account Bearer session token
- Scope
- Signed-in eligible reseller member, relationship/store ownership and operation-specific mutation capability.
- Request fields
- reseller_sku: string (required)
- Returns
- HTTP 200: success, test_mode, would_fulfill, soundsync_order_id, external_order_id, relationship_id, source, verification_status, label, reported_total_paid_cents, currency, fulfillment_event_created, customer, items.
- Notes
- Subject to the custom fulfillment availability setting and order mutation capability. Validates a synthetic order and saves setup-test metadata; it does not issue licenses. A disabled capability returns 410 PARTNER_FULFILLMENT_DISABLED. This is a write, not a read-only audit probe.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"reseller_sku": {
"type": "string"
}
},
"additionalProperties": true,
"required": [
"reseller_sku"
]
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"test_mode": {
"type": "boolean"
},
"would_fulfill": {
"type": "boolean"
},
"soundsync_order_id": {
"type": "string"
},
"external_order_id": {
"type": "string"
},
"relationship_id": {
"type": "string"
},
"source": {
"type": "string"
},
"verification_status": {
"type": "string"
},
"label": {
"type": "string"
},
"reported_total_paid_cents": {
"type": "integer",
"minimum": 0
},
"currency": {
"type": "string"
},
"fulfillment_event_created": {
"const": false
},
"customer": {
"type": "object",
"properties": {
"id": {
"type": "null"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
}
},
"additionalProperties": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 410, 500, 503.
/api/partner-portal/stores/{connectionId}/disconnect
Disconnect a permitted WooCommerce store while retaining history
- Auth
- Account Bearer session token
- Scope
- Signed-in eligible reseller member, relationship/store ownership and operation-specific mutation capability.
- Returns
- HTTP 200: connection.
- Notes
- Owner/admin/technical store capability is required. Stops new fulfillment, removes saved consumer credentials and expires old authorization links. No provider request is sent; remove unused keys/webhooks in WooCommerce separately. Reconnection needs a fresh prepared connection and mapping/activation review.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"connection": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
SoundSync
Manual issue: environment and result
| Field or outcome | Meaning |
|---|---|
| environment | Optional test or live; omitted environment defaults to test. This does not bypass the custom fulfillment activation requirement. |
| Test validation | With test fulfillment off, success includes test_mode:true, would_fulfill:true and fulfillment_event_created:false. Items have fulfillment_status:test_validated with null license, entitlement and claim_url. This is not a real customer license. |
| Enabled fulfillment | The response reports customer, items, license or entitlement details when issued, verification_status and fulfillment_event_created. manual_issue:true identifies the portal path; idempotent_replay or duplicate_external_order can identify an existing result. |
| Private access details | Serials and claim URLs are private customer access data. Do not publish them or put them into screenshots or routine logs. |
