Search

Index

Revindex Storefront

Product Variant

To import/export product variants, go to Catalog > Products from the Storefront module menu. Click on the Import or Export link. Then select "Product variant".

Column Type Data required Description Example
Act String Yes Type of import action to perform (Insert = i, Update = u, Delete = d) u
ProductVariantID Integer Yes/No Database object identifier. This value is required when performing an update or delete action if the ProductVariantKey is not provided. 12
ProductVariantKey String Yes/No A unique key that can be used to uniquely identify this object. This could be a short meaningful text or simply a GUID. If you don't specify a value, the system will generate a unique key for you during insertion. This key can be used to lookup the object if the ProductVariantID is not specified. apple-ipad-white
AllowableOrderQuantity String No  The distinct quantities you want to allow, separated by a pipe "|" delimiter. Use a dash to denote a range of quantities. For example, if you enter "1|3|5-7|9" in the text box, only quantities 1, 3, 5, 6, 7 and 9 will be allowed. 1|3|5-7|9
AllowPartialReturn Boolean Yes Indicates if the product can be returned wholly or partially. False
AllowProductComparison Boolean Yes Allow product to be compared with others. True
AllowRecurringGroupOrders Boolean Yes Allow this variant to be grouped together with other similar orders if this variant is due for recurring. True
AllowRewardsPoint Boolean Yes Allow this variant to participate in rewards point program. True
AvailabilityRule XML Rule No The rule to describe the conditions when the product can be purchased.  
BasePrice Decimal Yes Product base price. 15.00
BookingRule XML Rule No The rule to describe booking conditions such as exclusion dates.  
BuyingGuide String No Buying guide text.  
BuyingGuideName String No Override default name for the buying guide description.  
CreateDate DateTime No    
CreditInterval Integer No The amount of time allowed to credit a return.  
CreditIntervalType Integer Yes Day = 1
Week = 2
Month = 3
Year = 4
 
Depth Decimal Yes Product depth in cm. Enter zero if not used. 15.5
DisplayOrder Integer Yes Product sort order from smallest to largest number. 1000
DistributorID Integer No Associate this variant to a distributor by its DistributorID. If you specify DistributorID, the DistributorKey will be ignored. 9
DistributorKey String No Associate this variant to a distributor by its DistributorKey. If you specify DistributorID, the DistributorKey will be ignored. allied
DistributorSKU String No Distributor SKU number.  
DownloadFile String No The URL, file or page associated to the product.  
DynamicFormCode XML Code No Custom HTML or input form elements.  
ExchangeInterval Integer No The amount of time allowed to exchange a return.  
ExchangeIntervalType Integer Yes Day = 1
Week = 2
Month = 3
Year = 4
 
Extension XML No Extra data in XML string. <data><misc>True</misc></data>
FAQ String No FAQ text.  
FAQName String No Override default name for the FAQ description.  
HandlingPrice Decimal Yes The handling price to charge if handling rule uses it. 0.00
HasSerialNumber Boolean Yes Indicates if the product has serial number for return purposes. False
Height Decimal Yes Product height in cm. Enter zero if not used. 10
Inventory Integer No Inventory level. 2000

InventoryEmptyBehavior
 

Integer

Yes
How product behaves when inventory is empty.

DisallowOrder = 1
DisableProduct = 2
AllowBackorder = 3

1
InventoryUnitType Integer Yes Indicate how inventory is treated especially in the case of a booking product. For regular product, the unit type should be Constant.

