API Reference
New product created
Fired when a new product is created.
WEBHOOK
product_created
{
"id": 111,
"title": "Interior Door",
"description": "<string>",
"url": "interior-door",
"hidden": true,
"images": [
"https://path-to-image.jpg",
"https://path-to-another-image.jpg"
],
"categories": [
{
"id": 1,
"name": "Doors",
"url": "doors",
"parentCategory": 0
}
],
"options": [
{
"name": "Material",
"values": [
"Wood",
"Glass"
],
"advanced": true
}
],
"variants": [
{
"options": [
"Wood",
"Single"
],
"price": 199,
"onSale": true,
"regularPrice": 123,
"salePrice": 123,
"quantity": 123,
"sku": "D-001",
"weight": 123
}
],
"subscription": {
"cycles": 123,
"period": 123
},
"file": "<string>"
}Authorizations
Pass your API key as: Authorization: Bearer <API KEY>.
Client identifier sent with requests from the documentation playground.
Body
application/json
Unique identifier.
Example:
111
The type of the product.
Available options:
physical, digital, service, membership Example:
"Interior Door"
Supports light HTML formatting.
The product URL (handle) in your store.
Example:
"interior-door"
Whether the product is hidden in your store front.
Example:
[ "https://path-to-image.jpg", "https://path-to-another-image.jpg" ]
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Subscription details for a subscription product.
Show child attributes
Show child attributes
Digital products only - URL of the digital file being sold.
Response
200
Return a 2xx status to acknowledge receipt.
Last modified on September 2, 2026
Was this page helpful?
⌘I
{
"id": 111,
"title": "Interior Door",
"description": "<string>",
"url": "interior-door",
"hidden": true,
"images": [
"https://path-to-image.jpg",
"https://path-to-another-image.jpg"
],
"categories": [
{
"id": 1,
"name": "Doors",
"url": "doors",
"parentCategory": 0
}
],
"options": [
{
"name": "Material",
"values": [
"Wood",
"Glass"
],
"advanced": true
}
],
"variants": [
{
"options": [
"Wood",
"Single"
],
"price": 199,
"onSale": true,
"regularPrice": 123,
"salePrice": 123,
"quantity": 123,
"sku": "D-001",
"weight": 123
}
],
"subscription": {
"cycles": 123,
"period": 123
},
"file": "<string>"
}