Inventory


GET partialProducts

The GET partialProducts request allows the developer retrieve stock and price data from their Volo intenvory.

Request

Parameters Description Values Mandatory
excludeListingSKUs Allows the user to define whether Listing SKUs are returned in the response true or false Optional
excludeProductsWithOutStockNumber Used to filter against products with or without a NULL value for the stocknumber field true or false Optional
includeDiscontinuedItems Used to filter against products that are or aren't flagged as discontinued true or false Optional
listedOnAmazon Used to filter against products that are currently active or inactive on any Amazon site true or false Optional
listedOneBay Used to filter against products that are currently active or inactive on any eBay site true or false Optional
listedOnPlay Used to filter against products that are currently active or inactive on any Play site true or false Optional
listedOnWebsite Used to filter against products that are currently active or inactive on any Website true or false Optional
stockNumber Used to request data for a certain product string Optional

Example Request

GET https://mydomain.esellerpro.com/eSellerProAPI/services/api/rs/partialProducts?StockNumber=0-528-00276-7

Response

Name Description Type
Stocknumber The stock number of the product(s) request String
StockLevel Combined stock level in all locations for the requested product int
CostPrice The cost price of the product(s) request Double
Price The price fields that are greater than 0 in Volo for the request product(s). This will return values nested within the prices parameter Double

Example Response

{
   "responseStatus": "OK",
   "responseMessage": null,
   "timestamp": 1434714212455,
   "PartialProducts": {"PartialProduct": [   {
      "StockNumber": "0-528-00276-7",
      "prices": {"Price":       [
                  {
            "Name": "RRP",
            "Value": 40,
            "AccountName": null
         },
                  {
            "Name": "EBAY_INVENTORY_PRICE",
            "Value": 1234,
            "AccountName": null
         }
      ]},
      "StockLevel": 391,
      "CostPrice": 125
   }]},
   "PaginationResult":    {
      "TotalNumberOfPages": 1,
      "TotalNumberOfEntries": 1
   }
}


GET stockLevels

The GET stockLevels request allows the developer retrieve stock and price data from their Volo intenvory. Although the request parameters are the same for the GET partialProducts reqest, the response will prodive stock level data per marketplace.

Request

Parameters Description Values Mandatory
excludeListingSKUs Allows the user to define whether Listing SKUs are returned in the response true or false Optional
excludeProductsWithOutStockNumber Used to filter against products with or without a NULL value for the stocknumber field true or false Optional
includeDiscontinuedItems Used to filter against products that are or aren't flagged as discontinued true or false Optional
listedOnAmazon Used to filter against products that are currently active or inactive on any Amazon site true or false Optional
listedOneBay Used to filter against products that are currently active or inactive on any eBay site true or false Optional
listedOnPlay Used to filter against products that are currently active or inactive on any Play site true or false Optional
listedOnWebsite Used to filter against products that are currently active or inactive on any Website true or false Optional
stockNumber Used to request data for a certain product string Optional

Example Request

GET https://mydomain.esellerpro.com/eSellerProAPI/services/api/rs/stockLevel.json?StockNumber=0-528-00276-7&ListedOnWebSite=true&EntriesPerPage=1&PageNumber=1

Response

Name Description Type
Stocknumber The stock number of the product(s) request String
OnHand The number of stock units currently held in the warehouse. Int
Available The number of stock units currently held in the warehouse which are not allocated to open orders and are not located within a virtual or non-pickable location. Int
Listed A nested element providing data of how many products are listed on each individual marketplace. e.g. { "Channel": "eBay", "Quantity": 120 } Varchar/Double

Example Response

{
   "responseStatus": "OK",
   "responseMessage": null,
   "timestamp": 1436178106156,
   "ProductStockLevels": {"ProductStockLevel": [   {
      "StockNumber": "0-528-00276-7",
      "OnHand": 391,
      "Available": 351,
      "Listed": {"ChannelListedQuantity":       [
                  {
            "Channel": "eBay",
            "Quantity": 391
         },
                  {
            "Channel": "Amazon",
            "Quantity": 195
         },
                  {
            "Channel": "Play",
            "Quantity": 0
         },
                  {
            "Channel": "Website",
            "Quantity": 391
         },
                  {
            "Channel": "PixPlace",
            "Quantity": 0
         },
                  {
            "Channel": "PriceMinister",
            "Quantity": 0
         },
                  {
            "Channel": "Tesco",
            "Quantity": 0
         }
      ]}
   }]},
   "PaginationResult":    {
      "TotalNumberOfPages": 1,
      "TotalNumberOfEntries": 1
   }
}


GET products

The products GET request paramters are exactly the same as the partialProduct request, but the response returns a much wider range of data.

Request

Parameters Description Values Mandatory
excludeListingSKUs Allows the user to define whether Listing SKUs are returned in the response true or false Optional
excludeProductsWithOutStockNumber Used to filter against products with or without a NULL value for the stocknumber field true or false Optional
includeDiscontinuedItems Used to filter against products that are or aren't flagged as discontinued true or false Optional
listedOnAmazon Used to filter against products that are currently active or inactive on any Amazon site true or false Optional
listedOneBay Used to filter against products that are currently active or inactive on any eBay site true or false Optional
listedOnPlay Used to filter against products that are currently active or inactive on any Play site true or false Optional
listedOnWebsite Used to filter against products that are currently active or inactive on any Website true or false Optional
stockNumber Used to request data for a certain product string Optional

Example Request

GET https://mydomain.esellerpro.com/eSellerProAPI/services/api/rs/products?StockNumber=0-528-00276-7

Response

