| Name | Description | Type | Additional information |
|---|---|---|---|
| Qty | integer |
None. |
|
| OrderBy | integer |
None. |
|
| eskimo_product_identifier | string |
Required |
|
| trade_customer_id |
Eskimo Customer ID - See the Customer Controller. If this product is specifically for a trade customer, then this property denotes which customer it is for. If it is a generic product then this will be zero-length string. |
string |
Matching regular expression pattern: \d{3}[-]\d{6} String length: inclusive between 10 and 10 |
| sku_code |
This is the barcode or PLU number. In a retail shop, this will be the code that the operator will scan into the till at POS. This can either be a code that exclusively represents that product worldwide, or it could be a unique code for that retailer only - one that they have assigned to the product. |
string |
Required String length: inclusive between 0 and 35 |
| additional_sku_code |
Optional. An additional barcode. Supplier's EAN perhaps. |
string |
String length: inclusive between 0 and 35 |
| Style_Reference |
On top of the sku code, Eskimo uses a Style Reference code to group SKUs together of a similar type. For example, you may have a jumper that comes in 3 colours and 3 sizes. All 9 of the SKUs will share the same Style Reference code (JUM-01 for example) but they will also have unique sku codes. This field should have the same value as the style_reference property on the Products controller for the same product. |
string |
String length: inclusive between 0 and 20 |
| ColourID |
The Eskimo Colour code. (i.e. BK) |
string |
String length: inclusive between 0 and 6 |
| ColourName |
The name of the colour (i.e. Black) |
string |
String length: inclusive between 0 and 50 |
| Size |
The size of the product (i.e. Small or 23") |
string |
String length: inclusive between 0 and 50 |
| CostPrice |
The price that the retailer pays to obtain the product |
decimal number |
Required |
| RRP |
Optional. The Supplier's Recommended Retail Selling price of the item. Where this is higher than the 'Sell Price', a 'saving' can be advertised to the end-user. |
decimal number |
None. |
| SellPrice |
The sell price to be used on the website |
decimal number |
Required |
| SellPrice2 |
A secondary sell price which can sometimes be used on the website, usually as a trade price |
decimal number |
Required |
| PhysicalStock |
The Physical amount of stock the retailer has for this item |
integer |
None. |
| Demand |
Customer demand for this item. Orders that customer's have placed which are yet be dispatched to them. |
integer |
None. |
| StockAmount |
The quantity of items the retailer has on hand to sell in the current shop. Free stock. (Physical Stock minus Demand) |
integer |
Required |
| TaxCodeID |
The Eskimo Tax Code ID. Links to the TaxCodes controller. |
integer |
Required |
| PersonalisationPrompt |
If this product is personalisable (i.e. printed t-shirts or engraved trophies) then this text denotes the prompt to the purchaser (i.e. Please enter the name to be engraved.) |
string |
String length: inclusive between 0 and 50 |
| PersonalisationSurCharge |
Some products have the option of being personalised for a extra fee. This field denotes that fee. |
decimal number |
None. |
| Position |
The order in which these should be displayed in the GUI to the end user |
integer |
None. |
| web_id |
This is the Primary Key that the website is using for this SKU. Note this is unique per product - so they same SKU may be in two different products and will therefore have a different Web ID assigned. Call the UpdateCartIDs method to set these values |
string |
None. |
| OutOfStockBehaviour |
Specified the desired behaviour when the product is out of stock |
EskimoClassLibraries.clsSKU+OutOfStockBehaviourEnum |
None. |
| WeightValue |
The value of the weight of this SKU. |
decimal number |
None. |
| WeightUnit |
The weight unit. For example kg, lbs, grams. See GET api/MeasureUnits/All |
integer |
None. |
| BrandId |
The Id of the Brand |
integer |
None. |
| BrandName |
The name of the brand if applicable (i.e. Nike, Adidas) |
string |
None. |
| PackageStatus |
Controls whether the SKU should be sold as a normal SKU, or only be used within a Product Package/Kit |
EskimoClassLibraries.clsSKU+PackageStatusEnum |
None. |
| CustomAttributeLinks | Collection of EskimoClassLibraries.clsSKUAttributeLink |
None. |
|
| AddField01 |
An additional string field for this product. The retailer can use this for whatever purpose they need. |
string |
String length: inclusive between 0 and 30 |
| AddField02 |
An additional string field for this product. The retailer can use this for whatever purpose they need. |
string |
String length: inclusive between 0 and 50 |
| AddField03 |
An additional string field for this product. The retailer can use this for whatever purpose they need. |
string |
String length: inclusive between 0 and 4000 |
| 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. |
| AddField15 |
An additional boolean field for this product. The retailer can use this for whatever purpose they need. |
boolean |
None. |