Skip to main content
POST
AI Product Description
V2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.

Overview

Generate an HTML product description using AI. Provide the product title and optional context (product type, tags, features, image context) to get a ready-to-use description. The merchant can also configure a custom prompt that shapes the AI output to match their brand voice. Usage is subject to the shop’s AI allowance limit. If the limit is reached, you will receive a 429 response.

Use Cases

  • Auto-generate descriptions for new products instead of writing from scratch
  • Improve or rewrite existing descriptions with richer detail
  • Create consistent, on-brand copy across your catalog

Required Scope

products:write

Request Body

string
required
The product title. This is the primary input the AI uses to generate the description.
string
The product type or category (e.g. “T-Shirts”, “Electronics”). Helps the AI tailor the description.
string[]
An array of product tags (e.g. ["organic", "cotton", "summer"]). Provides additional context for the AI.
string[]
An array of key product features (e.g. ["100% organic cotton", "Pre-shrunk", "Machine washable"]). These are highlighted in the generated description.
string
A text description of the product’s main image. Useful when the AI cannot see the image directly.
string
A custom instruction from the merchant that shapes the AI output (e.g. “Write in a casual, friendly tone” or “Always mention our 30-day return policy”). This is configured at the shop level and passed through automatically by the portal.

Response

200
429

Example

More Examples

With features and merchant prompt