API Reference
Comprehensive documentation for integrating our 3D Configurator and AR Viewer via REST APIs. Explore our endpoints to enhance your e-commerce experience.
API Reference Articles
AR without the app
For years, AR in shopping meant downloading a brand's app first. Most people didn't. The feature existed, but almost nobody saw it.
Our AR opens in the browser. Here is how that works, and what it means for your store.
Two platforms, one button
The shopper taps the AR button on the product page. What happens next depends on their phone:
- iPhone and iPad: the product opens from Safari in Apple's built-in AR viewer (ARKit), from a USDZ file.
- Android: it opens in Chrome or another Chromium browser using WebXR, from a GLB file.
You don't prepare either file. When you publish a product, we generate both formats from the same 3D model and serve the right one to each device.
The build comes along
AR shows the product the shopper configured, not the default. If they chose the walnut top and the black legs, that's what appears on their floor.
On a computer, the AR button shows a QR code. The shopper scans it with their phone and the same build opens there, ready to place.
Keeping the scene clean
A configurator scene often holds things that help on screen but look odd in a room: a podium, a backdrop, a ground plane. Each object has a "Visible in AR" switch in the scene editor. Turn it off and the object stays in the 3D view but stays out of the room.
Scale is the other half. Models are built at real-world scale, one unit to one metre, so the product lands at its true size.
Where it stops
AR needs a phone or tablet with a camera and a reasonably recent browser. Desktop shoppers get a QR code, not AR on the screen.
It also shows what the product looks like in a space, not how it feels or how it's built. It's a sizing and style tool, and we present it that way.
Try it
AR is on every plan, with no extra setup. Our AR guide covers the scene settings in two minutes.
Show the price while they build
Configurators that shoppers actually finish share a few habits. None of them are about the 3D.
1. Show the price at every step
Each option in Amaspace carries its own price impact, and the total updates as the shopper clicks. Keep it visible. A shopper who sees the price climb as they add the brass handles is making a decision. A shopper who only sees it at the end is getting a surprise.
2. Offer fewer options than you could
You can probably make the sofa in forty fabrics. Start with the twelve that sell. A configurator with fewer, better options gets finished more often than one that tries to show everything at once. You can add the rest later without rebuilding anything.
3. Let rules do the saying no
Some combinations can't be made: the long chaise with the narrow frame, the engraving that's too long for the band. Don't explain that in a note under the options. Set a rule so the combination never appears. In the editor, a rule is a condition and an action, and duplicating rules makes a long list quick to build.
4. Pick the first view on purpose
The first frame the shopper sees is the configurator's product photo. Set the default options to your best-selling build and the camera to the angle you'd photograph it from. It sounds small. It's the frame most shoppers see before they touch anything.
5. Make the order readable
The build should reach your team as something they can make. Every Amaspace order comes back with the options the shopper chose, and on most platforms a 3D view of the build. Check that your production team can read it before launch, not after the first order.
Where it stops
A configurator is worth it for products with real options. If most of your sales are one product in one finish, spend the effort on photos instead.
Next step
Send us one product with its options and prices. We'll set it up with these five in place, and you approve it before it goes live. Plans are on Pricing.
When Shopify variants run out
Shopify's product options are built for products like T-shirts: a size, a colour, maybe a material. Up to three options per product, and a variant for each combination.
A sofa doesn't fit that shape. Fabric, leg finish, seat depth, chaise left or right, cushion fill. That's five options before anyone has asked about the pillows, and the number of combinations runs into the thousands.
What stores usually do
Most stores split the product. One listing per fabric family, or a "base" product with add-ons sold as separate items. Both work until a shopper wants to see the combination they're actually buying. Then they email.
Product option apps help with the form, but a form still asks the shopper to imagine the result.
Where the configurator takes over
With Amaspace, the options live in the configurator, not in Shopify's variant table. The shopper builds the sofa in 3D, sees each choice on the model and watches the price update.
On the Shopify side, you link the Amaspace product to one Shopify product. When a shopper finishes a build, it's saved as a variant of that product. Your catalogue stays one product, your checkout stays Shopify's, and each order shows exactly what was built.
Setting it up
- Install the Amaspace app from the Shopify App Store and connect your store.
- Create the product in Amaspace. Upload your own model, use one from our library, or request a model from our team.
- Link it to your Shopify product by pasting the product ID.
- In your theme editor, add the Product Page Customizer block to the product template.
Our Shopify guide walks through each step with screenshots.
Where it stops
A finished build reaches the cart as one item at its full price, not one line per part. That's what keeps orders clean, but if you track stock per component in Shopify, plan for it before launch.
Next step
If your products have outgrown three options, send us one of them. We'll build it as a configurator so you can see it on your own store. How the app works is on the Shopify integration page.
Trusted by top e-commerce platforms worldwide
