Asynchronous


GET batch

The GET batch request allows the developer to view the status of the current asynchronous requests.

Request

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

Example Request

GET https://mydomain.esellerpro.com/eSellerProAPI/services/api/rs/batch/D034E4D0-4B76-4489-8338-C52E5145842C

Response

Name Description Type
UpdateResponseEntry A nested element containing ID, Status and Message. 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'ORDERS'. string

Example Response

{
   "BatchId": "D034E4D0-4B76-4489-8338-C52E5145842C",
   "UpdateResponseEntries": {"UpdateResponseEntry": [   {
      "ID": "000-10141-001",
      "Status": "SUCCESS",
      "Message": null
   }]},
   "Status": "PROCESSED",
   "UpdateType": "UPDATE_PRODUCTS"
}


PUT ordersAsync

The PUT ordersAsync request allows the developer to action specified orders 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. The request should be made by parsing XML.

Request

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

<IncomingOrdersUpdate>
   <OrderUpdate>
      <ESPOrderNo>5440</ESPOrderNo>
      <OrderStatus>DELIVERED</OrderStatus>
      <OnHoldNotes>test order deliver</OnHoldNotes>
      <CourierTracking>7723744fdfg4s4</CourierTracking>
      <Notes>api note</Notes>
   </OrderUpdate>
</IncomingOrdersUpdate>

Response

Name Description Type
timestamp An epoch value (ms since 01/01/1970 00:00:00). string
BatchID The batch ID of the request. This is required for making the GET batch request. String
Update Type The update type of the request. This is required for making the GET batch request. string

Example Response

{
   "responseStatus": "OK",
   "responseMessage": null,
   "timestamp": 1436194000077,
   "BatchId": "0663F856-9078-42A7-8B85-10A227971F1F",
   "UpdateType": "Update Orders"
}


PUT partialProductsAsync

The PUT partialProductsAsync request allows the developer retrieve stock and price data for a number of prodcts from their Volo intenvory.

Request

Parameters Description Type 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>

Response

Name Description Type
timestamp An epoch value (ms since 01/01/1970 00:00:00). string
BatchID The batch ID of the request. This is required for making the GET batch request. String
Update Type The update type of the request. This is required for making the GET batch request. string

Example Response

{
   "responseStatus": "OK",
   "responseMessage": null,
   "timestamp": 1436256062693,
   "BatchId": "F5144E47-6F66-41A1-8F04-DD97988D3B52",
   "UpdateType": "Update Products"
}