Using this table you can:
- View the list of various field names that are available throughout the WebStore
- The table contains the field name, description, string type, and requirements.
- This is the name that will be used throughout the WebStore
- E.g. If you are entering in the name of a product its field name will always be Product Name.
- Field descriptions will give a clear explanation of how the field works.
- String types will show you how each field should be formatted.
- E.g. if the string type is an integer you will be entering a number.
- If the field name is required, this means that the field name must be filled in.
- E.g. If price is set as required then in all areas where the price is requested must be entered.
Field Name Attributes
|Field Name||Field Description||String Type||Required|
|Product Name||The name of your product. Eg: iPhone X||String||Yes|
|Product Code||Product Stock Keeping Unit (SKU). An SKU is a unique code consisting of letters and numbers that identify characteristics of each product, such as manufacturer, brand, style, colour, and size.||Integer||Yes|
|Price||The price of the product. Don't include any currency symbols. For example, 9.99.||Decimal||Yes|
|Price Levels||Price levels are the levels each customer is on: either Standard price, price level A, price level B or price level C.|
Price levels only apply to customers that are pushed from the point of sale. The retailer assigns the customers at a price level.
We leverage price levels for membership pricing as well, where a customer can add a membership product to the basket to avail of a price level.
|Stock||The total amount of the product that is available to sell.||Integer||Yes|
|Product Description||The product description contains information about the product. E.g, Colour, type, etc.||String||No|
|Department name||The name of the department the product belongs to. Eg: A bracelet would belong to the department labelled: 'Jewellery'.||String||No|
|Category||A group of items that share the same characteristics. E.g, Bracelets would be a category in the Jewellery department.||String||No|
|Sub-Category||A secondary category. E.g, In the Bracelet category there could be a sub-category of Silver Bracelets.||String||No|
|Price A||Please view price levels.||Decimal||No|
|Price B||Please view price levels.||Decimal||No|
|Price C||Please view price levels.||Decimal||No|
|Web Price||The "regular" price of the item on your WebStore.||Decimal||No|
|Brand||The brand name of your product. E.g, Adidas, Prada, Nike, etc.||String||No|
|Theme||The theme of your product is a list of features that your product has.||String||No|
|Short Description||A short description will briefly summarise what the product is and how it works.||String||No|
|Weight||The weight of the item.||Decimal||No|
|No Web Sale||A flag indicating that the item is not for sale online and can only be bought in-store.||String||No|
|Taxable||A boolean stating whether your product is taxable or not.||Boolean||No|
|Rating||The rating reported by a review on the product.||Integer||No|
|Department Code||The code of the department your product is based.||Integer||No|
|Hide Product?||If your product is temporarily out of stock or you are no longer selling the item you can choose to hide the product. This makes the item hidden from view. It can be then disabled by unchecking the checkbox when you edit the item.||Boolean||No|
|Item Tax||The tax configured for the item. You can choose the tax implemented on a product when editing or creating a new product. Examples of an item tax would be: 23% VAT.||Integer||No|
|Quantity Discount||A discount based on the number of items a user has purchased. E.g, Buy X get Y for Z discount.||Integer||No|
|Custom text||Enter a custom text about a given product||String||No|
|Custom number||Enter a custom number about a given product||Integer||No|
If you have any issues regarding this feature, contact our support team by opening a ticket.