• Return to Bonanza.com
  • Log in
  • Register
 
Apply for an API account
API Documentation
  • Bonapitit Home
  • Apply for an API Account
  • Getting Started
  • What is "Bonapitit"?
  • Who can use "Bonapitit"?
  • Differences from eBay's API
  • Quick Start Guide
  • Updates
  • Basics
  • Best Practices and Common Errors
  • Booth URL Identifiers
  • Container Data Types
  • Error Types
  • How do I serialize JSON so I can send it to Bonanza?
  • Introduction to User Tokens
  • Submitting Non-secure Requests
  • Submitting Secure Requests
  • Bonapitit Examples
  • .NET Examples
  • C# Examples
  • Java Examples
  • Perl Examples
  • PHP Examples
  • Python Examples
  • Ruby Examples
  • Reference
  • List of API Calls
  • addFixedPriceItem
  • addMultipleFixedPriceItems
  • completeSale
  • createMessage
  • endFixedPriceItem
  • fetchToken
  • findItemsByCategory
  • findItemsByKeywords
  • getBooth
  • getBoothItems
  • getBoothStats
  • getCategories
  • getCategoryTraits
  • getCheckoutLink
  • getMessages
  • getMessagesList
  • getMultipleItems
  • getMultipleUnlistedItems
  • getNotificationPreferences
  • getOrders
  • getSingleItem
  • getTokenStatus
  • getUnlistedItem
  • getUser
  • getUserProfile
  • reviseFixedPriceItem
  • reviseMultipleFixedPriceItems
  • setNotificationPreferences
  • updateBooth
  • updateInventory
  • updateMessage

getUserProfile

Retrieves full information about a given Bonanza user. Note that this method will only return data for users that have not chosen to hide their profile information.

getUserProfile Input

getUserProfileis a non-secure request with the following URL and HTTP header requirements:

Submit to URL: https://api.bonanza.com/api_requests/standard_request
Required in HTTP header: X-BONANZLE-API-DEV-NAME set to your dev_id

The name for your request should be getUserProfileRequest.

So, for example, here is the Ruby code to submit your request:

require "json"
require "net/http"

# Open connection to api.bonanza.com over port 443
http = Net::HTTP.new("api.bonanza.com", 443)
http.use_ssl = true
http.post(
  "/api_requests/standard_request", # The path we're posting to
  "getUserProfileRequest=your_serialized_JSON_data", # The data being posted
  { 'X-BONANZLE-API-DEV-NAME' => 'abcdef123456' } # The HTTP header, which gives your dev_id
)

Here are the available input parameters that can be serialized into JSON:

Argument Type Occurrence Meaning
Call-specific Input Fields
userId string Required The user name or user ID of a Bonanza user.

getUserProfile Output

The name for the output returned from this request is getUserProfileResponse. So, after parsing the serialized response into JSON, you can access the data with something like:

my_json_hash['getUserProfileResponse']

Here are all the possible output parameters:

Argument Type Occurrence Meaning
Standard Output Fields
errorMessage Container Conditionally Description of an error or warning that occurred when Bonanza processed the request. Not returned if the ack value is Success.
errorMessage.error Container Conditionally,
repeatable: [0..*]
errorMessage.error.category ErrorCategory Conditionally Currently unused.
errorMessage.error.message string Conditionally A description of the error
errorMessage.error.type ErrorType Conditionally A unique descriptive name for the error.
timestamp dateTime Always This value represents the date and time when Bonanza processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about this time format and converting to and from the GMT time zone.
warnings Container Conditionally Description of a warning that occurred when Bonanza processed the request.
warnings.unrecognized_parameters Container Conditionally,
repeatable: [0..*]
An array of unrecognized parameters.
Call-specific Output Fields
feedbackHistory Container Always Contains details about user's feedback
feedbackHistory.averageRatingDetails double Always The user's percentage of positive feedback for all time
feedbackHistory.ratingCount int Always Number of positive feedback minus the number of negative feedback received for a seller
uniqueNegativeFeedbackCount int Always The all-time count of negative feedback for this user.
uniqueNeutralFeedbackCount int Always The all-time count of neutral feedback for this user.
uniquePositiveFeedbackCount int Always The all-time count of positive feedback for this user.
user Container Always Container for advanced user details.
user.aboutMeURL anyURI Always URL to the user's profile.
user.feedbackDetailsURL anyURI Always URL to full feedback about the user.
user.feedbackRatingStar string Always

Visual indicator of user's feedback score. feedbackRatingStar values:

  • None: No graphic displayed, feedback score 0-9.
  • Yellow: Yellow Star, feedback score 10-49.
  • Blue: Blue Star, feedback score 50-99.
  • Turquoise: Turquoise Star, feedback score 100-499.
  • Purple: Purple Star, feedback score 500-999.
  • Red: Red Star, feedback score 1,000-4,999.
  • Green: Green Star, feedback score 5,000-9,999.
  • YellowShooting: Yellow Shooting Star, feedback score 10,000-24,999.
user.newUser boolean Always True if the user registered within the last two weeks, false otherwise.
user.registrationDate datetime Always The date on which the user registered with Bonanza.
user.status string Always The user's Bonanza registration status. Currently, if the user isn't "active", then the GetUserProfile call will fail, so the value will always be "active".
user.userId int Always The unique ID for the user.
storeURL anyURI Conditional, if user has a booth URL to the user's booth, if they have one.
storeName string Conditional, if user has a booth Title of the user's booth, if they have one.

getUserProfile Examples

  • PHP example
  • About
  • Affiliates
  • API
  • Blog
  • Contact
  • Help
  • Jobs
  • Legal
  • Partners
  • Press
  • Software engineering metrics
  • Webstores
  • Facebook
  • Twitter
  • Pinterest
  • Instagram
United States / United States Dollar $ Click to activate accessibility preferences Accessibility preferences
  • SSL Secure Connection
  • Better Business Bureau Accredited Business
  • PayPal Buyer Protection
  • © 2023 Bonanza. All Rights Reserved
  • Cookies and Tracking
  • Accessibility
  • Privacy Policy
  • Terms of Use