Name Description Type
StockNumber The item stocknumber string
Title Inventory Title string
Subtitle eBay subtitle string
ListingTitle If null in Volo, will return the Title string
StockLevel Combined stock level in all locations int
RRP The RRP value double
Tax Code Tax code applied to the item int
Description(1-5) Product Description (HTML) Blob
CostPrice The cost price value double
Weight Value in grams int
Width Value in milimetres int
Height Value in milimetres int
Depth (mm) Value in milimetres int
UPC The barcode value int
Notes The supplier assigned to the item string

Example Response

{
   "responseStatus": "OK",
   "responseMessage": null,
   "timestamp": 1434720989221,
   "Product": [   {
      "StockNumber": "0-528-00276-7",
      "Title": "5\" Gps Soft Case",
      "Subtitle": "",
      "ListingTitle": "RAND MCNALLY 0-528-00276-7 4.3\" & 5\" GPS Soft Case",
      "StockLevel": 391,
      "RRP": 40,
      "CostPrice": 125,
      "TaxCode": "S",
      "Description": "<html>\n  <head>\n    \n  <\/head>\n\n  <body>\n    ? Fits both 4.3" & 5" GPS devices;? Made of durable neoprene for \n    long-lasting wear;? Compact & tear resistant soft-case;? Secure pocket \n    design;? Interior padding provides extra protection from scratches, \n    smudges & smears something\n  <\/body>\n\n<\/html>\n\n",
      "Description2": "<html>\n  <head>\n    \n  <\/head>\n\n  <body>\n    ? Fits both 4.3" & 5" GPS devices;? Made of durable neoprene for \n    long-lasting wear;? Compact & tear resistant soft-case;? Secure pocket \n    design;? Interior padding provides extra protection from scratches, \n    smudges & smears\n  <\/body>\n\n<\/html>\n\n",
      "Description3": "<html>\n  <head>\n    \n  <\/head>\n\n  <body>\n    ? Fits both 4.3" & 5" GPS devices;? Made of durable neoprene for \n    long-lasting wear;? Compact & tear resistant soft-case;? Secure pocket \n    design;? Interior padding provides extra protection from scratches, \n    smudges & smears\n  <\/body>\n\n<\/html>\n\n",
      "Description4": "<html>\n  <head>\n    \n  <\/head>\n\n  <body>\n    ? Fits both 4.3" & 5" GPS devices;? Made of durable neoprene for \n    long-lasting wear;? Compact & tear resistant soft-case;? Secure pocket \n    design;? Interior padding provides extra protection from scratches, \n    smudges & smears\n  <\/body>\n\n<\/html>\n\n",
      "Description5": "<html>\n  <head>\n    \n  <\/head>\n\n  <body>\n    ? Fits both 4.3" & 5" GPS devices;? Made of durable neoprene for \n    long-lasting wear;? Compact & tear resistant soft-case;? Secure pocket \n    design;? Interior padding provides extra protection from scratches, \n    smudges & smears\n  <\/body>\n\n<\/html>\n\n",
      "Weight":       {
         "unit": "g",
         "value": 0.3
      },
      "Width":       {
         "unit": "mm",
         "value": 0
      },
      "Height":       {
         "unit": "mm",
         "value": 0
      },
      "Depth":       {
         "unit": "mm",
         "value": 0
      },
      "UPC": "070609002767",
      "Notes": "",
      "Supplier": "RDY002767"
   }],
   "PaginationResult":    {
      "TotalNumberOfPages": 1,
      "TotalNumberOfEntries": 1
   }
}


PUT productsByField

This request allows the user to return specific data product relating to the requested inventory products. The fields defined in the OutPutField parameter must match the values listed in Maintenance > Export/Import Layout

Request

Parameters Description Values Mandatory
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 To define whether item active on any Amazon site are returned in the response Boolean Optional
listedOneBay To define whether item active on any eBay site are returned in the response Boolean Optional
listedOnPlay To define whether item active on any Play.com site are returned in the response Boolean Optional
listedOnWebsite To define whether item active on any Website (Volo or 3rd Party) are returned in the response Boolean 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 Allows the user to define whether Listing SKUs are returned in the response String Optional
OutPutFeild 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

<FullProductByFieldRequest>
   <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>
</FullProductByFieldRequest>

Response

The response depends on the data you have requested. Below is an example of each of the possible OutPutField types. The OutPutField element will return the field name, value and type in the response.

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. The format of this field is {CustomGroup:CustomField} string

Example Response

{
   "responseStatus": null,
   "responseMessage": null,
   "timestamp": 1436262052536,
   "fullProductByFieldResult":    {
      "PaginationResult":       {
         "TotalNumberOfPages": 1,
         "TotalNumberOfEntries": 1
      },
      "FullProductByField": [{"OutPutFields": {"OutPutField":       [
                  {
            "Name": "StockNumber",
            "value": "0-528-00276-7",
            "Type": null
         },
                  {
            "Name": "Title",
            "value": "5\" Gps Soft Case",
            "Type": null
         },
                  {
            "Name": "Image1",
            "value": "http://images.esellerpro.com/3461/I/119/86/newlogo.png",
            "Type": null
         },
                  {
            "Name": "Image2",
            "value": "http://images.esellerpro.com/3461/I/23/RDY002767.jpg",
            "Type": null
         },
                  {
            "Name": "Product Variations:Size",
            "value": "UK 14",
            "Type": null
         }
      ]}}]
   }
}


PUT partialProducts

This method allows the developer to update the stock level and prices of products by parsing XML.

Request

Parameters Description Values Mandatory
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

<PartialProductUpdates>
   <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>
</PartialProductUpdates>

Example Response

{
   "responseStatus": "OK",
   "responseMessage": "1 products were updated.",
   "timestamp": 1436255400229
}


POST 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 Mandatory
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. Value - The value of the import field String Requires

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