Inventory


getFullProductsByField

The getFullProductsByField method allows you to determine the field you want returned and in what order.

Request

Parameters Description Values Required/Optional
excludeListingSKUs To define whether Listing SKUs are returned in the response Boolean Optional
excludeProductsWithOutStockNumber Provides the functionality to return stock numbers that have a blank stock number Boolean Optional
includeDiscontinuedItems To define whether discontinued items are returned in the response Boolean Optional
listedOnAmazon Include or exclude items that have quantity > 0 in the Amazon column within Volo True, false Optional
listedOneBay Include or exclude items that have quantity > 0 in the Inventory column within Volo True, false Optional
listedOnPlay Include or exclude items that have quantity > 0 in the Play.com column within Volo True, false Optional
listedOnWebsite Include or exclude items that have quantity > 0 in the Website column within Volo. If you have more than one website this paramter looks across all of them. True, false Optional
EntriesPerPage To define the number of SKUs returned per page Int Optional
PageNumber Used in conjunction with the EntriesPerPage parameter to define the page number of the returned results. E.g. EntriesPerPage = 10, PageNumber = 7 will return items 61 - 70 Int Optional
stockNumber To return the results from a specific stock number String Optional
OutPutField Allows the creation of a custom layout. Use the "Name" attribute to define the return field (field names match those defined in Maintenance > Custom Export/Import Layout). Use the "Type" to return images and custom fields. Accepted values for the "Type" attribute are "IMAGE" and "CUSTOM FIELD". String Optional

Example Request

<arg0>
   <SearchCriteria>
      <stockNumber>0-528-00276-7</stockNumber>
   </SearchCriteria>
   <OutPutFields>
      <OutPutField Name="StockNumber" />
      <OutPutField Name="Title" />
      <OutPutField Name="Image1" Type="IMAGE_FIELD" />
      <OutPutField Name="Image2" Type="IMAGE_FIELD" />
      <OutPutField Name="Product Variations:Size" Type="CUSTOM_FIELD" />
   </OutPutFields>
</arg0>

Response

The response depends on the data you have requested. Below is an example of each of the possible OutPutField types.

Name Description Type
Stocknumber Item stock number string
Title Inventory Title string
Image1 1st product image string
Image2 2nd product image string
Product Variations:Size Custom field data string

Example Response

<return>
   <timestamp>2015-07-06T12:10:14.261+01:00</timestamp>
   <fullProductByFieldResult>
      <FullProductByField>
         <OutPutFields>
            <OutPutField Name="StockNumber">0-528-00276-7</OutPutField>
            <OutPutField Name="Title">5" Gps Soft Case</OutPutField>
            <OutPutField Name="Image1">http://images.esellerpro.com/3461/I/119/86/newlogo.png</OutPutField>
            <OutPutField Name="Image2">http://images.esellerpro.com/3461/I/23/RDY002767.jpg</OutPutField>
            <OutPutField Name="Product Variations:Size">UK 14</OutPutField>
         </OutPutFields>
      </FullProductByField>
      <PaginationResult>
         <TotalNumberOfEntries>1</TotalNumberOfEntries>
         <TotalNumberOfPages>1</TotalNumberOfPages>
      </PaginationResult>
   </fullProductByFieldResult>
</return>


getPartialProducts

This method returns a partial subset of product data.

Request

Parameters Description Values Required/Optional
excludeListingSKUs To define whether Listing SKUs are returned in the response Boolean Optional
excludeProductsWithOutStockNumber Provides the functionality to return stock numbers that have a blank stock number Boolean Optional
includeDiscontinuedItems To define whether discontinued items are returned in the response Boolean Optional
listedOnAmazon Include or exclude items that have quantity > 0 in the Amazon column within Volo True, false Optional
listedOneBay Include or exclude items that have quantity > 0 in the Inventory column within Volo True, false Optional
listedOnPlay Include or exclude items that have quantity > 0 in the Play.com column within Volo True, false Optional
listedOnWebsite Include or exclude items that have quantity > 0 in the Website column within Volo. If you have more than one website this paramter looks across all of them. True, false Optional
stockNumber Defined stock number of the item Valied Volo stock number Required

Example Request

