List of API Calls

Here are the currently implemented API calls, by area of functionality.

Note that code examples use the following conventions:

  • Statements enclosed in guillemets («|») are optional.
  • Text wrapped in "squigly equal" signs (=|=) is placeholder text an needs to be replaced before the code is run.
  • Ellipses (...) indicate excluded content, for simplicity's sake.

Search & Lookup

All search & lookup requests submit to our non-secure API URL.

Submit to URL: http://api.bonanza.com/api_requests/standard_request

HTTP credentials required in header:

{ 'X-BONANZLE-API-DEV-NAME' => "#{ my_developer_account_name }" }

Read more about submitting a non-secure request.

  • findItemsByKeywords: Search for Bonanza items with filters for store, newness, and much more
  • getBooth: Get all available data for a Bonanza booth
  • getBoothItems: Get items of the specified status for a Bonanza booth
  • getCategories: Get detailed information for all child categories of a category you pass in
  • getCategoryTraits: Get information on the item traits (aka "item specifics") associated with a given category
  • getCheckoutLink: Generate a URL to send a user to checkout with one or more items, optionally using the affiliate token for developer
  • getSingleItem: Get all available data for a Bonanza item
  • getMultipleItems: Get all available for up to 50 Bonanza items
  • getUserProfile: Get all available data for a Bonanza user

Account Management, Item Editing

All account management and item addition/editing methods submit to our secure API URL.

Submit to URL: https://api.bonanza.com/api_requests/secure_request

HTTP credentials required in header:

{ 'X-BONANZLE-API-DEV-NAME' => "#{ my_developer_account_name }", 'X-BONANZLE-API-CERT-NAME' => "#{ my_developer_certification_token }" }

Read more about submitting a secure request.

Notifications

Want us to notify you when an event (such as a sold item) happens? We can do that.

Submit to URL: https://api.bonanza.com/api_requests/secure_request

HTTP credentials required in header:

{ 'X-BONANZLE-API-DEV-NAME' => "#{ my_developer_account_name }", 'X-BONANZLE-API-CERT-NAME' => "#{ my_devleoper_certification_token }" }

Read more about submitting a secure request.

Messages

Read and send on-site messages (aka BMail) for authenticated token owners.

Submit to URL: https://api.bonanza.com/api_requests/secure_request

HTTP credentials required in header:

{ 'X-BONANZLE-API-DEV-NAME' => "#{ my_developer_account_name }", 'X-BONANZLE-API-CERT-NAME' => "#{ my_devleoper_certification_token }" }

Read more about submitting a secure request.

  • getMessagesList: Get a list of all messages, grouped into sets of messages that form threads.
  • getMessages: Get all messages in a single set of messages that have been grouped into a single thread.
  • updateMessage: Set properties for a single existing message.
  • createMessage: Send a new message from the authenticated token owner.