Build with
SPREEAI.

Shopify App

Use the managed app when the store runs on Shopify and does not need a custom backend. The current onboarding flow connects the store after agreements and subscription; it does not require copying API keys into the setup screen.

1. Install the official SPREEAI app and complete the managed consent flow.
2. Sync an initial catalogue group and review product readiness states.
3. Customize placement and styling in a duplicated theme.
4. Validate eligible products, variants, mobile behavior and add-to-cart.
5. Publish only after brand and QA approval.

Open the official Shopify onboarding guide →

Web SDK quickstart

Use @spreeai/web-sdk for custom placement, styling, events, sizing and cart behavior.

npm install @spreeai/web-sdk

import { init } from "@spreeai/web-sdk";

const sdk = await init({
  clientId: "your-client-id",
  partnerId: "your-partner-id"
});

sdk.renderTryOnButton({
  selector: "#spreeai-try-on",
  productId: product.id,
  enableAddToCart: true
});

Initialize once, render only for an eligible product and connect documented client callbacks to your existing analytics. Confirm the current interface in the official Web SDK API reference →

API access

Use the public Swagger reference only for server-side workflows approved during onboarding. Keep secrets on your server, separate test and production access, and scope credentials to the minimum required environment.

Direct REST endpoints, webhooks or authentication behaviors not present in the approved public reference should be treated as unavailable until Partner Engineering confirms them.

Open the approved public API reference →

Garment asset baseline

• JPEG or PNG; 2,000 × 2,000 px minimum, with approximately 4K preferred.
• One garment per image, centered with clean edges and neutral, even lighting.
• Front view required; back view recommended when that experience is enabled.
• Stable SKU, style or garment ID included in the filename and catalogue record.
• No hands, hangers, styling props, watermarks or unrelated garments blocking the item.
• Variant mapping checked before enabling the experience.

QA and launch

• Test the complete customer journey on current mobile and desktop browsers.
• Verify product and variant mapping, garment readiness and cart behavior.
• Check keyboard access, focus order, accessible names and fallback behavior.
• Measure product-page performance before and after enabling SPREEAI.
• Exercise loading, empty, unavailable, timeout and retry states.
• Confirm consent language and approved handling of customer imagery.
• Obtain engineering, commerce, QA and brand sign-off before production.

Troubleshooting

The button does not appear

Confirm SDK initialization, client and partner identifiers, the target selector, product eligibility, garment readiness and variant mapping. Then check browser console and network errors without sharing tokens.

The wrong product or variant appears

Compare the storefront product and variant IDs to the records sent to SPREEAI. Confirm that the rendered request changes when the shopper changes variants.

The experience is slow or unavailable

Test a known-ready product, verify the active environment, inspect blocked requests and compare a clean browser session. Capture a timestamp and reproducible sequence for support.

Get developer support

Email support@spreeai.com with the environment, product or garment ID, browser or device, approximate timestamp, expected behavior and reproduction steps. Do not include secrets or customer imagery.