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
id
stringrequiredID 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.title
stringrequired when creating/updatingA 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
).The price of this variant of the product
If the price is zero, you need to set
price_known
totrue
for it to be accepted.price_known
booleanoptionalA flag required to accept a zero price
deleted
booleanoptionalSet 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.