Guide

Current API Operation Map

Recently added package, upload, WooCommerce, partner, marketing, promotion, tracking, customer, and installment routes.

Start with getting started Explore API docs

Use the right level of reference

This operation map supplements the detailed endpoint guides. It records current mounted methods and purposes, not complete schemas or seeded response fixtures for every route. Read the linked contract before implementing a request.

Product credentials, developer sessions, customer sessions, partner Bearer keys, and provider webhook signatures are distinct. Owner-only administration and payment-provider callbacks are not public plugin SDK methods.

SoundSync

Customer marketplace discovery

Public catalog endpoints expose customer-facing publication/discovery data, not developer account records.

Method	Path	Purpose
GET	/api/marketplace/homepage	Customer homepage content
GET	/api/marketplace/deals	Published deals
GET	/api/marketplace/new-releases	Recent published releases
GET	/api/marketplace/free	Supported free-product discovery
GET	/api/marketplace/developers	Customer developer directory
GET	/api/marketplace/collections	Published collections
GET	/api/marketplace/collections/:slug	Collection detail
GET	/api/marketplace/categories/:slug	Category discovery
GET	/api/marketplace/search	Customer product search

SoundSync

Marketplace placement assets

Authenticated developer with product access; mutations require product edit permission. Uploads follow guarded image limits and approved publishing state.

Method	Path	Purpose
GET	/api/developer/products/:productId/marketplace-assets	Asset builder overview
GET	/api/developer/products/:productId/marketplace-assets/preview	Private placement preview
GET	/api/developer/products/:productId/marketplace-assets/preview/:placementType	One private placement preview
POST	/api/developer/products/:productId/marketplace-assets/organize	Organize source assets
POST	/api/developer/products/:productId/marketplace-assets/source-assets	Upload guarded source images
PATCH	/api/developer/products/:productId/marketplace-assets/source-assets/:assetId	Update source metadata
POST	/api/developer/products/:productId/marketplace-assets/source-assets/:assetId/extraction	Request product-interface extraction
PATCH	/api/developer/products/:productId/marketplace-assets/masks/:maskId	Save mask correction
PATCH	/api/developer/products/:productId/marketplace-assets/profile	Update placement profile
GET	/api/developer/products/:productId/marketplace-assets/templates	List supported templates
POST	/api/developer/products/:productId/marketplace-assets/render-jobs	Queue a render or placement family
POST	/api/developer/products/:productId/marketplace-assets/ensure-core-set	Prepare the supported core placements
GET	/api/developer/products/:productId/marketplace-assets/render-jobs/:jobId	Inspect render progress/result
POST	/api/developer/products/:productId/marketplace-assets/generated-assets/:assetId/approval	Change approval deliberately
POST	/api/developer/products/:productId/marketplace-assets/generated-assets/:assetId/restore	Restore a generated asset
DELETE	/api/developer/products/:productId/marketplace-assets/generated-assets/:assetId	Delete the selected generated asset
POST	/api/developer/products/:productId/marketplace-assets/replacements/:placementType	Upload one custom replacement
POST	/api/developer/products/:productId/marketplace-assets/ensure/:placementType	Prepare a particular placement

SoundSync

Subscription bundle additions

Authenticated customer; ownership, provider state, and explicit billing authorization are checked by the supported service path.

Method	Path	Purpose
POST	/api/subscriptions/bundles/cancel-scheduled-change	Cancel an eligible pending plan change
POST	/api/subscriptions/bundles/billing-portal	Open the permitted provider billing portal
POST	/api/subscriptions/bundles/manual-billing-setup	Start customer-authorized billing setup for a manual grant
POST	/api/subscriptions/bundles/manual-billing-preview	Preview the proposed billing conversion
POST	/api/subscriptions/bundles/manual-billing-confirm	Confirm the supported billing setup

SoundSync

Product packages

Authenticated developer with the required product access. Never distribute the account token in the package.

Method	Path	Purpose
GET	/api/developer/products/:productId/juce-package	Inspect product package metadata
GET	/api/developer/products/:productId/juce-package/download	Download the product package
POST	/api/developer/products/:productId/juce-package/generate	Generate the product-specific package

SoundSync

Private product uploads

Authenticated developer; the service verifies product ownership/permissions. A signed upload URL is temporary, private authorization.

Method	Path	Purpose
POST	/api/products/:id/files/direct-uploads	Start a direct upload; return job and signed PUT instructions
POST	/api/products/:id/files/direct-uploads/:jobId/complete	Verify stored size and session, then attach the file
POST	/api/products/:id/files/uploads/chunk-sessions	Start a local chunk session
POST	/api/products/:id/files/uploads/chunk-sessions/:uploadId/chunks	Upload a multipart chunk
POST	/api/products/:id/files/uploads/chunk-sessions/:uploadId/complete	Complete chunk assembly
POST	/api/products/:id/files/upload-link	Prepare a permitted remote upload
GET	/api/products/:id/files/uploads/:jobId	Read job state
POST	/api/products/:id/files/uploads/:jobId/retry	Retry supported failed work
POST	/api/products/:id/files/uploads/:jobId/cancel	Cancel the upload job
GET	/api/products/:id/files/:fileId/download	Authorized developer file download

SoundSync

WooCommerce mapping review

Authenticated developer with approved relationship/product permissions. These are developer controls, not storefront calls.

