POST api/Listings/AllUnlisted

Retrieves a list of all items that have not yet been listed externally. For example all eBay listings.

Request Information

URI Parameters

None.

Body Parameters

Specifies the filter to apply to the search

Name	Description	Type	Additional information
ListingFIlter	Specifies whether you want to retieve listings of all types, or only those for a singular type.	EskimoClassLibraries.ListingsArguments+ListingFilterEnum	None.

Request Formats

application/json, text/json

Sample:

{
  "ListingFIlter": 0
}

application/xml, text/xml

Sample:

<ListingsArguments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <ListingFIlter>AllListings</ListingFIlter>
</ListingsArguments>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of EskimoClassLibraries.clsListing

Name	Description	Type	Additional information
EskimoID	The numeric Eskimo ID of the Listing	integer	None.
ExternalID	The Identifier used by the third-party site. For example, when listing an item on eBay, an ID will generated by eBay to represent that listing.	string	None.
ListingType	Listing Type, or destination for the listing.	EskimoClassLibraries.clsListing+ListingTypeEnum	None.
Category	The external category. The ID of this will be required to post the item on the third-party site.	EskimoClassLibraries.clsExternalCategory	None.
DateCreatedLocally	The date that the retailer created the listing within the Eskimo software.	date	None.
DateListedExternally	The date that the listing was posted to the third-party. This will be NULL until the MarkAsListed action is called.	date	None.
Title	This is the short Title of the product being listed.	string	None.
ItemDescription	This is the full HTML description of the item.	string	None.
UsesVariations	This determines if the listing will be using more than one SKU. For instance, a t-shirt that comes in multiple colours and sizes will set this to True.	boolean	None.
ListingDuration	The amount of time that the listing should be active for	EskimoClassLibraries.clsListing+ListingDurationEnum	None.
MaxDispatchTime	How long the retailler will take to dispatch the goods once an order is placed.	EskimoClassLibraries.clsListing+DispatchTimeMaxEnum	None.
ItemCondition	The condition of the product.	EskimoClassLibraries.clsListing+ConditionEnum	None.
Auto_Relist	Determines if the product should be relisted if it doesn't sell	boolean	None.
Listing_Format	Fixed Price or Auction	EskimoClassLibraries.clsListing+ListingFormatEnum	None.
Returns_Accepted	Are returns accepted for this product	boolean	None.
CurrencyCode	The currency code used for the listing	string	None.
CountryCode	The two-digit country code for the lister of the product	string	None.
ItemSpecifics	A collection of the Item Specifics about this product. These are completed by the retailer, using the suggestions provided by the third-party. For instance, eBay will provide a list of all key-value pairs that they would like completed for each category type.	Collection of EskimoClassLibraries.clsItemSpecificsBasic	None.
Variations	If this listing is set to use variation, then this will be a collection of the price, SKU and quantity in stock that are offered for the product being listed. If the product does not use Variations, then there will only be one entry present.	Collection of EskimoClassLibraries.clsVariation	None.
ShippingDetails	A collection of the shipping options offered for the listing. For example they might offer Collect in Person + Parcel force 24 hour.	Collection of EskimoClassLibraries.clsListingShipping	None.
ListingImages	A collection of images for the listing	Collection of EskimoClassLibraries.clsListingImage	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "EskimoID": 1,
    "ExternalID": "sample string 2",
    "ListingType": 1,
    "Category": {
      "CategoryID": "sample string 1",
      "CategoryLevel": 2,
      "CategoryParentID": "sample string 3",
      "CategorySource": 1,
      "CategoryName": "sample string 4",
      "ItemSpecifics": [
        {
          "MinSelected": 1,
          "MaxSelected": 2,
          "SelectionMode": 1,
          "ValueType": null,
          "SpecificsName": "sample string 3",
          "Values": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "MinSelected": 1,
          "MaxSelected": 2,
          "SelectionMode": 1,
          "ValueType": null,
          "SpecificsName": "sample string 3",
          "Values": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ],
      "LeafCategory": true,
      "AdditionalIdentifier": "sample string 6"
    },
    "DateCreatedLocally": "2024-05-03T07:08:03.2868753+01:00",
    "DateListedExternally": "2024-05-03T07:08:03.2868753+01:00",
    "Title": "sample string 5",
    "ItemDescription": "sample string 6",
    "UsesVariations": true,
    "ListingDuration": 3,
    "MaxDispatchTime": 0,
    "ItemCondition": 1000,
    "Auto_Relist": true,
    "Listing_Format": 4,
    "Returns_Accepted": true,
    "CurrencyCode": "sample string 9",
    "CountryCode": "sample string 10",
    "ItemSpecifics": [
      {
        "SpecificsName": "sample string 1",
        "Values": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "SpecificsName": "sample string 1",
        "Values": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "Variations": [
      {
        "SKU": "sample string 1",
        "Price": 2.0,
        "EANCode": "sample string 3",
        "QtyOffered": 4,
        "Attributes": [
          {
            "OptionName": "sample string 1",
            "Value": "sample string 2",
            "VariationImages": [
              {
                "ImageFileName": "sample string 1",
                "ImageKey": "sample string 2"
              },
              {
                "ImageFileName": "sample string 1",
                "ImageKey": "sample string 2"
              }
            ]
          },
          {
            "OptionName": "sample string 1",
            "Value": "sample string 2",
            "VariationImages": [
              {
                "ImageFileName": "sample string 1",
                "ImageKey": "sample string 2"
              },
              {
                "ImageFileName": "sample string 1",
                "ImageKey": "sample string 2"
              }
            ]
          }
        ]
      },
      {
        "SKU": "sample string 1",
        "Price": 2.0,
        "EANCode": "sample string 3",
        "QtyOffered": 4,
        "Attributes": [
          {
            "OptionName": "sample string 1",
            "Value": "sample string 2",
            "VariationImages": [
              {
                "ImageFileName": "sample string 1",
                "ImageKey": "sample string 2"
              },
              {
                "ImageFileName": "sample string 1",
                "ImageKey": "sample string 2"
              }
            ]
          },
          {
            "OptionName": "sample string 1",
            "Value": "sample string 2",
            "VariationImages": [
              {
                "ImageFileName": "sample string 1",
                "ImageKey": "sample string 2"
              },
              {
                "ImageFileName": "sample string 1",
                "ImageKey": "sample string 2"
              }
            ]
          }
        ]
      }
    ],
    "ShippingDetails": [
      {
        "Index": 1
      },
      {
        "Index": 1
      }
    ],
    "ListingImages": [
      {
        "ImageFileName": "sample string 1",
        "ImageKey": "sample string 2"
      },
      {
        "ImageFileName": "sample string 1",
        "ImageKey": "sample string 2"
      }
    ]
  },
  {
    "EskimoID": 1,
    "ExternalID": "sample string 2",
    "ListingType": 1,
    "Category": {
      "CategoryID": "sample string 1",
      "CategoryLevel": 2,
      "CategoryParentID": "sample string 3",
      "CategorySource": 1,
      "CategoryName": "sample string 4",
      "ItemSpecifics": [
        {
          "MinSelected": 1,
          "MaxSelected": 2,
          "SelectionMode": 1,
          "ValueType": null,
          "SpecificsName": "sample string 3",
          "Values": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "MinSelected": 1,
          "MaxSelected": 2,
          "SelectionMode": 1,
          "ValueType": null,
          "SpecificsName": "sample string 3",
          "Values": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ],
      "LeafCategory": true,
      "AdditionalIdentifier": "sample string 6"
    },
    "DateCreatedLocally": "2024-05-03T07:08:03.2868753+01:00",
    "DateListedExternally": "2024-05-03T07:08:03.2868753+01:00",
    "Title": "sample string 5",
    "ItemDescription": "sample string 6",
    "UsesVariations": true,
    "ListingDuration": 3,
    "MaxDispatchTime": 0,
    "ItemCondition": 1000,
    "Auto_Relist": true,
    "Listing_Format": 4,
    "Returns_Accepted": true,
    "CurrencyCode": "sample string 9",
    "CountryCode": "sample string 10",
    "ItemSpecifics": [
      {
        "SpecificsName": "sample string 1",
        "Values": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "SpecificsName": "sample string 1",
        "Values": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "Variations": [
      {
        "SKU": "sample string 1",
        "Price": 2.0,
        "EANCode": "sample string 3",
        "QtyOffered": 4,
        "Attributes": [
          {
            "OptionName": "sample string 1",
            "Value": "sample string 2",
            "VariationImages": [
              {
                "ImageFileName": "sample string 1",
                "ImageKey": "sample string 2"
              },
              {
                "ImageFileName": "sample string 1",
                "ImageKey": "sample string 2"
              }
            ]
          },
          {
            "OptionName": "sample string 1",
            "Value": "sample string 2",
            "VariationImages": [
              {
                "ImageFileName": "sample string 1",
                "ImageKey": "sample string 2"
              },
              {
                "ImageFileName": "sample string 1",
                "ImageKey": "sample string 2"
              }
            ]
          }
        ]
      },
      {
        "SKU": "sample string 1",
        "Price": 2.0,
        "EANCode": "sample string 3",
        "QtyOffered": 4,
        "Attributes": [
          {
            "OptionName": "sample string 1",
            "Value": "sample string 2",
            "VariationImages": [
              {
                "ImageFileName": "sample string 1",
                "ImageKey": "sample string 2"
              },
              {
                "ImageFileName": "sample string 1",
                "ImageKey": "sample string 2"
              }
            ]
          },
          {
            "OptionName": "sample string 1",
            "Value": "sample string 2",
            "VariationImages": [
              {
                "ImageFileName": "sample string 1",
                "ImageKey": "sample string 2"
              },
              {
                "ImageFileName": "sample string 1",
                "ImageKey": "sample string 2"
              }
            ]
          }
        ]
      }
    ],
    "ShippingDetails": [
      {
        "Index": 1
      },
      {
        "Index": 1
      }
    ],
    "ListingImages": [
      {
        "ImageFileName": "sample string 1",
        "ImageKey": "sample string 2"
      },
      {
        "ImageFileName": "sample string 1",
        "ImageKey": "sample string 2"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfclsListing xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <clsListing>
    <Auto_Relist>true</Auto_Relist>
    <Category>
      <AdditionalIdentifier>sample string 6</AdditionalIdentifier>
      <CategoryID>sample string 1</CategoryID>
      <CategoryLevel>2</CategoryLevel>
      <CategoryName>sample string 4</CategoryName>
      <CategoryParentID>sample string 3</CategoryParentID>
      <CategorySource>eBay</CategorySource>
      <ItemSpecifics>
        <clsItemSpecifics>
          <SpecificsName>sample string 3</SpecificsName>
          <Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </Values>
          <MaxSelected>2</MaxSelected>
          <MinSelected>1</MinSelected>
          <SelectionMode>SelectionOnly</SelectionMode>
          <ValueType i:nil="true" />
        </clsItemSpecifics>
        <clsItemSpecifics>
          <SpecificsName>sample string 3</SpecificsName>
          <Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </Values>
          <MaxSelected>2</MaxSelected>
          <MinSelected>1</MinSelected>
          <SelectionMode>SelectionOnly</SelectionMode>
          <ValueType i:nil="true" />
        </clsItemSpecifics>
      </ItemSpecifics>
      <LeafCategory>true</LeafCategory>
    </Category>
    <CountryCode>sample string 10</CountryCode>
    <CurrencyCode>sample string 9</CurrencyCode>
    <DateCreatedLocally>2024-05-03T07:08:03.2868753+01:00</DateCreatedLocally>
    <DateListedExternally>2024-05-03T07:08:03.2868753+01:00</DateListedExternally>
    <EskimoID>1</EskimoID>
    <ExternalID>sample string 2</ExternalID>
    <ItemCondition>New</ItemCondition>
    <ItemDescription>sample string 6</ItemDescription>
    <ItemSpecifics>
      <clsItemSpecificsBasic>
        <SpecificsName>sample string 1</SpecificsName>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Values>
      </clsItemSpecificsBasic>
      <clsItemSpecificsBasic>
        <SpecificsName>sample string 1</SpecificsName>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Values>
      </clsItemSpecificsBasic>
    </ItemSpecifics>
    <ListingDuration>ThreeDays</ListingDuration>
    <ListingImages>
      <clsListingImage>
        <ImageFileName>sample string 1</ImageFileName>
        <ImageKey>sample string 2</ImageKey>
      </clsListingImage>
      <clsListingImage>
        <ImageFileName>sample string 1</ImageFileName>
        <ImageKey>sample string 2</ImageKey>
      </clsListingImage>
    </ListingImages>
    <ListingType>eBay</ListingType>
    <Listing_Format>Auction</Listing_Format>
    <MaxDispatchTime>SameWorkingDay</MaxDispatchTime>
    <Returns_Accepted>true</Returns_Accepted>
    <ShippingDetails>
      <clsListingShipping>
        <Index>1</Index>
      </clsListingShipping>
      <clsListingShipping>
        <Index>1</Index>
      </clsListingShipping>
    </ShippingDetails>
    <Title>sample string 5</Title>
    <Variations>
      <clsVariation>
        <Attributes>
          <clsVariationDetail>
            <OptionName>sample string 1</OptionName>
            <Value>sample string 2</Value>
            <VariationImages>
              <clsListingImage>
                <ImageFileName>sample string 1</ImageFileName>
                <ImageKey>sample string 2</ImageKey>
              </clsListingImage>
              <clsListingImage>
                <ImageFileName>sample string 1</ImageFileName>
                <ImageKey>sample string 2</ImageKey>
              </clsListingImage>
            </VariationImages>
          </clsVariationDetail>
          <clsVariationDetail>
            <OptionName>sample string 1</OptionName>
            <Value>sample string 2</Value>
            <VariationImages>
              <clsListingImage>
                <ImageFileName>sample string 1</ImageFileName>
                <ImageKey>sample string 2</ImageKey>
              </clsListingImage>
              <clsListingImage>
                <ImageFileName>sample string 1</ImageFileName>
                <ImageKey>sample string 2</ImageKey>
              </clsListingImage>
            </VariationImages>
          </clsVariationDetail>
        </Attributes>
        <EANCode>sample string 3</EANCode>
        <Price>2</Price>
        <QtyOffered>4</QtyOffered>
        <SKU>sample string 1</SKU>
      </clsVariation>
      <clsVariation>
        <Attributes>
          <clsVariationDetail>
            <OptionName>sample string 1</OptionName>
            <Value>sample string 2</Value>
            <VariationImages>
              <clsListingImage>
                <ImageFileName>sample string 1</ImageFileName>
                <ImageKey>sample string 2</ImageKey>
              </clsListingImage>
              <clsListingImage>
                <ImageFileName>sample string 1</ImageFileName>
                <ImageKey>sample string 2</ImageKey>
              </clsListingImage>
            </VariationImages>
          </clsVariationDetail>
          <clsVariationDetail>
            <OptionName>sample string 1</OptionName>
            <Value>sample string 2</Value>
            <VariationImages>
              <clsListingImage>
                <ImageFileName>sample string 1</ImageFileName>
                <ImageKey>sample string 2</ImageKey>
              </clsListingImage>
              <clsListingImage>
                <ImageFileName>sample string 1</ImageFileName>
                <ImageKey>sample string 2</ImageKey>
              </clsListingImage>
            </VariationImages>
          </clsVariationDetail>
        </Attributes>
        <EANCode>sample string 3</EANCode>
        <Price>2</Price>
        <QtyOffered>4</QtyOffered>
        <SKU>sample string 1</SKU>
      </clsVariation>
    </Variations>
  </clsListing>
  <clsListing>
    <Auto_Relist>true</Auto_Relist>
    <Category>
      <AdditionalIdentifier>sample string 6</AdditionalIdentifier>
      <CategoryID>sample string 1</CategoryID>
      <CategoryLevel>2</CategoryLevel>
      <CategoryName>sample string 4</CategoryName>
      <CategoryParentID>sample string 3</CategoryParentID>
      <CategorySource>eBay</CategorySource>
      <ItemSpecifics>
        <clsItemSpecifics>
          <SpecificsName>sample string 3</SpecificsName>
          <Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </Values>
          <MaxSelected>2</MaxSelected>
          <MinSelected>1</MinSelected>
          <SelectionMode>SelectionOnly</SelectionMode>
          <ValueType i:nil="true" />
        </clsItemSpecifics>
        <clsItemSpecifics>
          <SpecificsName>sample string 3</SpecificsName>
          <Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </Values>
          <MaxSelected>2</MaxSelected>
          <MinSelected>1</MinSelected>
          <SelectionMode>SelectionOnly</SelectionMode>
          <ValueType i:nil="true" />
        </clsItemSpecifics>
      </ItemSpecifics>
      <LeafCategory>true</LeafCategory>
    </Category>
    <CountryCode>sample string 10</CountryCode>
    <CurrencyCode>sample string 9</CurrencyCode>
    <DateCreatedLocally>2024-05-03T07:08:03.2868753+01:00</DateCreatedLocally>
    <DateListedExternally>2024-05-03T07:08:03.2868753+01:00</DateListedExternally>
    <EskimoID>1</EskimoID>
    <ExternalID>sample string 2</ExternalID>
    <ItemCondition>New</ItemCondition>
    <ItemDescription>sample string 6</ItemDescription>
    <ItemSpecifics>
      <clsItemSpecificsBasic>
        <SpecificsName>sample string 1</SpecificsName>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Values>
      </clsItemSpecificsBasic>
      <clsItemSpecificsBasic>
        <SpecificsName>sample string 1</SpecificsName>
        <Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Values>
      </clsItemSpecificsBasic>
    </ItemSpecifics>
    <ListingDuration>ThreeDays</ListingDuration>
    <ListingImages>
      <clsListingImage>
        <ImageFileName>sample string 1</ImageFileName>
        <ImageKey>sample string 2</ImageKey>
      </clsListingImage>
      <clsListingImage>
        <ImageFileName>sample string 1</ImageFileName>
        <ImageKey>sample string 2</ImageKey>
      </clsListingImage>
    </ListingImages>
    <ListingType>eBay</ListingType>
    <Listing_Format>Auction</Listing_Format>
    <MaxDispatchTime>SameWorkingDay</MaxDispatchTime>
    <Returns_Accepted>true</Returns_Accepted>
    <ShippingDetails>
      <clsListingShipping>
        <Index>1</Index>
      </clsListingShipping>
      <clsListingShipping>
        <Index>1</Index>
      </clsListingShipping>
    </ShippingDetails>
    <Title>sample string 5</Title>
    <Variations>
      <clsVariation>
        <Attributes>
          <clsVariationDetail>
            <OptionName>sample string 1</OptionName>
            <Value>sample string 2</Value>
            <VariationImages>
              <clsListingImage>
                <ImageFileName>sample string 1</ImageFileName>
                <ImageKey>sample string 2</ImageKey>
              </clsListingImage>
              <clsListingImage>
                <ImageFileName>sample string 1</ImageFileName>
                <ImageKey>sample string 2</ImageKey>
              </clsListingImage>
            </VariationImages>
          </clsVariationDetail>
          <clsVariationDetail>
            <OptionName>sample string 1</OptionName>
            <Value>sample string 2</Value>
            <VariationImages>
              <clsListingImage>
                <ImageFileName>sample string 1</ImageFileName>
                <ImageKey>sample string 2</ImageKey>
              </clsListingImage>
              <clsListingImage>
                <ImageFileName>sample string 1</ImageFileName>
                <ImageKey>sample string 2</ImageKey>
              </clsListingImage>
            </VariationImages>
          </clsVariationDetail>
        </Attributes>
        <EANCode>sample string 3</EANCode>
        <Price>2</Price>
        <QtyOffered>4</QtyOffered>
        <SKU>sample string 1</SKU>
      </clsVariation>
      <clsVariation>
        <Attributes>
          <clsVariationDetail>
            <OptionName>sample string 1</OptionName>
            <Value>sample string 2</Value>
            <VariationImages>
              <clsListingImage>
                <ImageFileName>sample string 1</ImageFileName>
                <ImageKey>sample string 2</ImageKey>
              </clsListingImage>
              <clsListingImage>
                <ImageFileName>sample string 1</ImageFileName>
                <ImageKey>sample string 2</ImageKey>
              </clsListingImage>
            </VariationImages>
          </clsVariationDetail>
          <clsVariationDetail>
            <OptionName>sample string 1</OptionName>
            <Value>sample string 2</Value>
            <VariationImages>
              <clsListingImage>
                <ImageFileName>sample string 1</ImageFileName>
                <ImageKey>sample string 2</ImageKey>
              </clsListingImage>
              <clsListingImage>
                <ImageFileName>sample string 1</ImageFileName>
                <ImageKey>sample string 2</ImageKey>
              </clsListingImage>
            </VariationImages>
          </clsVariationDetail>
        </Attributes>
        <EANCode>sample string 3</EANCode>
        <Price>2</Price>
        <QtyOffered>4</QtyOffered>
        <SKU>sample string 1</SKU>
      </clsVariation>
    </Variations>
  </clsListing>
</ArrayOfclsListing>