Documentation

SDK 2.0 · REFERENCE

Troubleshooting

Start with the layer that failed, then collect a reproducible example.

Diagnose the symptom

SymptomCheckNext action
init returns nullIssued clientId, approved environment, authentication response.Keep the standard product journey available; inspect console / network errors without sharing tokens.
No Web SDK buttonContainer exists; garment belongs to your partner; garment and pinned variant are available.Verify the garment mapping and validation message.
Outfit opens one garmentAn available matching outfit must contain all requested garments and pinned variants.Verify the outfit; first-garment fallback is expected on no match.
Sizes show but no recommendationshowSizes and enableSizingRecommendation are separate options.Confirm sizing is requested and supported for the product / account.
Shopify block missingReady and enabled product, active feature, correct saved block and published template.Check all three controls, subscription and Billing notices.
Shopify view or shortcut missingFeature switch and corresponding block setting; Virtual Try-On dependency where applicable.Reload after changing Feature Settings.
Cart failsYour cart endpoint response, ID / variant mapping and validation.Report the error, clear loading state and leave a retry path.
New dialog layout breaks pageOld .try-on-dialog overrides and narrow-screen behavior.Re-check against the v3 layout.

Send a useful support report

  • Integration path, SDK package version and environment.
  • Affected product / garment ID and selected variant.
  • Browser, operating system and device, plus timestamp and timezone.
  • Exact reproduction steps, expected result and observed result.
  • A sanitized console / network error or correlation ID where available.

Use your onboarding support channel or support@spreeai.com. Never include client secrets, access tokens or customer imagery in a general support report.

Source references

Search page titles and content. Escape closes search.

Choose your language.