updateBooth requests that a given seller's booth be updated. This will change all items in the "ready for sale" status into the "for sale" status. Note that, because booth updating happens asynchronously, there may be a wait of 1-10 minutes (more for booths with thousands of items) until all items have been activated.

Note also that if a booth has not gone through its initial activation process - wherein the seller provides their selling details and agrees to the Bonanza terms of service - then this call will not fail.

If the booth you are updating has more than 40k items, then your call will be processed asynchronously. The response will be:

{ 'resultMessage' => "Booth queued for update", 'success' => true }

updateBooth Input

updateBooth is a secure API method with the following URL and HTTP header requirements:

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

Note that all secure methods except for fetchToken and getBoothItems require you to submit a user token so that we know what user account you are acting on behalf of.  For details about setting up and submitting user tokens, see our intro to user tokens.

The name for your request should be updateBoothRequest.

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

updateBooth Output

The name for the output returned from this request is updateBoothResponse. So, after parsing the serialized response into JSON, you can access the data with something like my_json_hash['updateBoothResponse']

Here are all the possible output parameters:

Argument Type Occurrence Meaning
requesterCredentials Container Required Container for user credentials
requesterCredentials .bonanzleAuthToken string Required The verified user token for the user who you are acting on behalf of.
Call-specific Input Fields
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.
Call-specific Output Fields
resultMessage string Always Message describing whether activation was a success.
success boolean Always True if the booth was successfully queued for activation. False if the user has not gone through their initial activation process, or the booth update failed for some other reason.

updateBooth Examples