This page is intended to be printed.

Doba Retailer API

Product API

Allows for the retrieval of on-demand and up-to-the-minute product data from the Doba platform.

These methods allow you to obtain product details, product inventory updates and search the Doba catalog.

getSuppliers

getSuppliers Request Parameters

getSuppliers Response Parameters

searchCatalog

searchCatalog Request Parameters

searchCatalog Response Parameters

getProductDetail

getProductDetail Request Parameters

getProductDetail Response Parameters

getProductInventory

getProductInventory Request Parameters

getProductInventory Response Parameters

getListsSummary

getListsSummary Request Parameters

getListsSummary Response Parameters

editList

editList Request Parameters

editList Response Parameters

 

 

 

 

Order API

Allows for the submittal of orders to the Doba platform as well as the retrieval of current order status and shipping/tracking data.

Orders submitted via the API can be funded directly within the API call using several different payment methods.

Current order status can be called at any time through the use of the getOrders and getOrderDetail methods.

orderLookup

orderLookup Request Parameters

orderLookup Response Parameters

createOrder

createOrder Request Parameters

createOrder Response Parameters

fundOrder

fundOrder Request Parameters

fundOrder Response Parameters

getOrderDetail

getOrderDetail Request Parameters

getOrderDetail Response Parameters

getOrders

getOrders Request Parameters

getOrders Response Parameters

 

 

 

Callbacks

The callbacks feature has been discontinued for this version of the API

 

Product/Inventory Updates

Product and inventory information can be automatically sent to your system whenever a supplier updates a product that is stored in the retailers watchlist.

The product update callbacks will utilize the XML response within the getProductDetail API method.

The inventory update callbacks will utilize the XML response within the getProductInventory API method.

In order to receive automicatic updates via callbacks, the following criteria must be meet:

Order Updates

Order updates will be delivered to your system whenever a funded order has been updated by the supplier.

The data contained in the callback is identical to the data received via the getOrderDetail API method.

When testing callbacks in the Sandbox environment the shipping information is automatically generated and the order status updates every 1-2 mintues after an order is funded.