This page is intended to be printed.

Doba Partner 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 Request Parameters

getSuppliers Response Parameters


searchCatalog Request Parameters

searchCatalog Response Parameters


getProductDetail Request Parameters

getProductDetail Response Parameters


getProductInventory Request Parameters

getProductInventory Response Parameters


getListsSummary Request Parameters

getListsSummary Response Parameters


getListItems Request Parameters

getListItems Response Parameters


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 Request Parameters

orderLookup Response Parameters


createOrder Request Parameters

createOrder Response Parameters


fundOrder Request Parameters

fundOrder Response Parameters


getOrderDetail Request Parameters

getOrderDetail Response Parameters


getOrders Request Parameters

getOrders Response Parameters




Retailer API

The Retailer API allows you to create and manage retailer accounts within the Doba system.



getRetailers Request Parameters

getRetailers Response Parameters


addRetailer Request Parameters

addRetailer Response Parameters


upgradeRetailer Request Parameters

upgradeRetailer Response Parameters


reactivateRetailer Request Parameters

reactivateRetailer Response Parameters


getRetailerAccessInfo Request Parameters

getRetailerAccessInfo Response Parameters


getPasswordResetLink Request Parameters

getPasswordResetLink Response Parameters


requestPartnerPermission Request Parameters

requestPartnerPermission Response Parameters


hasPartnerPermission Request Parameters

hasPartnerPermission Response Parameters


removePartnerPermission Request Parameters

removePartnerPermission Response Parameters


createRetailerNote Request Parameters

createRetailerNote Response Parameters


cancelRetailer Request Parameters

cancelRetailer Response Parameters


getAutoLoginLink Request Parameters

getAutoLoginLink Response Parameters





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


Retailer/Partner Permission Acceptance

If an existing Doba retailer wants to utilize your system you must "link" the retailers account to your API account. Your system will need to request authorization from the retailer to make calls on their behalf by utilizing the requestPartnerPermission API method.

The data contained in the callback is identical to the data received via the hasPartnerPermission API Method.

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:

Watchlist Updates

Watchlist changes will be delivered to your system whenever a watchlist is added or deleted or renamed or the send_callback option is updated.

The callback will contain the latest changes to the callback since the last callback. All changes are logged and sent in batches.

Possible events are:

The data contained in the callback is identical to the data received via the getWatchlists API method, except for the addition of the event tag information contained in the callback.

Watchlist Product Updates

Watchlist product changes will be delivered to your system whenever an item is added to, or deleted from, a watchlist.

Only one callback will be returned per watchlist. If two different watchlists are updated you will receive two callbacks.

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

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.

Status Updates

The Retailer Status Updates provides the partner with updated information on the current status of the customer.

The status information is broken down into 2 groups: Tasks & Purchases

Current Task Indicators:

Current Purchase Indicators: