Developers

Product

Represents a product in the Ecommerce store.

List of available attributes

currency

Related (store) currency code (eg. "EUR")

id

The unique ID of the product.

image

Returns image object that can be attached to product in product settings view.

image?

Returns true or false depending whether image is attached to product.

name

Locale-sensitive (translated) name of the product.

out_of_stock?

Boolean indicating if the product is out of stock.

price_max

Maximum net price of product variants. Is same as price when the product does not use variants.

price_price_max_tax

Maximum price of product variants including tax. Is same as price_with_tax when the product does not use variants

price_min

Minimum net price of product variants. Is same as price when the product does not use variants.

price_price_min_tax

Minimum price of product variants including tax. Is same as price_with_tax when the product does not use variants

price

Net price of the product.

price_with_tax

Price of the product including tax.

reserved_quantity

The reserved number of items.

sku

Unique SKU of the product.

status

Status of the product, one of "draft", "live".

stock

Number of items in stock.

tax_rate

Tax rate applicable to the product, in percent.

uses_variants

Boolean indicating if the product has variants.

variants_count

Number of product variants.

variant_types

JSON-serialized data structure of product variant types.

variant_values

JSON-serialized data structure of product variant values.