POST api/Products/All

Returns a batch of product objects (max 10,000 at a time). Initially this could be used to populate the website database with all of Eskimo's products, this would be done by looping through all the products with no filtering. Once the initial population is done, a timestamp could be stored locally. Smaller daily or hourly requests could then be made to find any new or changed products since the last request by passing the local stored date into the body parameter RecordSelectionWithDate

Request Information

URI Parameters

None.

Body Parameters

RecordSelection class (passed in the request body)

EskimoClassLibraries.RecordSelectionWithDate

Name	Description	Type	Additional information
TimeStampFrom	Optional property that enables you to only receive products that have been added or modified in the Eskimo system since this timestamp.	date	None.
StartPosition	Initially, pass 1 to return the first record.	integer	Required Range: inclusive between 1 and 2147483647
RecordCount	The number of records to be returned.	integer	Required Range: inclusive between 1 and 10000

Name

Description

Type

Additional information

TimeStampFrom

Optional property that enables you to only receive products that have been added or modified in the Eskimo system since this timestamp.

date

None.

StartPosition

Initially, pass 1 to return the first record.

integer

Required

Range: inclusive between 1 and 2147483647

RecordCount

The number of records to be returned.

integer

Required

Range: inclusive between 1 and 10000

Request Formats

application/json, text/json

Sample:

{
  "TimeStampFrom": "2024-05-03T05:19:22.8586798+01:00",
  "StartPosition": 2,
  "RecordCount": 3
}

application/xml, text/xml

Sample:

<RecordSelectionWithDate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <RecordCount>3</RecordCount>
  <StartPosition>2</StartPosition>
  <TimeStampFrom>2024-05-03T05:19:22.8586798+01:00</TimeStampFrom>
</RecordSelectionWithDate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of EskimoClassLibraries.clsProduct

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.

Response Formats

application/json, text/json

Sample:

[
  {
    "eskimo_identifier": "sample string 1",
    "title": "sample string 2",
    "short_description": "sample string 3",
    "long_description": "sample string 4",
    "meta_keywords": "sample string 5",
    "meta_description": "sample string 6",
    "search_words": "sample string 7",
    "page_title": "sample string 8",
    "style_reference": "sample string 9",
    "date_created": "2024-05-03T05:19:22.8586798+01:00",
    "position": 11,
    "last_updated": "2024-05-03T05:19:22.8586798+01:00",
    "web_id": "sample string 13",
    "eskimo_category_id": "sample string 14",
    "web_category_id": "sample string 15",
    "from_price": 16.0,
    "addfield04": {
      "Key": 1,
      "Value": "sample string 2"
    },
    "addfield05": {
      "Key": 1,
      "Value": "sample string 2"
    },
    "addfield06": true,
    "tags": "sample string 18",
    "supplier_id": "sample string 19",
    "supplier_name": "sample string 20",
    "is_package": true,
    "colour_terminology": "sample string 22",
    "size_terminology": "sample string 23",
    "package_component_only": true,
    "use_colour_option": true,
    "use_size_option": true
  },
  {
    "eskimo_identifier": "sample string 1",
    "title": "sample string 2",
    "short_description": "sample string 3",
    "long_description": "sample string 4",
    "meta_keywords": "sample string 5",
    "meta_description": "sample string 6",
    "search_words": "sample string 7",
    "page_title": "sample string 8",
    "style_reference": "sample string 9",
    "date_created": "2024-05-03T05:19:22.8586798+01:00",
    "position": 11,
    "last_updated": "2024-05-03T05:19:22.8586798+01:00",
    "web_id": "sample string 13",
    "eskimo_category_id": "sample string 14",
    "web_category_id": "sample string 15",
    "from_price": 16.0,
    "addfield04": {
      "Key": 1,
      "Value": "sample string 2"
    },
    "addfield05": {
      "Key": 1,
      "Value": "sample string 2"
    },
    "addfield06": true,
    "tags": "sample string 18",
    "supplier_id": "sample string 19",
    "supplier_name": "sample string 20",
    "is_package": true,
    "colour_terminology": "sample string 22",
    "size_terminology": "sample string 23",
    "package_component_only": true,
    "use_colour_option": true,
    "use_size_option": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfclsProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <clsProduct>
    <addfield04 xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
      <d3p1:key>1</d3p1:key>
      <d3p1:value>sample string 2</d3p1:value>
    </addfield04>
    <addfield05 xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
      <d3p1:key>1</d3p1:key>
      <d3p1:value>sample string 2</d3p1:value>
    </addfield05>
    <addfield06>true</addfield06>
    <colour_terminology>sample string 22</colour_terminology>
    <date_created>2024-05-03T05:19:22.8586798+01:00</date_created>
    <eskimo_category_id>sample string 14</eskimo_category_id>
    <eskimo_identifier>sample string 1</eskimo_identifier>
    <from_price>16</from_price>
    <is_package>true</is_package>
    <last_updated>2024-05-03T05:19:22.8586798+01:00</last_updated>
    <long_description>sample string 4</long_description>
    <meta_description>sample string 6</meta_description>
    <meta_keywords>sample string 5</meta_keywords>
    <package_component_only>true</package_component_only>
    <page_title>sample string 8</page_title>
    <position>11</position>
    <search_words>sample string 7</search_words>
    <short_description>sample string 3</short_description>
    <size_terminology>sample string 23</size_terminology>
    <style_reference>sample string 9</style_reference>
    <supplier_id>sample string 19</supplier_id>
    <supplier_name>sample string 20</supplier_name>
    <tags>sample string 18</tags>
    <title>sample string 2</title>
    <use_colour_option>true</use_colour_option>
    <use_size_option>true</use_size_option>
    <web_category_id>sample string 15</web_category_id>
    <web_id>sample string 13</web_id>
  </clsProduct>
  <clsProduct>
    <addfield04 xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
      <d3p1:key>1</d3p1:key>
      <d3p1:value>sample string 2</d3p1:value>
    </addfield04>
    <addfield05 xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
      <d3p1:key>1</d3p1:key>
      <d3p1:value>sample string 2</d3p1:value>
    </addfield05>
    <addfield06>true</addfield06>
    <colour_terminology>sample string 22</colour_terminology>
    <date_created>2024-05-03T05:19:22.8586798+01:00</date_created>
    <eskimo_category_id>sample string 14</eskimo_category_id>
    <eskimo_identifier>sample string 1</eskimo_identifier>
    <from_price>16</from_price>
    <is_package>true</is_package>
    <last_updated>2024-05-03T05:19:22.8586798+01:00</last_updated>
    <long_description>sample string 4</long_description>
    <meta_description>sample string 6</meta_description>
    <meta_keywords>sample string 5</meta_keywords>
    <package_component_only>true</package_component_only>
    <page_title>sample string 8</page_title>
    <position>11</position>
    <search_words>sample string 7</search_words>
    <short_description>sample string 3</short_description>
    <size_terminology>sample string 23</size_terminology>
    <style_reference>sample string 9</style_reference>
    <supplier_id>sample string 19</supplier_id>
    <supplier_name>sample string 20</supplier_name>
    <tags>sample string 18</tags>
    <title>sample string 2</title>
    <use_colour_option>true</use_colour_option>
    <use_size_option>true</use_size_option>
    <web_category_id>sample string 15</web_category_id>
    <web_id>sample string 13</web_id>
  </clsProduct>
</ArrayOfclsProduct>