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

getBrands

getBrands Request Parameters

getBrands Response Parameters

getItemSearch

getItemSearch Request Parameters

getItemSearch 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.

 

addRetailer

addRetailer request

addRetailer response

getRetailerAccessInfo

getRetailerAccessInfo request

getRetailerAccessInfo 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 is 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 (Only Available to Partners)

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.

Below is an example of the data provided in a product callback update:

<?xml version="1.0"?>
<dce>
  <response>
    <outcome>success</outcome>
    <callback_type>hasPartnerPermission</callback_type>
    <has_permission>accepted</has_permission>
    <retailer_id>123</retailer_id>
  </response>
</dce>

 

 

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, the following criteria must be meet:

Follow these steps to test your inventory callback URL:

  1. Log into sandbox.doba.com with a retailer username and password that has authorized their account to work with your partner API account.
  2. Find a product you want to receive a callback for and add it to a watchlist.
  3. Put a check in the check-box under "Send Callback" and select "UPDATE".
  4. Select the "VIEW" button on the watchlist you just created.
  5. Select the "PRODUCT ID" of the product you wish to receive the callback for.
  6. Click on the yellow button labeled "Send API Callback".
  7. A callback will be sent to your system within a few minutes.

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.

To test shipment tracking callbacks within the Sandbox environment, please contact your account manager at Doba. At this time, all shipping information must be added manually by Doba. To expidite your request, please provide the order_id's you would like shipping added to.

Follow these steps to test your order callback URL:

  1. Create an order through using the createOrder API method.
  2. Log into sandbox.doba.com with the retailer username and password of the retailer you created the order for.
  3. Select "Orders" from the top navigation options.
  4. Select the "ORDER" number of the order you want a callback for.
  5. Select the yellow "Change Order Status" button.
  6. A pop-up window will be displayed. Select the "STATUS" from the drop-down box that you wish to change the order status to and click "SAVE".
  7. A callback will be sent to your system within a few minutes.