Create a product
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/products';const options = { method: 'POST', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"name":"Premium Cotton T-Shirt","slug":"premium-cotton-t-shirt","description":"High-quality cotton t-shirt with modern fit","category_code":"apparel.clothing.tops","product_type":"Túi thơm treo tủ","images":[{"id":"550e8400-e29b-41d4-a716-446655440000","url":"https://example.com/image.jpg","design_id":"DABCdefg123","design_edit_url":"https://canva.com/design/edit/123","canva_asset_id":"asset123","alt":"Product image","caption":"Main product view","sort_order":1,"is_primary":true}],"videos":[{"id":"550e8400-e29b-41d4-a716-446655440000","url":"https://cdn.example.com/videos/product-demo.mp4","thumbnail_url":"https://cdn.example.com/thumbnails/product-demo-thumb.jpg","duration":30,"width":1280,"height":720,"status":"processing","sort_order":0}],"status":"draft","published_at":"2024-12-31T10:00:00Z","variant_mode":"simple","external_id":"tiktok_12345","product_variants":[{"seller_sku":"SHIRT-BLU-L","external_id":"tiktok_variant_12345","price":29.99,"inventory":0,"min_stock_alert":10,"track_inventory":true,"inventory_policy":"deny","cost_per_item":125000,"weight":0.5,"dimensions":{"length":25.5,"width":15.2,"height":3.1,"unit":"cm"},"status":"active","combinations":[{"option_id":1,"option_value_id":5}],"images":[{"id":"b1f0…","url":"https://cdn.ecomweb.app/stores/1/red.jpg"}],"id":10,"clear_combinations":true}],"service_ids":[1,2,3],"tags":["example"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://apibase.ecomweb.app/api/v1/stores/example/products \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "name": "Premium Cotton T-Shirt", "slug": "premium-cotton-t-shirt", "description": "High-quality cotton t-shirt with modern fit", "category_code": "apparel.clothing.tops", "product_type": "Túi thơm treo tủ", "images": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "url": "https://example.com/image.jpg", "design_id": "DABCdefg123", "design_edit_url": "https://canva.com/design/edit/123", "canva_asset_id": "asset123", "alt": "Product image", "caption": "Main product view", "sort_order": 1, "is_primary": true } ], "videos": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "url": "https://cdn.example.com/videos/product-demo.mp4", "thumbnail_url": "https://cdn.example.com/thumbnails/product-demo-thumb.jpg", "duration": 30, "width": 1280, "height": 720, "status": "processing", "sort_order": 0 } ], "status": "draft", "published_at": "2024-12-31T10:00:00Z", "variant_mode": "simple", "external_id": "tiktok_12345", "product_variants": [ { "seller_sku": "SHIRT-BLU-L", "external_id": "tiktok_variant_12345", "price": 29.99, "inventory": 0, "min_stock_alert": 10, "track_inventory": true, "inventory_policy": "deny", "cost_per_item": 125000, "weight": 0.5, "dimensions": { "length": 25.5, "width": 15.2, "height": 3.1, "unit": "cm" }, "status": "active", "combinations": [ { "option_id": 1, "option_value_id": 5 } ], "images": [ { "id": "b1f0…", "url": "https://cdn.ecomweb.app/stores/1/red.jpg" } ], "id": 10, "clear_combinations": true } ], "service_ids": [ 1, 2, 3 ], "tags": [ "example" ] }'Creates a product with at least one variant. Images are copied into the store’s media library. A product is created as a draft unless status is active. Variant cost_per_item is returned only when the key holds the read:inventory scope.
Required scopes: write:products
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Product name
Example
Premium Cotton T-ShirtProduct slug (URL-friendly identifier)
Example
premium-cotton-t-shirtProduct description
Example
High-quality cotton t-shirt with modern fitGlobal taxonomy category code. Omit or null for an uncategorized product.
Example
apparel.clothing.topsFree-text product type, used when no taxonomy category fits. Display only.
Example
Túi thơm treo tủArray of product images
object
Asset ID of the image. Omit it to have the asset looked up from url, which must then be a URL of an asset uploaded to this store.
Example
550e8400-e29b-41d4-a716-446655440000Image URL: the asset’s public_url or cdn_url
Example
https://example.com/image.jpgCanva design ID
Example
DABCdefg123Canva design edit URL
Example
https://canva.com/design/edit/123Canva asset ID
Example
asset123Image alt text
Example
Product imageImage caption
Example
Main product viewSort order for image display
Example
1Whether this is the primary image
Example
trueProduct videos (UI limit: 1 video, DB supports multiple for future). MP4/MOV/WebM, max 100MB, 1-300 seconds, max 1920x1920px
object
ID of the uploaded video asset
Example
550e8400-e29b-41d4-a716-446655440000Video URL
Example
https://cdn.example.com/videos/product-demo.mp4Thumbnail URL
Example
https://cdn.example.com/thumbnails/product-demo-thumb.jpgDuration in seconds (1-300 seconds)
Example
30Video width in pixels
Example
1280Video height in pixels
Example
720Processing status
Example
activeSort order for multiple videos (future use)
Example
0Product status
Example
activeScheduled publishing date (required when status is ‘scheduled’)
Example
2024-12-31T10:00:00ZVariant mode for the product
Example
simpleExternal ID for integration with other systems
Example
tiktok_12345Variants to create/update along with product
object
Seller SKU for this variant
Example
SHIRT-BLU-LExternal ID for integration with other systems
Example
tiktok_variant_12345Price for this variant
Example
29.99Inventory count for this variant
Example
100Minimum stock alert threshold. System will send notification when inventory falls below or equals this value. Leave empty to disable alerts.
Example
10Track stock for this variant. An untracked variant is never reserved and never blocked at checkout.
Example
trueDeny: checkout rejects an order this variant cannot cover. continue: keep selling past zero.
Example
denyWhat the store pays per unit. null clears it. Never returned to storefront callers.
Example
125000Weight of the variant
Example
0.5Dimensions of the variant
object
Length in specified unit
Example
25.5Width in specified unit
Example
15.2Height in specified unit
Example
3.1Unit of measurement
Example
cmVariant status
Example
activeCombinations for this variant
object
Variant option ID
Example
1Variant option value ID
Example
5Images for this variant, at most 10
object
Asset id
Example
b1f0…Public asset URL
Example
https://cdn.ecomweb.app/stores/1/red.jpgExisting variant ID when updating
Example
10Remove this variant’s combinations. combinations: [] is a no-op on this route; use this to clear.
Example
trueService IDs to assign to this product
Example
[ 1, 2, 3]Tag names. Unknown names are created on use; matching is by slug, so “Summer 2026” and “summer 2026” resolve to one tag.
Responses
Section titled “Responses”object
Product images, in display order.
object
Asset ID of the image. Omit it to have the asset looked up from url, which must then be a URL of an asset uploaded to this store.
Image URL: the asset’s public_url or cdn_url
Canva design ID
Canva design edit URL
Canva asset ID
Image alt text
Image caption
Sort order for image display
Whether this is the primary image
Product videos. Always empty unless videos are requested.
object
ID of the uploaded video asset
Video URL
Thumbnail URL
Duration in seconds (1-300 seconds)
Video width in pixels
Video height in pixels
Processing status
Sort order for multiple videos (future use)
Variants. Present only when include_variants is true.
object
deny rejects checkout when stock is short; continue lets stock go negative.
Package dimensions, or null.
object
Images for this variant.
object
Asset ID of the image. Omit it to have the asset looked up from url, which must then be a URL of an asset uploaded to this store.
Image URL: the asset’s public_url or cdn_url
Canva design ID
Canva design edit URL
Canva asset ID
Image alt text
Image caption
Sort order for image display
Whether this is the primary image
Attribute values that define this variant. Present only when combinations are requested.
object
The attribute (axis), or null when it no longer exists.
object
Attribute ID.
Attribute name, such as “Color”.
URL-safe identifier of the attribute, unique within the store.
How values are chosen, such as select.
How the values are ordered, such as manual.
Position of the attribute among the store’s attributes.
When the attribute was created, as an ISO 8601 timestamp.
When the attribute was last updated, as an ISO 8601 timestamp.
Code of the global taxonomy attribute this one maps to, or null for a local attribute.
The chosen value, or null when it no longer exists.
object
Attribute value ID.
ID of the attribute this value belongs to.
Stored value, such as “red”.
Value as shown to shoppers, such as “Red”.
Swatch kind: none, color or image.
Swatch content: a color code or an image URL. Empty when there is no swatch.
Position of the value within its attribute.
When the value was created, as an ISO 8601 timestamp.
When the value was last updated, as an ISO 8601 timestamp.
Code of the global taxonomy value this one maps to, or null.
Active promotions on this variant. Present only when promotions are requested on a single product.
object
Promotion ID.
Promotion name.
Promotion description.
How the promotion is applied, such as automatic or code.
Discount code, for code promotions.
Promotion type.
What the promotion targets, such as product or variant.
How the discount is computed, such as PERCENTAGE or FIXED_AMOUNT.
Discount amount or percentage.
Upper bound on the discount amount.
Fixed price the item is sold at, for fixed-price promotions.
Minimum order amount for the promotion to apply.
Minimum quantity for the promotion to apply.
When the promotion starts, as an ISO 8601 timestamp.
When the promotion ends, as an ISO 8601 timestamp.
Price after the promotion.
Price before the promotion.
Amount taken off the original price.
The promotion giving the lowest price, or null. Present only when promotions are requested on a single product.
object
Promotion ID.
Promotion name.
Promotion description.
How the promotion is applied, such as automatic or code.
Discount code, for code promotions.
Promotion type.
What the promotion targets, such as product or variant.
How the discount is computed, such as PERCENTAGE or FIXED_AMOUNT.
Discount amount or percentage.
Upper bound on the discount amount.
Fixed price the item is sold at, for fixed-price promotions.
Minimum order amount for the promotion to apply.
Minimum quantity for the promotion to apply.
When the promotion starts, as an ISO 8601 timestamp.
When the promotion ends, as an ISO 8601 timestamp.
Price after the promotion.
Price before the promotion.
Amount taken off the original price.
Variant ID.
ID of the product this variant belongs to.
Store-wide numeric SKU identifier, assigned automatically.
Merchant-assigned SKU, or null.
The variant’s ID in an external system, or null.
Selling price in the store’s currency.
Units available across all locations.
Counter that increases on every stock change.
Stock level at or below which the variant counts as low stock.
Whether stock is tracked. When false the variant never runs out.
Unit cost to the store. Present only when the key holds the read:inventory scope.
Null when no cost is recorded.
Weight, in the store’s weight unit, or null.
Whether this is the product’s default variant.
Variant status, such as active or inactive.
When the variant was created, as an ISO 8601 timestamp.
When the variant was last updated, as an ISO 8601 timestamp.
Price after the best active promotion. Present only when promotions are requested; null when none applies.
Related counts. Present only when include_counts is true.
object
Number of variants.
SEO metadata, or null when none is set. Present only when include_seo_metadata is true.
object
Page title for search engines, or null.
Page description for search engines, or null.
Attributes linked to the product, with their selected values. Present only when include_attributes is true.
object
Tags on the product. Present only when include_tags is true.
object
Tag ID.
Tag name.
URL-safe tag identifier.
When the tag was created, as an ISO 8601 timestamp.
When the tag was last updated, as an ISO 8601 timestamp.
Sales channels the product is published to. Present only when include_channels is true.
object
Channel code, such as online_store.
Whether the product is listed (visible in listings) on this channel.
When the product was published to the channel, as an ISO 8601 timestamp, or null.
Active promotions on the product. Present only when include_promotion is true on a single product.
object
Promotion ID.
Promotion name.
Promotion description.
How the promotion is applied, such as automatic or code.
Discount code, for code promotions.
Promotion type.
What the promotion targets, such as product or variant.
How the discount is computed, such as PERCENTAGE or FIXED_AMOUNT.
Discount amount or percentage.
Upper bound on the discount amount.
Fixed price the item is sold at, for fixed-price promotions.
Minimum order amount for the promotion to apply.
Minimum quantity for the promotion to apply.
When the promotion starts, as an ISO 8601 timestamp.
When the promotion ends, as an ISO 8601 timestamp.
Price after the promotion.
Price before the promotion.
Amount taken off the original price.
The promotion giving the lowest price, or null. Present only when include_promotion is true on a single product.
object
Promotion ID.
Promotion name.
Promotion description.
How the promotion is applied, such as automatic or code.
Discount code, for code promotions.
Promotion type.
What the promotion targets, such as product or variant.
How the discount is computed, such as PERCENTAGE or FIXED_AMOUNT.
Discount amount or percentage.
Upper bound on the discount amount.
Fixed price the item is sold at, for fixed-price promotions.
Minimum order amount for the promotion to apply.
Minimum quantity for the promotion to apply.
When the promotion starts, as an ISO 8601 timestamp.
When the promotion ends, as an ISO 8601 timestamp.
Price after the promotion.
Price before the promotion.
Amount taken off the original price.
Review statistics. Present only when include_review_stats is true.
object
Services attached to the product. Present only when include_services is true.
object
Product ID.
Product name.
URL slug, unique within the store.
Product description, or null.
Lifecycle status: draft, active or unlisted.
When the product was published, as an ISO 8601 timestamp, or null.
When the product was created, as an ISO 8601 timestamp.
When the product was last updated, as an ISO 8601 timestamp.
When the product was soft-deleted, as an ISO 8601 timestamp. Null for live products.
Code of the global taxonomy category, or null.
Taxonomy release the category was assigned from, or null.
Free-text product type, or null.
Whether the product is featured.
Lowest variant price.
Highest variant price.
simple for a single-variant product, variant when it has options.
The product’s ID in an external system, or null.
Total stock across all variants. Present on reads.
Lowest price after promotions, or null. Present only when include_promotion is true on a single product.
Highest price after promotions, or null. Present only when include_promotion is true on a single product.
Example
{ "images": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "url": "https://example.com/image.jpg", "design_id": "DABCdefg123", "design_edit_url": "https://canva.com/design/edit/123", "canva_asset_id": "asset123", "alt": "Product image", "caption": "Main product view", "sort_order": 1, "is_primary": true } ], "videos": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "url": "https://cdn.example.com/videos/product-demo.mp4", "thumbnail_url": "https://cdn.example.com/thumbnails/product-demo-thumb.jpg", "duration": 30, "width": 1280, "height": 720, "status": "processing", "sort_order": 0 } ], "variants": [ { "inventory_policy": "deny", "images": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "url": "https://example.com/image.jpg", "design_id": "DABCdefg123", "design_edit_url": "https://canva.com/design/edit/123", "canva_asset_id": "asset123", "alt": "Product image", "caption": "Main product view", "sort_order": 1, "is_primary": true } ] } ]}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The request conflicts with the resource’s current state.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}