Get a product by slug
const url = 'https://apibase.ecomweb.app/api/v1/public/stores/example/products/slug/example?id=123&external_id=tiktok_12345&include_variants=false&include_combinations=false&include_inventory=false&include_promotion=false&include_review_stats=false&include_services=false&include_attributes=false&include_tags=false&include_channels=false&include_seo_metadata=false&include_videos=false';const options = {method: 'GET', headers: {'x-storefront-api-key': '<x-storefront-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://apibase.ecomweb.app/api/v1/public/stores/example/products/slug/example?id=123&external_id=tiktok_12345&include_variants=false&include_combinations=false&include_inventory=false&include_promotion=false&include_review_stats=false&include_services=false&include_attributes=false&include_tags=false&include_channels=false&include_seo_metadata=false&include_videos=false' \ --header 'x-storefront-api-key: <x-storefront-api-key>'Returns one product by its URL slug, with its metafields. It finds active and unlisted products published to the online store; an unlisted product stays reachable at its direct URL. Related data (variants, combinations, promotions, attributes, tags, SEO metadata, review statistics, services) is added only when the matching include_* parameter is true. The body is empty when no product matches.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The product’s URL slug. URL-encoded and non-normalized Unicode slugs are accepted.
The store’s ref, as returned by GET /stores.
Query Parameters
Section titled “Query Parameters”Example
123Product ID
Example
tiktok_12345External ID for integration lookups
Example
trueInclude product variants in the response
Example
trueInclude variant combinations in the response
Example
trueInclude aggregated inventory count
Example
trueInclude promotion information in the response
Example
trueInclude store-wide product review stats in the product response
Example
trueInclude product services in the response
Example
trueInclude product attributes in the response
Example
trueInclude product tags in the response
Example
trueInclude the sales channels the product is published to: [{ code, is_listed, published_at }]
Example
trueInclude seo metadata in the response
Example
trueInclude product videos in the response
Responses
Section titled “Responses”The product, or an empty body when no product matches.
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)
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.
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
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.
The variant’s metafields that are visible to the storefront, keyed by namespace.key.
object
object
The metafield’s type, such as single_line_text_field or list.number_integer.
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.
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.
The product’s metafields that are visible to the storefront, keyed by namespace.key.
object
object
The metafield’s type, such as single_line_text_field or list.number_integer.
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.
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"}