Variants

Overview

Below is a list of all the available drops on the <insert name here> object


 

VariantDrop

Below is a list of all the available drops on the <insert name here> object


Name Description
id Unique database Identifier
sku Stock Keeping Unit (article number)
is_master? Boolean, true or false.
master? Boolean. True or false.
prices Returns PricesDrop. See below.
price Variant price for current user
stock_item StockItemDrop. See below.
stock alias for stock_item
properties Array with ProductPropertyDrop(s)
option_values Array with OptionValueDrop(s)
files Array with ProductFileDrop(s)
images Array with ProductFileDrop(s). Returns only the images from the files array.
first_image ProductFileDrop with the first image or nil if does not exist.
in_stock? Boolean. True or false
track_inventory Boolean. True or false
property_size ProductPropertyDrop. Returns the variant's property for teh specified name, in this case 'size'
option_type_size OptionValueDrop. Returns the variant's option value for the option type
with the specified name, in this case 'size'
for_sale? Returns true if the variant CAN be sold. Does not check tock item quantity.
not_for_sale? Returns true if the cariant CANNOT be sold?
recommend_url Path for sending an email recommendation for this variant.
track_inventory Boolean: true or false
campaigns CampaignDrop. Returns the variant's campaigns.
multishop_id Multishop ID

 

StockItemDrop

Below is a list of all the available drops on the <insert name here> object


Name Description
quantity Number. Available quantity
backorderable Boolean. True or false.
out_of_stock_message Non translated backorder message.
in_stock? Boolean. True or false.
delivery_time_in_stock String. Not translated.
delivery_time_out_of_stock String. Not translated

 

PricesDrop

Below is a list of all the available drops on the <insert name here> object


Name Description
current PriceDrop for the current customer. Customer price or Discount list price or price list price.
current_greater_than_zero PriceDrop for current customer price list price.
price_list PriceDrop for current customer price list price.
default PriceDrop for deafult price list price.
recommended PriceDrop for recommended price list price.
sale PriceDrop for customer ongoing sales price.
campaign PriceDrop for current campaign. Uses context variable 'campaign'.

 

PriceDrop

Below is a list of all the available drops on the <insert name here> object


Name Description
id Returns the price id
include_tax Does the price include taxes?
inlcude_tax? Does the price include taxes?
exists? Does the price exist?
amount Returns the amont based on the customer seeing taxes or not.
pre_tax_amount Returns the amount without taxes
after_tax_amount Returns the amount with taxes.
staggered? Is the price staggered?
staggered_prices Array <StaggeredPriceDrop> if staggered.
discount Price discount in percentage
discount_multiplier Price discount multiplier
price_list? Does the price belong to a price list?
discount_list? Does the price belong to a discount list?
customer? Does the price belong to a customer?
campagin? Does the price belong to a campaign?

 

StaggeredPriceDrop

Below is a list of all the available drops on the <insert name here> object


Name Description
id Returns the staggered price id
start_quantity Start quantity for the price to be applicable
include_tax Does the price include tax?
include_tax? Does the price include tax?
exists? Does the price exist?
amount Returns the amount based on the customer seeing taxes or not.
pre_tax_amount Returns the amount without taxes.
after_tax_amount Returns the amount with taxes.

 

OptionValueDrop

Below is a list of all the available drops on the <insert name here> object


Name Description
id WM3 identifier
name Name in the webshop
presentation Presentation in the webshop
value Same as presentation
variant_ids All the variants with this value. If used together with product.options_with_variants_and_prices
it will only return variants for that product.
variant_id The id of the first variant in variant_ids
variants Same as variant_ids but returns Array <VariantDrop> instead
variant First variant in variants
type_name Shortcut for option_type.name
type_pressentation Shortcut for option_type.type_presentation
option_type Return <OptionTypeDrop> for this value.
checked? To be used together with product filters
image_url Returns the image url

 

OptionTypeDrop

Below is a list of all the available drops on the <insert name here> object


Name Description
id WM3 identifier
name Name in the webshop
presentation Presentation in the webshop
values Array <OptionValueDrop>. Values for this option type.
input_name To be used together with product filters

Updated: 2021-01-05