Method	Path	Purpose
GET	/api/developer/partners/resellers/:relationshipId/woocommerce-stores	List related store connections
GET	/api/developer/partners/resellers/:relationshipId/woocommerce-stores/:connectionId	Inspect connection and catalog review
PUT	/api/developer/partners/resellers/:relationshipId/woocommerce-stores/:connectionId/catalog/:catalogItemId/mappings	Approve/update a product mapping
DELETE	/api/developer/partners/resellers/:relationshipId/woocommerce-stores/:connectionId/catalog/:catalogItemId/mappings	Remove a mapping
POST	/api/developer/partners/resellers/:relationshipId/woocommerce-stores/:connectionId/catalog/:catalogItemId/suggestion	Review the suggested mapping
POST	/api/developer/partners/resellers/:relationshipId/woocommerce-stores/:connectionId/confirm-exact-mappings	Confirm the supported exact-match review
POST	/api/developer/partners/resellers/:relationshipId/woocommerce-stores/:connectionId/activate	Activate the reviewed connection

SoundSync

Partner API additions

Approved partner Bearer credentials with the required scopes. Keep them server-side; use Idempotency-Key for supported external-order creation.

Method	Path	Purpose
GET	/api/partner/v1/serial-pools	Scoped pool inventory; serial_pools:read
GET	/api/partner/v1/serial-pools/:poolId	Scoped pool detail; serial_pools:read
POST	/api/partner/v1/sales	External order creation using the orders/sales contract
GET	/api/partner/v1/sales/:externalOrderId	Lookup the reported sale
POST	/api/partner/v1/sales/:externalOrderId/refund	Report the supported external refund
POST	/api/partner/v1/sales/:externalOrderId/revoke	Revoke under the approved external-access contract
GET	/api/partner/v1/deals	Scoped deal listing
GET	/api/partner/v1/deals/:dealId	Scoped deal detail

SoundSync

Marketing additions

Authenticated developer marketing permissions and product/audience scope. Sending remains subject to consent, suppression, configuration, and provider readiness.

Method	Path	Purpose
GET	/api/developer/marketing/segments	List saved audience segments
POST	/api/developer/marketing/segments	Create a segment
PATCH	/api/developer/marketing/segments/:segmentId	Edit a segment
DELETE	/api/developer/marketing/segments/:segmentId	Delete a segment
PATCH	/api/developer/marketing/contacts/bulk-suppress	Suppress selected contacts
PATCH	/api/developer/marketing/contacts/:id/suppress	Update one contact suppression
GET	/api/developer/marketing/growth-flows/:flowId/recipients	Review flow recipients
POST	/api/developer/marketing/growth-flows/:flowId/run	Run supported flow work; not a consent override
POST	/api/developer/marketing/campaigns/:campaignId/resume-send	Resume supported interrupted send processing
GET	/api/developer/marketing/campaigns/latest/report	Read the latest scoped campaign report

SoundSync

Promotion workspace

Authenticated developer promotion/product permissions. Review kind, scope, checkout backing, and action eligibility before mutation.

Method	Path	Purpose
GET	/api/developer/promotions/workspace	List workspace entries and filters
GET	/api/developer/promotions/workspace/:kind/:id	Read an entry
GET	/api/developer/promotions/workspace/:kind/:id/performance	Read activity/performance
POST	/api/developer/promotions/workspace/:kind	Create a supported kind
PATCH	/api/developer/promotions/workspace/:kind/:id	Update the entry
POST	/api/developer/promotions/workspace/:kind/:id/:action	Run a supported archive/restore or reconciliation action
POST	/api/developer/promotions/promo-codes/import/preview	Validate an import before applying it
POST	/api/developer/promotions/promo-codes/import	Apply a permitted coupon import
GET	/api/developer/promotions/promo-codes/imports/:importJobId	Inspect import results

SoundSync

Custom-domain analytics

Developer settings require the authenticated workspace, all-product scope, and settings permissions. Public storefront config is host-resolved and is not a developer report.

Method	Path	Purpose
GET	/api/developer/google-analytics	Read settings and management capability
PUT	/api/developer/google-analytics	Save supported GA4 settings
DELETE	/api/developer/google-analytics	Disconnect GA4 settings
GET	/api/storefronts/analytics	Resolve public tracking config for the requested host

SoundSync

Customer operations

Authenticated developer/customer access is checked for the relevant record. A visibility change, access removal, and refund are different actions.

Method	Path	Purpose
PATCH	/api/developer/customers/:customerId	Edit supported customer fields
POST	/api/developer/customers/:customerId/resend-verification	Resend the supported verification message
GET	/api/developer/serials/:serialId/activations	Inspect device activations
POST	/api/developer/serials/:serialId/activations/:activationId/deactivate	Deactivate the selected device
GET	/api/developer/purchases/:orderId/invoice.pdf	Read an authorized invoice
POST	/api/developer/purchases/:orderItemId/remove-access	Remove selected access under the supported policy
POST	/api/library/redeem-serial	Customer serial claim; ownership proof still applies
GET	/api/library/orders/:orderId/invoice.pdf	Customer-authorized order invoice

SoundSync

Rent-to-own test integration

Developer settings require workspace permissions; customer agreement operations require customer authentication. Production live checkout is explicitly unavailable.

Method	Path	Purpose
GET	/api/developer/rent-to-own/settings	Read developer defaults
PUT	/api/developer/rent-to-own/settings	Update defaults
GET	/api/developer/products/:productId/rent-to-own	Read product override
PUT	/api/developer/products/:productId/rent-to-own	Update product override
POST	/api/developer/products/:productId/rent-to-own/preview	Preview the configured option
GET	/api/rent-to-own/products/:productId/option	Public product option
POST	/api/rent-to-own/checkout	Authenticated test checkout; production live requests rejected
GET	/api/rent-to-own/customer/agreements	List the customer's agreements
POST	/api/rent-to-own/customer/agreements/:agreementId/cancel	Cancel a permitted customer agreement