Fields

Products have a number of fields in which you can enter information about the product. This document provides a short summary of the fields common to all users. New, specialized, fields can be created on a customer basis, contact your Shoppa representative for more information.

Required fields

When creating a new product, there are certain fields that must be defined:

• Brand

• Product name

• At least one Code field (see below)

Code fields

Code fields are special, in that their values must be unique. That is, no two of your products may contain the same value in, for example, their Code 1 field. The uniqueness constraint does not carry over multiple fields, e.g. one products Code 1 can be the same as another products Code 3 without issue. The constraint also doesn't carry over between customers, i.e. one of your products may have the same Code 1 as a product belonging to another customer.

Identifier	Data Type	Recommendation
code1	String	Primary article number
code2	String	Additional article number
code3	String	Additional article number
code4	String	Additional article number
code5	String	Additional article number
code6	String	Additional article number
ean8	String	EAN 8 code
ean13	String	EAN 13 code

Text fields

Identifier	Data type	Text recommendation
amount	Double	Amount of the product in the packaging
brand	String	The brand of the product
color	String	The color of the product
campaignstartdate	String	Campaign start date. YYYY-MM-DD format should be used.
campaignstopdate	String	Campaign stop date. YYYY-MM-DD format should be used.
comparefactor	Double	Compare factor of the product. Used to calculate the comparison price
compareunit	String	Unit for the compare factor. It will be displayed as the comaprison price unit
comparisonprice	String	The already calculated comparison price. Send both the price and unit as it should be displayed.
corp	String	The corporation that owns the brand of the product
countryoforigin	String	The country of origin of the product
depth	String	The depth measurement of the product
diameter	String	The diameter measurement of the prodct
discountpercent	Double	The products discount, in percent. Should be used in campaigns
discountsum	Double	The product discount, in monetary units. Should be used in campaigns
effect	String	The power consumption of the product
elearning	String	URL to a website that explains more about the product.
from	String
height	String	The height measurement of the product
infolong	String	A more detailed description of the product. Recomended length is 200 - 400 characters. Supports line breaks
infoshort	String	A short description of the product that highlights specific characteristics or differenses to similar products. Recomended length is 20 - 50 characters.
ingredients	String	Ingredients used in the product
inventory	String	Information used during inventory and ordering of the product
keywords	String	Keywords used while searching for the product. These words usually are not available in the product text description, e.g. misspelled words or synonyms
lastupdated	String	The date when the product information was last updated
length	String	The length measurement of the prodct
model	String	Model name of the product
multi	Integer	The amount of items in a multi offer
multi2	Integer	Used in X for Y promotions where the value corresponds to Y.
packsize	Integer	The number of products in i multipack.
page	String	The page number where the product appeared in advertising material
productname	String	The name of the product. Recomended length is 10 - 20 characters
properties	String	Describes qualities, attributes or distinctive features of the product, eg. characteristic attributes such as the density or strength of a material
refund	Double	The monetary refund for the product
salespackageunit	String	The unit in which the product is sold. Used if the unit differs from the products "unit" value.
salespackageunitbefore	String	Used to store the original 'sales package unit' if it is changed for a campaign
salesrule	Integer	Used to control behavior in dynamic templates, mostly in campaigns. Send one of the values 1 - 16
salesruleb	Integer	Used to control behavior in dynamic templates, mostly in campaigns. Send one of the values 1 - 17
salesrulec	Integer	Used to control behavior in dynamic templates, mostly in campaigns. Send one of the values 1 - 15
salesruled	Integer	Used to control behavior in dynamic templates, mostly in campaigns. Send one of the values 1 - 15
salong	String	A longer selling text. Recomended length is 200 - 400 characters
sashort	String	A short selling text, e.g. a pay off text. Recomended length is 20 - 50 characters
seals	String	One of six fields used for enviromental symbols, fair trade symbols and general pictograms. Recomended length for text in this field is 10 - 20 characters.
seals2	String	One of six fields used for enviromental symbols, fair trade symbols and general pictograms. Recomended length for text in this field is 10 - 20 characters.
seals3	String	One of six fields used for enviromental symbols, fair trade symbols and general pictograms. Recomended length for text in this field is 10 - 20 characters.
seals4	String	One of six fields used for enviromental symbols, fair trade symbols and general pictograms. Recomended length for text in this field is 10 - 20 characters.
seals5	String	One of six fields used for enviromental symbols, fair trade symbols and general pictograms. Recomended length for text in this field is 10 - 20 characters.
seals6	String	One of six fields used for enviromental symbols, fair trade symbols and general pictograms. Recomended length for text in this field is 10 - 20 characters.
spec	String	The technical specifications of the product
subbrand	String	The second brand of the product, if such exists
target	String	The target audience of the product
techname	String	The technical name of the product
treatment	String	Recommendations on how to treat the product after purchase. Recomended length is 200 - 400 characters
unit	String	Describes the unit used in conjunction with 'amount'
videourl	String	Used with digital signage. The URL of a video clip to use
volume	String	The volume measurement of the product
warranty	String	Information about the warranty of the product
weight	String	The weight measurement of the product
width	String	The width measurement of the product

Price fields

Price fields are only available in price lists and campaigns. They can therefore only be integrated using the storeinformation XML.

Identifier	Data type	Use case
price	Double	The price of the product
pricebefore	Double	The regular price of the product. This is automatically set by Shoppa if a campaign price is available
pricecombined	Double	The price of a package deal
pricelowest	Double	Lowest price of the product within 30 days of the campaign period. Used in purpose of the EU price information law
pricerecommended	Double	The recommended price of the product
priceto	Double	The upper limit of the price range of the product, if one exists

Picture fields

Pictures can be attached to any fields, but we do have some recommendations, i.e. the main product picture should go in the 'product name' field. These recommendations are listed below.

• Primary image - productname

• Secondary image - techname

• Third image - infoshort

• Fourth image - infolong

Additional fields

There are additional fields with no intended use case. These can be used if there are no other suiting fields available.

Identifier	Data type
text1	String
text2	String
text3	String
text4	String
text5	String
text6	String
text7	String
text8	String
text9	String
text10	String
text11	String
text12	String
text13	String
text14	String
text15	String
text16	String
text17	String
text18	String
text19	String
text20	String
text21	String
text22	String
text23	String
text24	String
text25	String
text26	String
text27	String
text28	String
text29	String
text30	String