Order API

ProductVariant2

Represents a particular product variant (color / size / etc) in the ecommerce system.

The assumption is that product variants are what actually gets added to the cart when shopping.

Properties

  • idstringrequired

    ID of the product variant in the ecommerce system

    In case of Shopify, this is just a number without gid://shopify/ProductVariant/ prefix. If your system gives similar fixed prefixes to products, we recommend that you strip them as well.

  • titlestringrequired when creating/updating

    A user-visible name of the variant

    Should be specified in all cases, except when you're merely referencing an existing variant by ID (in which case you'll only specify a single field, id).

  • pricemonetaryoptional but recommended

    The price of this variant of the product

    If the price is zero, you need to set price_known to true for it to be accepted.

  • price_knownbooleanoptional

    A flag required to accept a zero price

  • deletedbooleanoptional

    Set to true to delete this variant in our system

    Bubblehouse does not have deletion APIs for most objects; instead, pass deleted: true when updating an object. Note that we won't delete the data immediately, in case there are other objects referencing this one.

Previous
Product2