StorefrontProduct
Attributes
id string required No description.
title string required No description.
subtitle string No description.
description string Full product description
handle string required No description.
price integer required Price in cents
compareAtPrice integer Original price in cents
images array of string required No description.
inStock boolean required No description.
currency string required No description.
(one of SERIAL, SERVICE, ONE_TIME, PHYSICAL, SUBSCRIPTION, DIGITAL_DOWNLOAD, LICENSE_KEY)
message string Post-purchase message shown to customer
(one of STANDARD, PAY_WHAT_YOU_WANT, FREE)
status enum required (one of ACTIVE)
minimumPrice integer Minimum price for pay-what-you-want (cents)
maxPerCustomer integer Maximum quantity per customer
fulfillmentMode enum How the product is delivered after purchase (one of MANAGED_LICENSE, LICENSE_POOL, LICENSE_WEBHOOK, INSTANT_DOWNLOAD, REDIRECT, MANUAL)
availableFrom date-time Start of availability window (format date-time)
availableUntil date-time End of availability window (format date-time)
billingInterval enum Subscription billing interval (one of WEEKLY, MONTHLY, YEARLY)
billingAnchor integer Day of month/week for billing
trialDays integer Number of free trial days
options array of object required Product options (sorted by position)
variants array of object required Product variants (sorted by position)
categories array of CategoryRef required No description.
{ "id": "string", "title": "string", "subtitle": "string", "description": "string", "handle": "string", "price": 0, "compareAtPrice": 0, "images": [ "string" ], "inStock": true, "currency": "string", "productType": "SERIAL", "message": "string", "pricingModel": "STANDARD", "status": "ACTIVE", "minimumPrice": 0, "maxPerCustomer": 0, "fulfillmentMode": "MANAGED_LICENSE", "availableFrom": "2024-01-01T00:00:00Z", "availableUntil": "2024-01-01T00:00:00Z", "billingInterval": "WEEKLY", "billingAnchor": 0, "trialDays": 0, "options": [ { "id": "string", "name": "string", "values": [ "string" ], "position": 0 } ], "variants": [ { "id": "string", "title": "string", "slug": "string", "description": "string", "sku": "string", "options": {}, "price": 0, "compareAtPrice": 0, "images": [ "string" ], "inStock": true, "quantity": 0, "trackStock": true, "position": 0 } ], "categories": [ { "id": "string", "name": "string", "slug": "string" } ]}