There is a newer version of the API available. To link to the newest API documentation, click here - Version 20110301








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

getSuppliers Request Parameters

getSuppliers Response Parameters

getItemSearch

getItemSearch Request Parameters

getItemSearch Response Parameters

getProductDetail

getProductDetail Request Parameters

getProductDetail Response Parameters

getProductInventory

getProductInventory Request Parameters

getProductInventory Response Parameters

getWatchlists

getWatchlists Request Parameters

getWatchlists Response Parameters

getWatchlistProducts

getWatchlistProducts Request Parameters

getWatchlistProducts Response Parameters

editWatchlist

editWatchlist Request Parameters

editWatchlist 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 although status updates will be provided in real-time through callback's.

orderLookup

orderLookup request

orderLookup response

createOrder

createOrder request

createOrder response

fundOrder

fundOrder request

fundOrder response

getOrderDetail

getOrderDetail request

getOrderDetail response

getOrders

getOrders request

getOrders response

 

 

 

Retailer API

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

 

getRetailers

getRetailers request

getRetailers response

addRetailer

addRetailer request

addRetailer response

upgradeRetailer

upgradeRetailer request

upgradeRetailer response

There are no response fields for this method. Either the request is successful or it fails.

reactivateRetailer

reactivateRetailer request

reactivateRetailer response

There are no response fields for this method. Either the request is successful or it fails.

getRetailerAccessInfo

getRetailerAccessInfo request

getRetailerAccessInfo response

getPasswordResetLink

getPasswordResetLink request

getPasswordResetLink response

requestPartnerPermission

requestPartnerPermission request

requestPartnerPermission response

There is no response fields for this method. Either the request is successful or it fails. Failure is very rare as the only way this would happen is if there is a problem with the API system as a whole.

hasPartnerPermission

hasPartnerPermission request

hasPartnerPermission response

removePartnerPermission

removePartnerPermission request

removePartnerPermission response

There is no response fields for this method. Either the request is successful or it fails. Failure is very rare as the only way this would happen is if there is a problem with the API system as a whole.

createRetailerNote

createRetailerNote request

createRetailerNote response

There is no response fields for this method. Either the request is successful or it fails. Failure is very rare as the only way this would happen is if there is a problem with the API system as a whole.

cancelRetailer

cancelRetailer request

cancelRetailer response

There are no response fields for this method. Either the request is successful or it fails.

 

 

 

Callbacks

Callbacks are sent to the URL on file to notify your system of changes in order status, product status, etc. Callbacks are essential to keeping the end-user up to date with the most accurate information available to the Doba platform.

Refer to the Sandbox Web Site section for information regarding the callback URL.

Callbacks are sent as an HTTP POST to the callback URL stored in your account. In PHP, the XML data is contained in the $_POST['xml'] variable.

To ensure proper security for callback updates, you should only accept callbacks originating from IP address range of 64.58.224.x.

 

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.