<arg0>
  <stockNumber>0-528-00276-7</stockNumber>
</arg0>

Response

Name Description Type
Stocknumber Item stock number string
RRP Item RRP price (2.dp)
eBay Inventory Price The price set in the eBay inventory price field price (2.dp)
StockLevel Combined stock level in all locations int
CostPrice Item Cost Price price (2.dp)

Example Response

<return>
  <responseStatus>OK</responseStatus>
  <timestamp>2015-06-18T12:42:21.883+01:00</timestamp>
  <PaginationResult>
    <TotalNumberOfEntries>1</TotalNumberOfEntries>
    <TotalNumberOfPages>1</TotalNumberOfPages>
  </PaginationResult>
  <PartialProducts>
    <PartialProduct>
      <StockNumber>0-528-00276-7</StockNumber>
      <prices>
        <Price>
          <Name>RRP</Name>
          <Value>40</Value>
        </Price>
        <Price>
          <Name>EBAY_INVENTORY_PRICE</Name>
          <Value>1234</Value>
        </Price>
      </prices>
      <StockLevel>391</StockLevel>
      <CostPrice>125.0</CostPrice>
    </PartialProduct>
  </PartialProducts>
</return>


getProducts

This method returns a more comprehensive set of product data.

Request

Parameters Description Values Required/Optional
excludeListingSKUs To define whether Listing SKUs are returned in the response Boolean Optional
excludeProductsWithOutStockNumber Provides the functionality to return stock numbers that have a blank stock number Boolean Optional
includeDiscontinuedItems To define whether discontinued items are returned in the response Boolean Optional
listedOnAmazon Include or exclude items that have quantity > 0 in the Amazon column within Volo True, false Optional
listedOneBay Include or exclude items that have quantity > 0 in the Inventory column within Volo True, false Optional
listedOnPlay Include or exclude items that have quantity > 0 in the Play.com column within Volo True, false Optional
listedOnWebsite Include or exclude items that have quantity > 0 in the Website column within Volo. If you have more than one website this paramter looks across all of them. True, false Optional
stockNumber To return the results from a specific stock number String Optional

Example Request

<arg0>
  <listedOnEbay>true</listedOnEbay>
</arg0>

Response

Name Description Type
Stocknumber Item stock number string
Title Inventory Title string
Subtitle eBay subtitle string
ListingTitle eBay Listing Title string
StockLevel combined stock level in all locations int
RRP Item RRP price (2.dp)
Tax Code Tax codea applied to the item int
Description(1-5) Product Description (HTML) Blob
CostPrice Item Cost Price price (2.dp)
Weight (g) Item weight in grams int
Width (mm) Item width in millimeters int
Height (mm) Item height in millimeters int
Depth (mm) Item depth in millimeters int
UPC/barcode Item Barcode int
Supplier Default Item Supplier string

Example Response

<return>
  <responseStatus>OK</responseStatus>
  <timestamp>2015-06-29T14:21:06.355+01:00</timestamp>
  <PaginationResult>
    <TotalNumberOfEntries>1</TotalNumberOfEntries>
    <TotalNumberOfPages>1</TotalNumberOfPages>
  </PaginationResult>
  <Product>
    <StockNumber>0-528-00374-7</StockNumber>
    <Title>Gps Traffic Receiver</Title>
    <Subtitle/>
    <ListingTitle>RAND MCNALLY 0-528-00374-7 Real-Time Traffic Receiver</ListingTitle>
    <StockLevel>39</StockLevel>
    <RRP>0.0</RRP>
    <CostPrice>52.99</CostPrice>
    <TaxCode>S</TaxCode>
    <Description>
      <![CDATA[<html>
        <body>
        Description 1 Provides up-to-the-minute traffic information on 
        construction, traffic speeds & accidents;? Compatible with IntelliRoute(R) 
        TND(TM) 510, 710 & TripMaker(R) RVND(TM) 5510 & 7710;? Kit includes 
        antenna cable with multiple suction cups to extend receiver's range;? 
        Lifetime traffic subscription to NAVTEQ(R);? Step-by-step instructions 
        with detailed drawings & screen shots for simple installation
        </body>
      </html>]]>
    </Description>
    <Description2>
      <![CDATA[<html><body>Description 2</body></html>]]>
    </Description2>
    <Description3>
      <![CDATA[<html><body>Description 3</body></html>]]>
    </Description3>
    <Description4>
      <![CDATA[<html><body>Description 4</body></html>]]>
    </Description4>
    <Description5>
      <![CDATA[<html><body>Description 5</body></html>]]>
    </Description5>
    <Weight unit="g">0.25</Weight>
    <Width unit="mm">5.0</Width>
    <Height unit="mm">0.0</Height>
    <Depth unit="mm">0.0</Depth>
    <UPC>070609003740</UPC>
    <Notes/>
    <Supplier>RDY003747</Supplier>
  </Product>
