API ReferenceProducts

Overview

Organize storefront products, configure purchasable variants, and manage visibility safely.

A product is the page your customer browses: its title, description, images, visibility, and checkout questions. Its variants are the options they can buy, each with its own price and delivery setup.

Create the product first, then create at least one variant before publishing it. API product writes use the same domain rules as the dashboard and require the listing ability. A product ID from another X-STORE scope returns 404.

To avoid overwriting someone else's edit, send the last updated_at you read as expected_updated_at when updating or deleting. Product deletion is soft deletion (the record is kept rather than permanently erased) and is rejected while active or past-due subscriptions depend on the product.

Open an endpoint below for its exact fields, types, and examples. Your code should ignore response fields it does not recognize so new fields do not break it.

Endpoints

For a complete workflow, see Sell a product.

On this page