Asynchronous


updateProductsAsync

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
timestamp Timestamp for when the response was received. string
BatchID The batch ID of the request. This is required for making the getBatchStatus request. String
Update Type The update type of the request. This is will be "Update Products" string

Example Response

<return>
   <responseStatus>OK</responseStatus>
   <timestamp>2015-07-07T10:10:47.012+01:00</timestamp>
   <BatchId>A7BA3818-C480-4D8D-A7EB-567AAD47C786</BatchId>
   <UpdateType>Update Products</UpdateType>
</return>


updateOrdersAsync

The updateOrders request allows you to update an order in a number of ways. Depending on the parameters used in the request, it's possible to update the order status, add courier and/or tracking information or simply add notes.

Request

Parameters Description Type Required/Optional
ESPOrderNo The Volo order number to update Int Required
OrderStatus Update the order to the defined status. Accepted values are; WAITING_FOR_DELIVERY, DELIVERED, CANCELLED or ON_HOLD String Optional
OnHoldNotes Updates the order status to 'On Hold' and adds an 'On Hold' reason to the order. String Optional
Courier Adds the courier name when the order is marked as delivered. The courier must be available within the 'Courier' dropdown list within the Sales Orders > Order Processing screen. String Optional
CourierService Not currently in use. String Optional
CourierTracking Used to specificy the tracking number for the order. String Optional
Notes Used to add notes internal to orders. String Optional

Example Request

<arg0>
   <OrderUpdate>
      <ESPOrderNo>5381</ESPOrderNo>
      <OrderStatus>DELIVERED</OrderStatus>
      <Courier>Hermes</Courier>
      <CourierTracking>AS12716454YT</CourierTracking>
      <Notes>Marked as shipped</Notes>
   </OrderUpdate>
</arg0>

Response

Name Description Type
timestamp Timestamp for when the response was received. string
BatchID The batch ID of the request. This is required for making the getBatchStatus request. String
Update Type The update type of the request. This is will be "UPDATE_ORDERS" string

Example Response

<return>
   <BatchId>E5DFFB25-0DEC-4840-8137-9DF30EDDC133</BatchId>
   <Status>SUBMITTED</Status>
   <UpdateType>UPDATE_ORDERS</UpdateType>
</return>


getBatchStatus

Request

Parameters Description Type Mandatory
batchId The batchID you would like to view the status of. String Required

Example Request

<arg0>A7BA3818-C480-4D8D-A7EB-567AAD47C786</arg0>

Response

Name Description Type
UpdateResponseEntry A nested element containing ID (which is either the ESPOrderNumber or StockNumber depending on what you have updated) and Status. String
Status The status of the request. The retuned values are 'SUBMITTED' or'PROCESSED'. string
UpdateType The request type. The retuned values are either 'UPDATE_PRODUCTS' or 'UPDATE_ORDERS'. string

Example Response for a submitted but not yet complete update

<return>
   <BatchId>E5DFFB25-0DEC-4840-8137-9DF30EDDC133</BatchId>
   <Status>SUBMITTED</Status>
   <UpdateType>UPDATE_ORDERS</UpdateType>
</return>

Example Response for an updateOrders batch

<return>
   <BatchId>E5DFFB25-0DEC-4840-8137-9DF30EDDC133</BatchId>
   <UpdateResponseEntries>
      <UpdateResponseEntry ID="5381" Status="SUCCESS" />
   </UpdateResponseEntries>
   <UpdateType>UPDATE_ORDERS</UpdateType>
</return>

Example Response for an updateProducts batch

<return>
   <BatchId>A7BA3818-C480-4D8D-A7EB-567AAD47C786</BatchId>
   <UpdateResponseEntries>
      <UpdateResponseEntry ID="0-528-00276-7" Status="SUCCESS" />
      <UpdateResponseEntry ID="0-528-00278-3" Status="SUCCESS" />
   </UpdateResponseEntries>
   <Status>PROCESSED</Status>
   <UpdateType>UPDATE_PRODUCTS</UpdateType>
</return>