</return>


getProductStockLevels

This method returns product stock levels and the amount listed on individual channels.

Request

Parameters Description Values Required/Optional
excludeProductsWithOutStockNumber Allows the user to define whether Listing SKUs are returned in the response (to return all SKUs, set this value to 1) True, false Optional
excludeListingSKUs include or exclude listing SKUs in return True, false Optional
includeDiscontinuedItems Include or exclude discontined items in return True, false Optional
listedOnAmazon Include or exclude items that have quantity > 0 in the Amazon column within Volo True, false Optional
listedOneBay Include or exclude items that have quantity > 0 in the Inventory column within Volo True, false Optional
listedOnPlay Include or exclude items that have quantity > 0 in the Play.com column within Volo True, false Optional
listedOnWebsite Include or exclude items that have quantity > 0 in the Website column within Volo. If you have more than one website this paramter looks across all of them. True, false Optional
stockNumber Defined stock number of the item Valied Volo stock number Required

Example Request

<arg0>
   <listedOnWebsite>true</listedOnWebsite>
</arg0>

Response

Name Description Type
Stocknumber The stock number of the item string
OnHand The OnHand stock level string
Available The available stock level string
ChannelListedQuantity Nested tag containing the Channel and the amount listed. string

Example Response

<return>
   <responseStatus>OK</responseStatus>
   <timestamp>2015-07-06T14:53:15.731+01:00</timestamp>
   <PaginationResult>
      <TotalNumberOfEntries>12</TotalNumberOfEntries>
      <TotalNumberOfPages>1</TotalNumberOfPages>
   </PaginationResult>
   <ProductStockLevels>
      <ProductStockLevel>
         <StockNumber>0-528-00276-7</StockNumber>
         <OnHand>391</OnHand>
         <Available>351</Available>
         <Listed>
            <ChannelListedQuantity>
               <Channel>eBay</Channel>
               <Quantity>0</Quantity>
            </ChannelListedQuantity>
            <ChannelListedQuantity>
               <Channel>Amazon</Channel>
               <Quantity>0</Quantity>
            </ChannelListedQuantity>
            <ChannelListedQuantity>
               <Channel>Play</Channel>
               <Quantity>0</Quantity>
            </ChannelListedQuantity>
            <ChannelListedQuantity>
               <Channel>Website</Channel>
               <Quantity>391</Quantity>
            </ChannelListedQuantity>
            <ChannelListedQuantity>
               <Channel>PixPlace</Channel>
               <Quantity>0</Quantity>
            </ChannelListedQuantity>
            <ChannelListedQuantity>
               <Channel>PriceMinister</Channel>
               <Quantity>0</Quantity>
            </ChannelListedQuantity>
            <ChannelListedQuantity>
               <Channel>Tesco</Channel>
               <Quantity>0</Quantity>
            </ChannelListedQuantity>
         </Listed>
      </ProductStockLevel>
   </ProductStockLevels>
</return>


importProducts

This method will give the requested product fields in the same way as the custom import, as performed within the Volo. It allows for any of the fields that can be imported via the GUI, to be imported via XML – but note that the format of field names must be exactly as shown in the ‘Standard Field’ dropdown. It falls into 2 sections – Layout and Import data. By default, every field in the imported layout will be updateable. The importProducts call is limited to 1000 products per request.

Request

