Name | Description | Type | Additional information |
---|---|---|---|
eskimo_identifier |
A unique Eskimo-generated key |
string |
Required |
title |
The title of the product |
string |
String length: inclusive between 0 and 255 |
short_description | string |
None. |
|
long_description | string |
None. |
|
meta_keywords | string |
String length: inclusive between 0 and 255 |
|
meta_description | string |
None. |
|
search_words | string |
None. |
|
page_title | string |
String length: inclusive between 0 and 255 |
|
style_reference |
The Eskimo Style Reference code. |
string |
String length: inclusive between 0 and 12 |
date_created |
When the product was created in the Eskimo system |
date |
Required |
position |
The position the product should appear in on a category page. (Irrelevant if ordering by price or alphabetical, but applicable when ordering by position.) |
integer |
Required |
last_updated |
When the product was last modified in the Eskimo system |
date |
Required |
web_id |
This is the Primary Key that the website is using for this product. Call the UpdateCartIDs method to set these values |
string |
None. |
eskimo_category_id |
This is the Eskimo Category ID for the default/main category linked to this product |
string |
None. |
web_category_id |
This is the Web Category ID for the default/main category linked to this product. |
string |
None. |
from_price |
The is the lowest price the product comes in. If there are multiple colour and size variations, some of the larger sizes may cost more. Consult the SKUs controller to find exact pricing on each SKU underneath a product. |
decimal number |
None. |
addfield04 |
An additional key/value pair field for this product. The retailer can use this for whatever purpose they need. |
Pair of integer [key] and string [value] |
None. |
addfield05 |
An additional key/value pair field for this product. The retailer can use this for whatever purpose they need. |
Pair of integer [key] and string [value] |
None. |
addfield06 |
An additional boolean field for this product. The retailer can use this for whatever purpose they need. |
boolean |
None. |
tags |
Custom free text specified by the retailer. Perhaps a series of delimited tags which can act as triggers for certain behaviour in the cart. |
string |
None. |
supplier_id |
The Eskimo ID of the company that supplies the product. |
string |
None. |
supplier_name |
The Company Name of the business that supplies the product. |
string |
None. |
is_package |
States whether this product is a package header. If it is, the eskimo_identifier of this product can be passed to the call for details of the package. |
boolean |
None. |
colour_terminology |
Although the field label is called Colour, customers can choose to rename this to something else. This field denotes what should be displayed in the dropdown label |
string |
String length: inclusive between 0 and 50 |
size_terminology |
Although the field label is called Size, customers can choose to rename this to something else. This field denotes what should be displayed in the dropdown label |
string |
String length: inclusive between 0 and 50 |
package_component_only |
If true, this indicates that the product is a package component, but should not be sold separately. |
boolean |
None. |
use_colour_option |
Determines whether a colour drop-down should be utilitised on the product page or not. |
boolean |
None. |
use_size_option |
Determines whether a size drop-down should be utilitised on the product page or not. |
boolean |
None. |