Constant = 1
Year = 2
Month = 3
Week = 4
Day = 5
Hour = 6
1
ManufacturerID Integer No Associate this variant to a manufacturer by its ManufacturerID. If you specify ManufacturerID, the ManufacturerKey will be ignored. 3
ManufacturerKey String No Associate this variant to a manufacturer by its ManufacturerKey. If you specify ManufacturerID, the ManufacturerKey will be ignored.  
ManufacturerSKU String No Manufacturer SKU number.  
MaxBookingDate DateTime No    
MaxBookingTime TimeSpan No    
MaxInventory Integer No The desirable max inventory to keep.  
MaxOrderQuantity Integer No Maximum order quantity. 10
MaxOrderUnit Integer No Maximum reservable units for a booking product. 5
MinOrderUnit Integer No Minimum reservable units for a booking product. 3
MetaDescription String No Localized meta description.  
MetaKeywords String No Localized meta keywords.  
MinBookingDate DateTime No    
MinBookingTime TimeSpan No    
MinInventory Integer No The desirable min inventory to keep.  
MinOrderQuantity Integer No Minimum order quantity. 1
MinOrderUnit Integer No Minimum reservable units for a booking product. 1
ModifierRule XML Rule No Product modifer rule.  
MSRP Decimal No Manufacturer suggested retail price. 25.00
Name String Yes Product variant name. Best of Popular Mechanics
Overview String No Overview text.  
OverviewName String No Override default name for the overview description.  
PackageType Integer Yes Shipping package type used for shipping calculation. 2000
PageTitle String No Localized page title.  
PreorderInterval Integer Yes The days to preorder a recurring order ahead of time. 0
PriceText String No Any text specified here will be shown to the customer instead of the actual price. Call for price
ProductCost Decimal No Cost of product. 8.00
ProductID Integer Yes/No Reference the corresponding product by its ProductID. If you specify ProductID, the ProductKey will be ignored. 1
ProductKey String Yes/No Reference the corresponding product by its ProductKey. If you specify ProductID, the ProductKey will be ignored. apple-ipad
PromotionRule XML Rule No Product promotion rule.  
PromotionStartDate DateTime No Product promotion start date.  
PromotionStopDate DateTime No Product promotion stop date.  
Published Boolean Yes Enable display of the product. True
RecurringInterval Integer Yes The recurring repeat interval for the RecurringIntervalType. Enter zero for non-recurring. 12
RecurringIntervalType Integer Yes Day = 1
Week = 2
Month = 3
Year = 4
3
RecurringMaxRepeat Integer No The number of times to repeat the recurring order or leave blank to repeat perpetually. 1
RecurringMinRepeat Integer No The minimum number of times that must be repeated before allowing customers from cancelling future recurring orders. 11
RefundInterval Integer No The amount of time allowed to refund a return.  
RefundIntervalType Integer Yes Day = 1
Week = 2
Month = 3
Year = 4
 
RepairInterval Integer No The amount of time allowed to repair a return.  
RepairIntervalType Integer Yes Day = 1
Week = 2
Month = 3
Year = 4
 
RequireHandling Boolean Yes Product requires handling. True
RequireShipping Boolean Yes Product requires shipping. True
RewardPoints Integer No The custom number of rewards points to award. Leave empty if awarding the default number of points based on the selling price. 10
RightDefinitionID Integer No If this value is set, the customer will be issued the access rights when order is paid or completed.  
SalesType Integer Yes Determine if product can be purchased at the listed price or must be quoted first.

Sale = 1
Quoted = 2
 
ShippingCode String No Shipping code may be used by your shipping provider to classify this package to obtain a more accurate quote.  
ShippingPrice Decimal Yes The shipping price to charge if shipping rule uses it. 0.00
SKU String No Product SKU RVD1000.V1
Specifications String No Specifications text.  
SpecificationsName String No Override default name for the specifications description.  
StartDate DateTime No When to start publishing product. 2010-10-15
StartRecurringDate DateTime No Initialize a different recurring start date by interval amount.  
StartRecurringInterval Integer Yes Initialize a different recurring start date by interval amount. 0
StartRecurringIntervalType Integer Yes The interval type

Day = 1
Week = 2
Month = 3
Year = 4
1
StopDate DateTime No When to stop publishing product. 2012-01-18
Summary String No Summary text.  
TaxClassID Integer No Product tax class. Database tax class ID. 3
Terms String No Terms text.  
TermsName String No Override default name for the terms description.  
UniversalProductCode String No Universal product code.  
UpdateDate DateTime No    
UrlName String No Localized URL name for SEO.  
VoucherDefinitionID Integer No If this value is set, a new voucher of this type will be automatically generated and emailed to customer when order is paid or completed.  
WarehouseID Integer No Indicate if this product in kept at a specific warehouse. Reference the warehouse by its WarehouseID. If the WarehouseID is specified, the WarehouseKey is ignored. 8
WarehouseKey String No Indicate if this product in kept at a specific warehouse. Reference the warehouse by its WarehouseKey. If the WarehouseID is specified, the WarehouseKey is ignored.  
Weight Decimal Yes Product weight in gram. Enter zero if not used. 100
Width Decimal Yes Product width in cm. Enter zero if not used. 10.2
     

Comments


Powered by Revindex Wiki