SPREEAI for developers

Build the fitting room
into every screen.

Connect your catalogue. Shape the customer journey. Bring Always On into your storefront with the integration path that fits your team.

Developer perspectiveMrinal ShuklaHead of Engineering

Choose your path

Start where your
commerce stack lives.

Use Shopify for a managed setup, or integrate with our SDKs and APIs. Choose the features your business needs and keep your brand’s shopping journey.

Web SDK quickstart

Your first integration.

Authenticate once, then render try-on or sizing anywhere on the page. Use test credentials issued during onboarding and never put a client secret in browser code.

npm install @spreeai/web-sdk

# or
yarn add @spreeai/web-sdk

The integration model

Four systems.
One customer moment.

01Your catalogue

Product IDs, variants, imagery and merchandising context.

02SPREEAI ingestion

Garments move through processing, review and readiness states.

03SDK or API

Your storefront requests the experience for an eligible product.

04Customer action

Try on, find a size, complete the look and return to checkout.

A focused path to launch

Prepare. Connect.
Go live with confidence.

Three milestones, with a practical checklist for each.

  1. 01 · Prepare

    A clear starting point.

    Align the journey, access and catalogue.

    Preparation checklist
    • Choose one channel, catalogue group and success measure.
    • Confirm partner access, credentials and staging permissions.
    • Provide clean, SKU-aligned garment imagery.
    Product · Engineering · Catalogue
  2. 02 · Connect

    Make it feel native.

    Build in staging. Test the whole journey.

    Integration checklist
    • Render for eligible products and connect variants and cart behavior.
    • Match the experience to the brand.
    • Check mobile, desktop, accessibility, performance and failure states.
    Front-end · QA · Brand
  3. 03 · Launch

    Learn from real use.

    Enable ready products and measure.

    Launch checklist
    • Confirm product readiness and publish the staged experience.
    • Monitor adoption, completion and conversion.
    • Use results to guide the next category or journey.
    Commerce · Analytics

Asset baseline

Good input makes a better result.

  • JPEG or PNG
  • 2,000 × 2,000 px minimum
  • Front view required
  • Back view recommended
  • Neutral, even lighting
  • SKU or style ID in filename
Open the asset checklist

Build for production

The details that protect
the customer experience.

01

Security

Keep secrets server-side, use only issued environments and rotate credentials through the partner workflow.

02

Privacy

Request customer imagery with clear consent and align data handling with your approved integration plan.

03

Performance

Load the experience where it is needed, test real devices and monitor product-page regressions.

04

Accessibility

Preserve keyboard access, focus order, accessible names and a usable path when the experience is unavailable.

Developer FAQ

Questions before
the first commit.

Which integration should we choose?

Use the Shopify App for the fastest managed path, the Web SDK for custom or headless web placement, the native SDKs for app experiences, and the approved API reference for server-side workflows agreed during onboarding.

Where do credentials come from?

SPREEAI issues the partner ID and approved credentials during onboarding. The browser SDK uses a client ID and partner ID. Never embed a client secret in front-end code.

Does the Shopify App require API keys?

The current Shopify App onboarding flow connects the store after the required agreements and subscription step; the managed app does not require copying keys into the setup screen.

Why does the Try-On button not appear?

Confirm the garment has completed processing, is enabled for Try-On, maps to the active product or variant, and that the app block or SDK container is present on the product template.

Which client events are available?

The documented SDK callbacks cover Try-On button clicks and add-to-cart interactions. Connect them to your analytics layer without including customer imagery or unnecessary personal data.

Are server webhooks available?

Server-push webhooks are not part of the currently published SDK documentation. Scope any server-side event requirement with Partner Engineering before relying on it.

Where do developers get help?

Use the technical support path provided during onboarding or email support@spreeai.com. Include the environment, product ID, browser or device, timestamp and a concise reproduction path—never send secrets.

When will Amazon Partner Network support be available?

The Amazon Partner Network integration is in development. It is intentionally marked Coming Soon until the onboarding and production interface are ready for external developers.

Ready to build?

Choose the path.
We’ll help you ship it.

Book a technical discoveryBrowse all docsOpen Partner Workspace

Choose your language.