Parameters Description Values Required/Optional
LayoutName The name of the layout to be imported. String Required
LayoutFields The requested fields. Name = The name of the field. The available fields can be found in Volo within Maintenance > Export/Import layout. Type = The type of field. Either IMAGE_FIELD, CUSTOM_FIELD or MANDATORY. StockNumber must be present. String Required
SellerCentral[Sub]Category If the user wants to import Amazon category-specific data, this (and the sub category field) are both mandatory fields. The field supports the new Amazon category format, i.e. with a dot after the value (e.g. Apparel.).Only Amazon category/sub category details entered in these two fields will be imported – all others will be ignored. String Optional
ImportFields The requested fields. Name = The name of the field. The available fields can be found in Volo within Maintenance > Export/Import layout. Type = The type of field. Either IMAGE_FIELD, CUSTOM_FIELD or MANDATORY. String Requires

Example Response

<arg0>
   <Layout>
      <LayoutName>TestLayout</LayoutName>
      <LayoutFields>
         <LayoutField Name="StockNumber" />
         <LayoutField Name="Title" />
         <LayoutField Name="Amazon1(amazon.co.uk).CSD_Department2" />
         <LayoutField Name="Amazon1(amazon.co.uk).CSD_StyleName" />
      </LayoutFields>
      <SellerCentralCategory>Apparel.</SellerCentralCategory>
      <SellerCentralSubCategory>Apparel</SellerCentralSubCategory>
   </Layout>
    
   <ImportData>
      <ImportRow>
         <ImportField Name="StockNumber">12022014-17</ImportField>
         <ImportField Name="Title">Test Title1</ImportField>
         <ImportField Name="Amazon1(amazon.co.uk).CSD_Department2">Shirt</ImportField>
         <ImportField Name="Amazon1(amazon.co.uk).CSD_StyleName">Cape</ImportField>
      </ImportRow>
   </ImportData>
</arg0>

Response

Name Description Type
Stocknumber The stock number of the item string
OnHand The OnHand stock level string
Available The available stock level string
ChannelListedQuantity Nested tag containing the Channel and the amount listed. string

Example Response

<return>
   <ImportResult>
      <LayoutName>TestLayout</LayoutName>
      <KeyField>StockNumber</KeyField>
      <TotalRecordsSent>1</TotalRecordsSent>
      <TotalRecordsInserted>1</TotalRecordsInserted>
      <TotalRecordsUpdated>0</TotalRecordsUpdated>
      <TotalRecordsSkipped>0</TotalRecordsSkipped>
   </ImportResult>
</return>


updateProducts

This method allows you to update the stock level and prices of products. You can choose to update the stock levels with an absoloute value or a delta value.

Request

Parameters Description Values Required/Optional
StockNumber Define stock number to update String Required
Price Name = {EBAY_BUY_NOW_PRICE, EBAY_INVENTORY_PRICE, RRP, AMAZON_PRICE, PLAY_PRICE} | Value = Value of price | AccountName = If setting Amazon Price, you can choose which Amazon account you are setting the price for by setting the AccountName here. String Optional
StockLevel Location = {name of location in Volo} | Quantity = Stock Level | StockUpdateType = {DELIVERY for delta values or STOCK_CHECK for absolute values} String | Int | String Optional
CostPrice Define a value to update the cost price of the specified item Double Optional

Example Request

<arg0>
   <ProductUpdate>
      <StockNumber>0-528-00276-7</StockNumber>
      <Prices>
         <Price>
            <Name>EBAY_BUY_NOW_PRICE</Name>
            <Value>10.99</Value>
         </Price>
      </Prices>
      <StockLevel>
         <Location>Warehouse</Location>
         <Quantity>47</Quantity>
         <StockUpdateType>DELIVERY</StockUpdateType>
      </StockLevel>
      <CostPrice>7.00</CostPrice>
   </ProductUpdate>
</arg0>

Response

Name Description Type
responseMessage The number of products that were updated successfully. string
responseStatus The status of the response. OK - shows if the response has been successful. ERROR - if this status shows, an accompanying message will give details string
timestamp Date and time of the response Date/time

Example Response

<return>
   <responseMessage>1 products were updated.</responseMessage>
   <responseStatus>OK</responseStatus>
   <timestamp>2015-07-06T15:24:09.577+01:00</timestamp>
</return>