PHP Examples

This code and these examples were written using PHP verison 5.2.13. PHP was configured with the --with-curl option and JSON enabled. See PHP JSON and PHP cURL for the details of the PHP functions.

As of October 2014, SSL v3 is no longer supported for secure_token requests. You can ensure this is enabled by calling "curl_setopt($connection, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);" - note that you may also need to add "CURLOPT_SSL_CIPHER_LIST => 'TLSv1'" to your PPHttpConfig.php - as described in this StackOverflow answer.

fetch_token example
add_fixed_price_item example
add_multiple_fixed_price_items example
revise_fixed_price_item example
get_unlisted_item example
update_booth example
get_checkout_link example
get_user_profile example
get_single_item example
get_multiple_items example
get_booth example
get_booth_items example
get_categories example
get_category_traits example
find_items_by_keywords example
set_notification_preferences example
update_inventory example

PHP Example for fetchToken

The fetchToken API call does not have ANY inputs. This call is a secure API request and requires the dev name and cert name headers. Set the HTTP headers in $headers. Use CURL to send the API request. Decode the JSON response into an associative array $response. Print the token. Print the full response.

$dev_name = "xxx";
$cert_name = "yyy";
$url = "https://api.bonanza.com/api_requests/secure_request";
$headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name, "X-BONANZLE-API-CERT-NAME: " . $cert_name);
$args = array();
$post_fields = "fetchTokenRequest";
echo "Request: $post_fields \n";
$connection = curl_init($url);
$curl_options = array(CURLOPT_HTTPHEADER=>$headers, CURLOPT_POSTFIELDS=>$post_fields,
                CURLOPT_POST=>1, CURLOPT_RETURNTRANSFER=>1);  # data will be returned as a string
curl_setopt_array($connection, $curl_options);
$json_response = curl_exec($connection);
if (curl_errno($connection) > 0) {
  echo curl_error($connection) . "\n";
  exit(2);
}
curl_close($connection);
$response = json_decode($json_response,true);
$token = $response['fetchTokenResponse']['authToken'];
echo "Token: $token \n";
echo "Response: \n";
print_r($response);

Request: fetchTokenRequest
Token: GTL0jWeQat
Response:
Array
(
  [fetchTokenResponse] => Array
      (
          [hardExpirationTime] => 2011-12-16T06:20:58.000Z
          [authenticationURL] => https://www.bonanza.com/login?apitoken=GTL0jWeQat
          [authToken] => GTL0jWeQat
      )
  [timestamp] => 2010-12-16T06:20:58.000Z
  [version] => 1.0beta
  [ack] => Success
)

PHP Example for addFixedPriceItem

Add an item to Bonanza by providing the title, price, quantity, description, picture, category and shipping. You will also need to provide an authorization token in the $args. Build the API request in a simple associative array in $args. JSON encode the $args in the variable $post_fields. This call is a secure API request and requires dev name and cert name headers. Set the HTTP headers in $headers. Use CURL to send the API request. Decode the JSON response into an associative array $response. Print out the item ID. Print the full response.

$dev_name = "xxx";
$cert_name = "yyy";
$token = "zzz";
$url = "https://api.bonanza.com/api_requests/secure_request";
$headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name, "X-BONANZLE-API-CERT-NAME: " . $cert_name);
$item['title'] = "My Item";
$item['price'] = 30.57;
$item['quantity'] = 1;
$item['description'] = "This item is great.  Any html here.";
$item['pictureDetails']['pictureURL'] = "http://www.google.com/images/logos/ps_logo2.png";
$item['primaryCategory']['categoryId'] = 377;
$item['itemSpecifics']['specifics'] = array();
$item['itemSpecifics']['specifics'][] = array('Condition', 'New');
$item['itemSpecifics']['specifics'][] = array('Genre', 'Romance');
$item['shippingDetails']['shippingServiceOptions']['freeShipping'] = true;
$args = array("item" => $item);
$args['requesterCredentials']['bonanzleAuthToken'] = $token;
$post_fields = "addFixedPriceItem=" .  urlencode(json_encode($args));
echo "Request: $post_fields \n";
$connection = curl_init($url);
$curl_options = array(CURLOPT_HTTPHEADER=>$headers, CURLOPT_POSTFIELDS=>$post_fields,
                CURLOPT_POST=>1, CURLOPT_RETURNTRANSFER=>1);  # data will be returned as a string
curl_setopt_array($connection, $curl_options);
$json_response = curl_exec($connection);
if (curl_errno($connection) > 0) {
  echo curl_error($connection) . "\n";
  exit(2);
}
curl_close($connection);
$response = json_decode($json_response,true);
$itemId= $response['addFixedPriceItemResponse']['itemId'];
echo "itemId: $itemId \n";
echo "Response: \n";
print_r($response);

Request: addFixedPriceItem={"item":{"title":"My Item","price":30.57,"quantity":1,"description":"This item is great.  Any html here.","pictureDetails":{"pictureURL":"http:\/\/www.google.com\/images\/logos\/ps_logo2.png"},"primaryCategory":{"categoryId":377},"shippingDetails":{"shippingServiceOptions":{"freeShipping":true}}},"requesterCredentials":{"bonanzleAuthToken":"zzz"}}
itemId: 24018227
Response:
Array
(
  [timestamp] => 2010-12-16T06:40:01.000Z
  [addFixedPriceItemResponse] => Array
      (
          [sellingState] => Ready for sale
          [categoryId] => 377
          [itemId] => 24018227
      )
  [version] => 1.0beta
  [ack] => Success
)

PHP Example for addMultipleFixedPriceItems

Adding multiple fixed price items is like adding a single item with the addition of adding each item to an outer items array.

$dev_name = "xxx";
$cert_name = "yyy";
$token = "zzz";
$url = "https://api.bonanza.com/api_requests/secure_request";
$headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name, "X-BONANZLE-API-CERT-NAME: " . $cert_name);

$items = array();
$item0['title'] = "My Item 0";
$item0['price'] = 30.57;
$item0['quantity'] = 1;
$item0['description'] = "This item is great.  Any html here.";
$item0['primaryCategory']['categoryId'] = 397;
$items[] = array("item" => $item0);  # important step is to identify each item with an "item" key

$item1['title'] = "My Item 1";
$item1['price'] = 30.57;
$item1['quantity'] = 1;
$item1['primaryCategory']['categoryId'] = 397;
$item1['description'] = "This item is great.  Any html here.";
$items[] = array("item" => $item1);  # important step is to identify each item with an "item" key

$args = array("items" => $items);
$args['requesterCredentials']['bonanzleAuthToken'] = $token;
$post_fields = "addMultipleFixedPriceItems=" .  urlencode(json_encode($args));

echo "Request: $post_fields \n";
$connection = curl_init($url);
$curl_options = array(CURLOPT_HTTPHEADER=>$headers, CURLOPT_POSTFIELDS=>$post_fields,
                CURLOPT_POST=>1, CURLOPT_RETURNTRANSFER=>1);  # data will be returned as a string
curl_setopt_array($connection, $curl_options);

$json_response = curl_exec($connection);

if (curl_errno($connection) > 0) {
  echo curl_error($connection) . "\n";
  exit(2);
}

curl_close($connection);

$response = json_decode($json_response,true);
$itemId= $response['addFixedPriceItemResponse']['itemId'];
echo "itemId: $itemId \n";
echo "Response: \n";
print_r($response);

PHP Example for reviseFixedPriceItem

Revise item 24018227 to update the title, price and quantity. You will also need to provide an authorization token in the $args. Build the API request in a simple associative array in $args. JSON encode the $args in the variable $post_fields. This call is a secure API request and requires dev name and cert name headers. Set the HTTP headers in $headers. Use CURL to send the API request. Decode the JSON response into an associative array $response. Print the full response.

$dev_name = "xxx";
$cert_name = "yyy";
$token = "zzz";
$url = "https://api.bonanza.com/api_requests/secure_request";
$headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name, "X-BONANZLE-API-CERT-NAME: " . $cert_name);
$itemId = 24018227;
$item = array();
$item['title'] = "My Item - revised";
$item['price'] = 30.99;
$item['quantity'] = 2;
$args = array("item" => $item, "itemId" => $itemId);
$args['requesterCredentials']['bonanzleAuthToken'] = $token;
$post_fields = "reviseFixedPriceItem=" .  urlencode(json_encode($args));
echo "Request: $post_fields \n";
$connection = curl_init($url);
$curl_options = array(CURLOPT_HTTPHEADER=>$headers, CURLOPT_POSTFIELDS=>$post_fields,
                CURLOPT_POST=>1, CURLOPT_RETURNTRANSFER=>1);  # data will be returned as a string
curl_setopt_array($connection, $curl_options);
$json_response = curl_exec($connection);
if (curl_errno($connection) > 0) {
  echo curl_error($connection) . "\n";
  exit(2);
}
curl_close($connection);
$response = json_decode($json_response,true);
echo "Response: \n";
print_r($response);

Request: reviseFixedPriceItem={"item":{"title":"My Item - revised","price":30.99,"quantity":2},"itemId":24018227,"requesterCredentials":{"bonanzleAuthToken":"zzz"}}
Response:
Array
(
  [timestamp] => 2010-12-16T09:29:01.000Z
  [reviseFixedPriceItemResponse] => Array
      (
          [sellingState] => Ready for sale
          [categoryId] => 377
          [itemId] => 24018227
      )
  [version] => 1.0beta
  [ack] => Success
)

PHP Example for getUnlistedItem

Get the details of the unlisted item with the item ID of 24018222. You will also need to provide an authorization token in the $args. Build the API request in a simple associative array in $args. JSON encode the $args in the variable $post_fields. This call is a secure API request and requires dev name and cert name headers. Set the HTTP headers in $headers. Use CURL to send the API request. Decode the JSON response into an associative array $response. Print the full response.

$dev_name = "xxx";
$cert_name = "yyy";
$token = "zzz";
$url = "https://api.bonanza.com/api_requests/secure_request";
$headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name, "X-BONANZLE-API-CERT-NAME: " . $cert_name);
$itemId = 24018222;
$args = array("itemId" => $itemId);
$args['requesterCredentials']['bonanzleAuthToken'] = $token;
$post_fields = "getUnlistedItem=" .  json_encode($args);
echo "Request: $post_fields \n";
$connection = curl_init($url);
$curl_options = array(CURLOPT_HTTPHEADER=>$headers, CURLOPT_POSTFIELDS=>$post_fields,
                CURLOPT_POST=>1, CURLOPT_RETURNTRANSFER=>1);  # data will be returned as a string
curl_setopt_array($connection, $curl_options);
$json_response = curl_exec($connection);
if (curl_errno($connection) > 0) {
  echo curl_error($connection) . "\n";
  exit(2);
}
curl_close($connection);
$response = json_decode($json_response,true);
echo "Response: \n";
print_r($response);

PHP Example for updateBooth

The updateBooth call has only 1 input, which is the token. Build the API request in a simple associative array in $args. JSON encode the $args in the variable $post_fields. This call is a secure API request and requires dev name, cert name, and an authorization token. Set the HTTP headers in $headers. Use CURL to send the API request. Decode the JSON response into an associative array $response. Print the response.

$dev_name = "xxx";
$cert_name = "yyy";
$token = "zzz";
$url = "https://api.bonanza.com/api_requests/secure_request";
$headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name, "X-BONANZLE-API-CERT-NAME: " . $cert_name);
$args = array();
$args['requesterCredentials']['bonanzleAuthToken'] = $token;
$post_fields = "updateBoothRequest=" .  json_encode($args, JSON_HEX_AMP);
echo "Request: $post_fields \n";
$connection = curl_init($url);
$curl_options = array(CURLOPT_HTTPHEADER=>$headers, CURLOPT_POSTFIELDS=>$post_fields,
                CURLOPT_POST=>1, CURLOPT_RETURNTRANSFER=>1);  # data will be returned as a string
curl_setopt_array($connection, $curl_options);
$json_response = curl_exec($connection);
if (curl_errno($connection) > 0) {
  echo curl_error($connection) . "\n";
  exit(2);
}
curl_close($connection);
$response = json_decode($json_response,true);
echo "Response: \n";
print_r($response);

Request: updateBoothRequest={"requesterCredentials":{"bonanzleAuthToken":"zzz"}}
Response:
Array
(
  [updateBoothResponse] => Array
      (
          [success] => 1
          [resultMessage] => Booth queued for update
      )
  [timestamp] => 2010-12-11T17:05:20.000Z
  [version] => 1.0beta
  [ack] => Success
)

PHP Example for getCheckoutLink

Get the checkout link for 3 items 404027,404175 and 23997948. Build the API request in a simple associative array in $args. JSON encode the $args in the variable $post_fields. This call is a standard API request and requires only a dev name header. Set the HTTP headers in $headers. Use CURL to send the API request. Decode the JSON response into an associative array $response. Print out the link. Print the full response.

$dev_name = "xxx";
$api_url = "https://api.bonanza.com/api_requests/standard_request";
$headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name);
$ids = array(404027,404175,23997948);
$args = array("itemIds" => $ids);
$post_fields = "getCheckoutLinkRequest=" .  json_encode($args);
echo "Request: $post_fields \n";
$connection = curl_init($api_url);
$curl_options = array(CURLOPT_HTTPHEADER=>$headers, CURLOPT_POSTFIELDS=>$post_fields,
                CURLOPT_POST=>1, CURLOPT_RETURNTRANSFER=>1);  # data will be returned as a string
curl_setopt_array($connection, $curl_options);
$json_response = curl_exec($connection);
if (curl_errno($connection) > 0) {
  echo curl_error($connection) . "\n";
  exit(2);
}
curl_close($connection);
$response = json_decode($json_response,true);
$url = $response['getCheckoutLinkResponse']['checkoutUrl'];
echo "url: $url  \n";
echo "Response: \n";
print_r($response);

Request: getCheckoutLinkRequest={"itemIds":[404027,404175,23997948]}
url: https://www.bonanza.com/offers/make_cart_from_items?item_ids=404027,404175,23997948
Response:
Array
(
  [timestamp] => 2010-12-15T12:51:30.000Z
  [getCheckoutLinkResponse] => Array
      (
          [checkoutUrl] => https://www.bonanza.com/offers/make_cart_from_items?item_ids=404027,404175,23997948
      )
  [version] => 1.0beta
  [ack] => Success
)

PHP Example for getUserProfile

Get the feedback and rating information for the user with the ID of "hollee". Build the API request in a simple associative array in $args. JSON encode the $args in the variable $post_fields. This call is a standard API request and requires only a dev name header. Set the HTTP headers in $headers. Use CURL to send the API request. Decode the JSON response into an associative array $response. Print out the users rating and star information. Print the full response.

$dev_name = "xxx";
$api_url = "https://api.bonanza.com/api_requests/standard_request";
$headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name);
$args = array("userId" => "BluePennyLady");
$post_fields = "getUserProfileRequest=" .  json_encode($args, JSON_HEX_AMP);
echo "Request: $post_fields \n";
$connection = curl_init($api_url);
$curl_options = array(CURLOPT_HTTPHEADER=>$headers, CURLOPT_POSTFIELDS=>$post_fields,
                CURLOPT_POST=>1, CURLOPT_RETURNTRANSFER=>1);  # data will be returned as a string
curl_setopt_array($connection, $curl_options);
$json_response = curl_exec($connection);
if (curl_errno($connection) > 0) {
  echo curl_error($connection) . "\n";
  exit(2);
}
curl_close($connection);
$response = json_decode($json_response,true);
$rating = $response['getUserProfileResponse']['feedbackHistory']['averageRatingDetails']['rating'];
$star = $response['getUserProfileResponse']['user']['feedbackRatingStar'];
echo "Rating: $rating  Star: $star \n";
echo "Response: \n";
print_r($response);

Request: getUserProfileRequest={"userId":"hollee"}
Rating: 99.9  Star: Red
Response:
Array
(
  [getUserProfileResponse] => Array
      (
          [feedbackHistory] => Array
              (
                  [uniquePositiveFeedbackCount] => 5000
                  [uniqueNeutralFeedbackCount] => 8
                  [uniqueNegativeFeedbackCount] => 3
                  [averageRatingDetails] => Array
                      (
                          [rating] => 99.9
                          [ratingCount] => 4997
                      )
              )
          [user] => Array
              (
                  [newUser] => true
                  [feedbackRatingStar] => Red
                  [aboutMeURL] => https://www.bonanza.com/users/2163/profile
                  [userId] => 2163
                  [feedbackDetailsURL] => https://www.bonanza.com/users/2163/user_feedbacks
                  [status] => active
                  [registrationDate] => 2008-09-02T06:33:06.000Z
              )
      )
  [timestamp] => 2010-12-15T12:23:31.000Z
  [version] => 1.0beta
  [ack] => Success
)

PHP Example for getSingleItem

Get the data for the Bonanza item ID 23266642. Build the API request in a simple associative array in $args. JSON encode the $args in the variable $post_fields. This call is a standard API request and requires only a dev name header. Set the HTTP headers in $headers. Use CURL to send the API request. Decode the JSON response into an associative array $response. Print the response.

$dev_name = "xxx";
$api_url = "https://api.bonanza.com/api_requests/standard_request";
$headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name);
$args = array("itemId" => "23266642");
$post_fields = "getSingleItemRequest=" .  json_encode($args, JSON_HEX_AMP);
echo "Request: $post_fields \n";
$connection = curl_init($api_url);
$curl_options = array(CURLOPT_HTTPHEADER=>$headers, CURLOPT_POSTFIELDS=>$post_fields,
                CURLOPT_POST=>1, CURLOPT_RETURNTRANSFER=>1);  # data will be returned as a string
curl_setopt_array($connection, $curl_options);
$json_response = curl_exec($connection);
if (curl_errno($connection) > 0) {
  echo curl_error($connection) . "\n";
  exit(2);
}
curl_close($connection);
$response = json_decode($json_response,true);
echo "Response: \n";
print_r($response);

PHP Example for getMultipleItems

Get the data for 2 Bonanza items with IDS of 404027 and 404175. Build the API request in a simple associative array in $args. JSON encode the $args in the variable $post_fields. This call is a standard API request and requires only a dev name header. Set the HTTP headers in $headers. Use CURL to send the API request. Decode the JSON response into an associative array $response. Loop thru the returned data and print the price and title of each item. Print the full response.

$dev_name = "xxx";
$api_url = "https://api.bonanza.com/api_requests/standard_request";
$headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name);
$ids = array(404027,404175);
$args = array("itemId" =>  $ids);
$post_fields = "getMultipleItemsRequest=" .  json_encode($args, JSON_HEX_AMP);
echo "Request: $post_fields \n";
$connection = curl_init($api_url);
$curl_options = array(CURLOPT_HTTPHEADER=>$headers, CURLOPT_POSTFIELDS=>$post_fields,
                CURLOPT_POST=>1, CURLOPT_RETURNTRANSFER=>1);  # data will be returned as a string
curl_setopt_array($connection, $curl_options);
$json_response = curl_exec($connection);
if (curl_errno($connection) > 0) {
  echo curl_error($connection) . "\n";
  exit(2);
}
curl_close($connection);
$response = json_decode($json_response,true);
echo "  Loop thru the data \n";
while (list(,$item) = each($response['getMultipleItemsResponse']['item'])) {
  echo "  " . $item['currentPrice'] . " - " . $item['title'] . "\n";
}
echo "Response: \n";
print_r($response);

PHP Example for getBooth

Get the booth for the user ID "rooms_delivered". Build the API request in a simple associative array in $args. JSON encode the $args in the variable $post_fields. This call is a standard API request and requires only a dev name header. Set the HTTP headers in $headers. Use CURL to send the API request. Decode the JSON response into an associative array $response. Print the response.

$dev_name = "xxx";
$api_url = "https://api.bonanza.com/api_requests/standard_request";
$headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name);
$args = array("userId" => "rooms_delivered");
$post_fields = "getBoothRequest=" .  json_encode($args, JSON_HEX_AMP);
echo "Request: $post_fields \n";
$connection = curl_init($api_url);
$curl_options = array(CURLOPT_HTTPHEADER=>$headers, CURLOPT_POSTFIELDS=>$post_fields,
                CURLOPT_POST=>1, CURLOPT_RETURNTRANSFER=>1);  # data will be returned as a string
curl_setopt_array($connection, $curl_options);
$json_response = curl_exec($connection);
if (curl_errno($connection) > 0) {
  echo curl_error($connection) . "\n";
  exit(2);
}
curl_close($connection);
$response = json_decode($json_response,true);
echo "Response: \n";
print_r($response);

Request: getBoothRequest={"userId":"rooms_delivered"}
Response:
Array
(
  [timestamp] => 2010-12-15T06:41:27.000Z
  [getBoothResponse] => Array
      (
          [store] => Array
              (
                  [subscriptionLevel] => 0
                  [name] => rooms-delivered's booth
                  [url] => http://www.bonanza.com/booths/rooms_delivered
                  [logo] => Array
                      (
                          [url] => http://bonanzapublic.s3.amazonaws.com/images/booth/template_images/Paintbrushes.jpg
                      )
                  [lastUpdated] => 2010-12-06T15:58:15.000Z
                  [policies] =>
                  [description] =>
                  [syndicated] => false
              )
      )
  [version] => 1.0beta
  [ack] => Success
)

PHP Example for getBoothItems

Retrieve items from a specified booth by providing the booth id and - optionally - the statuses of the items you want returned. You can page through all items in a booth by also specifying the page number to retrieve and/or the number of items to list per page. You will also need to provide an authorization token in the $args.

Build the API request in a simple associative array in $args. JSON encode the $args in the variable $post_fields. This call is a secure API request and requires dev name and cert name headers. Set the HTTP headers in $headers. Use CURL to send the API request. Decode the JSON response into an associative array $response. Print out the item ID. Print the full response.

$dev_name = "xxx";
$cert_name = "yyy";
$token = "zzz";
$url = "https://api.bonanza.com/api_requests/secure_request";
$headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name, "X-BONANZLE-API-CERT-NAME: " . $cert_name);
$args = array( 'userId' => 'rooms_delivered', 'itemStatus' => array('for_sale', 'ready_to_post'), 'itemsPerPage' => 10, 'page' => 2);
$args['requesterCredentials']['bonanzleAuthToken'] = $token;   // only necessary if specifying an itemStatus other than "for_sale"
$request_name = "getBoothItemsRequest";
$post_fields = "$request_name=" . json_encode($args) . " \n";
echo "Request: $post_fields \n";
$connection = curl_init($url);
$curl_options = array(CURLOPT_HTTPHEADER=>$headers, CURLOPT_POSTFIELDS=>$post_fields,
                CURLOPT_POST=>1, CURLOPT_RETURNTRANSFER=>1);  // data will be returned as a string
curl_setopt_array($connection, $curl_options);
$json_response = curl_exec($connection);
if (curl_errno($connection) > 0) {
  echo curl_error($connection) . "\n";
  exit(2);
}
curl_close($connection);
$response = json_decode($json_response,true);
echo "Response: \n";
print_r($response);

PHP Example for getCategories

Get the child categories of the "Baby" category (ID 2984). Build the API request in a simple associative array in $args. JSON encode the $args in the variable $post_fields. This call is a standard API request and requires only a dev name header. Set the HTTP headers in $headers. Use CURL to send the API request. Decode the JSON response into an associative array $response. Loop thru the data and print child category ID and Name. Print the response.

$dev_name = "xxx";
$api_url = "https://api.bonanza.com/api_requests/standard_request";
$headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name);
$args = array("categoryParent" => 2984);
$post_fields = "getCategoriesRequest=" .  json_encode($args, JSON_HEX_AMP);
echo "Request: $post_fields \n";
$connection = curl_init($api_url);
$curl_options = array(CURLOPT_HTTPHEADER=>$headers, CURLOPT_POSTFIELDS=>$post_fields,
                CURLOPT_POST=>1, CURLOPT_RETURNTRANSFER=>1);  # data will be returned as a string
curl_setopt_array($connection, $curl_options);
$json_response = curl_exec($connection);
if (curl_errno($connection) > 0) {
  echo curl_error($connection) . "\n";
  exit(2);
}
curl_close($connection);
$response = json_decode($json_response,true);
echo "  Loop thru the data \n";
while (list(,$category) = each($response['getCategoriesResponse']['categoryArray'])) {
  echo "  " . $category['categoryId'] . " - " . $category['categoryName'] . "\n";
}
echo "Response: \n";
print_r($response);

Request: getCategoriesRequest={"categoryParent":2984}
Loop thru the data
1261 - Baby >> Other
19068 - Baby >> Toys for Baby
20394 - Baby >> Bathing & Grooming
20400 - Baby >> Feeding
20416 - Baby >> Nursery Bedding
20422 - Baby >> Nursery Furniture
20433 - Baby >> Baby Safety & Health
37631 - Baby >> Potty Training
45455 - Baby >> Diapering
48757 - Baby >> Wholesale Lots
66692 - Baby >> Car Safety Seats
66697 - Baby >> Nursery Decor
66698 - Baby >> Strollers
100223 - Baby >> Baby Gear
117388 - Baby >> Keepsakes & Baby Announcements
Response:
Array
(
  [getCategoriesResponse] => Array
      (
          [categoryArray] => Array
              (
                  [0] => Array
                      (
                          [categoryName] => Baby >> Other
                          [traitCount] => 1
                          [categoryId] => 1261
                          [categoryBriefName] => Other
                          [leafCategory] => true
                          [categoryLevel] => 2
                      )
                  [1] => Array
                      (
                          [categoryName] => Baby >> Toys for Baby
                          [traitCount] => 1
                          [categoryId] => 19068
                          [categoryBriefName] => Toys for Baby
                          [leafCategory] => false
                          [categoryLevel] => 2
                      )
                  [2] => Array
                      (
                          [categoryName] => Baby >> Bathing & Grooming
                          [traitCount] => 1
                          [categoryId] => 20394
                          [categoryBriefName] => Bathing & Grooming
                          [leafCategory] => false
                          [categoryLevel] => 2
                      )
                   ....
              )
      )
  [timestamp] => 2010-12-15T07:09:09.000Z
  [version] => 1.0beta
  [ack] => Success
)

PHP Example for getCategoryTraits

Get the traits for the category "Books >> Fiction Books" (ID 377). This is a LEAF category. Build the API request in a simple associative array in $args. JSON encode the $args in the variable $post_fields. This call is a standard API request and requires only a dev name header. Set the HTTP headers in $headers. Use CURL to send the API request. Decode the JSON response into an associative array $response. Loop thru the data and print trait ID and label. Print the response.

$dev_name = "xxx";
$api_url = "https://api.bonanza.com/api_requests/standard_request";
$headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name);
$args = array("categoryId" => 377);
$post_fields = "getCategoryTraitsRequest=" .  json_encode($args, JSON_HEX_AMP);
echo "Request: $post_fields \n";
$connection = curl_init($api_url);
$curl_options = array(CURLOPT_HTTPHEADER=>$headers, CURLOPT_POSTFIELDS=>$post_fields,
                CURLOPT_POST=>1, CURLOPT_RETURNTRANSFER=>1);  # data will be returned as a string
curl_setopt_array($connection, $curl_options);
$json_response = curl_exec($connection);
if (curl_errno($connection) > 0) {
  echo curl_error($connection) . "\n";
  exit(2);
}
curl_close($connection);
$response = json_decode($json_response,true);
echo "  Loop thru the data \n";
while (list(,$trait) = each($response['getCategoryTraitsResponse']['traitArray'])) {
  echo "  " . $trait['id'] . " - " . $trait['label'] . "\n";
}
echo "Response: \n";
print_r($response);

PHP Example for findItemsByKeywords

Find the items on Bonanza related to the keywords "Levis Boot Cut" and show page 1 with 5 on a page. Build the API request in a simple associative array in $args. JSON encode the $args in the variable $post_fields. This call is a standard API request and requires only a dev name header. Set the HTTP headers in $headers. Use CURL to send the API request. Decode the JSON response into an associative array $response. Loop thru the data and print item location and title. Print the full response.

$dev_name = "xxx";
$api_url = "https://api.bonanza.com/api_requests/standard_request";
$headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name);
$paginationInput['entriesPerPage'] = 5;
$paginationInput['pageNumber'] = 1;
$args = array("paginationInput"=> $paginationInput, "keywords" => "Levis Boot Cut");
$post_fields = "findItemsByKeywordsRequest=" .  json_encode($args);
echo "Request: $post_fields \n";
$connection = curl_init($api_url);
$curl_options = array(CURLOPT_HTTPHEADER=>$headers, CURLOPT_POSTFIELDS=>$post_fields,
                CURLOPT_POST=>1, CURLOPT_RETURNTRANSFER=>1);  # data will be returned as a string
curl_setopt_array($connection, $curl_options);
$json_response = curl_exec($connection);
if (curl_errno($connection) > 0) {
  echo curl_error($connection) . "\n";
  exit(2);
}
curl_close($connection);
$response = json_decode($json_response,true);
echo "  Loop thru the data \n";
while (list(,$item) = each($response['findItemsByKeywordsResponse']['item'])) {
  echo "  " . $item['location'] . " - " . $item['title'] . "\n";
}
echo "Response: \n";
print_r($response);

PHP Example for setNotificationPreferences

Specify the delivery endpoint to receive notifications, and list the notifications to subscribe to (e.g. "askSellerQuestion"). Build the API request in a simple associative array in $args. JSON encode the $args in the variable $post_fields. This call is a secure API request and requires dev name and cert name headers. Set the HTTP headers in $headers. Use CURL to send the API request. Decode the JSON response into an associative array $response. Print the full response.

$dev_name = "xxx";
$cert_name = "yyy";
$token = "zzz";
$url = "https://api.bonanza.com/api_requests/secure_request";
$headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name, "X-BONANZLE-API-CERT-NAME: " . $cert_name);

$delivery_preferences = array();
$delivery_preferences['applicationEnable'] = "Enable";
$delivery_preferences['deliveryURLDetails'] = array(
  'deliveryURL' => "http://foo.com/notifications",
  'status' => "Enable" 
);

$subscribed_notifications = array('notificationEnable' => array());
$notification = array(
  'eventEnable' => "Enable",
  'eventType' => "askSellerQuestion",
  'detailed' => true
);
array_push($subscribed_notifications['notificationEnable'], $notification);

$args = array('applicationDeliveryPreferences' => $delivery_preferences, 'userDeliveryPreferenceArray' => $subscribed_notifications);
$args['requesterCredentials']['bonanzleAuthToken'] = $token;
$post_fields = "setNotificationPreferences=" .  json_encode($args);
echo "Request: $post_fields \n";
$connection = curl_init($url);
$curl_options = array(CURLOPT_HTTPHEADER=>$headers, CURLOPT_POSTFIELDS=>$post_fields,
                CURLOPT_POST=>1, CURLOPT_RETURNTRANSFER=>1);  # data will be returned as a string
curl_setopt_array($connection, $curl_options);
$json_response = curl_exec($connection);
if (curl_errno($connection) > 0) {
  echo curl_error($connection) . "\n";
  exit(2);
}
curl_close($connection);
$response = json_decode($json_response,true);
echo "Response: \n";
print_r($response);

Request: setNotificationPreferences={"applicationDeliveryPreferences":{"applicationEnable":"Enable","deliveryURLDetails":{"deliveryURL":"http:\/\/foo.com\/notifications","status":"Enable"}},"userDeliveryPreferenceArray":{"notificationEnable":[{"eventEnable":"Enable","eventType":"askSellerQuestion","detailed":true}]},"requesterCredentials":{"bonanzleAuthToken":"XehKe4HUVP"}}
Response:
Array
(
    [ack] => Success
    [version] => 1.0
    [timestamp] => 2018-02-20T11:38:49.000Z
    [setNotificationPreferencesResponse] => Array
        (
            [notificationId] => 69537
            [deliveryURLsProcessed] => 1
            [eventsProcessed] => 1
        )

)

PHP Example for updateInventory

Update the price and quantity for Bonanza Item 1234, and update the quantity for Bonanza Item 5678 in the same request.

$dev_name = "xxx";
$cert_name = "yyy";
$token = "zzz";
$url = "https://api.bonanza.com/api_requests/secure_request";
$headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name, "X-BONANZLE-API-CERT-NAME: " . $cert_name);
$updates = array();
$updates["1234"] = array("quantity" => 12, "price" => 14.99);
$updates["5678"] = array("quantity" => 3);
$args = array("updates" => $updates);
$args["requesterCredentials"]["bonanzleAuthToken"] = $token;
$post_fields = "updateInventory=" .  urlencode(json_encode($args));
echo "Request: $post_fields \n";
$connection = curl_init($url);
$curl_options = array(CURLOPT_HTTPHEADER=>$headers, CURLOPT_POSTFIELDS=>$post_fields,
                CURLOPT_POST=>1, CURLOPT_RETURNTRANSFER=>1);  # data will be returned as a string
curl_setopt_array($connection, $curl_options);
$json_response = curl_exec($connection);
if (curl_errno($connection) > 0) {
  echo curl_error($connection) . "\n";
  exit(2);
}
curl_close($connection);
$response = json_decode($json_response,true);
echo "Response: \n";
print_r($response);

Request: updateInventory=%7B%22updates%22%3A%7B%22782383635%22%3A%7B%22quantity%22%3A12%2C%22price%22%3A14.99%7D%2C%22782383633%22%3A%7B%22quantity%22%3A3%7D%7D%2C%22requesterCredentials%22%3A%7B%22bonanzleAuthToken%22%3A%22AnOz8BOaaP%22%7D%7D
Response:
Array
(
    [ack] => Success
    [version] => 1.1.2
    [timestamp] => 2020-02-27T15:56:52.000Z
    [updateInventoryResponse] => Array
        (
            [1234] => Array
                (
                    [success] => 1
                )
            [5678] => Array
                (
                    [success] => 1
                )
        )
)

PHP Examples - Functions That Can Speed Development

PHP Examples - Basic Functions

These 4 functions will help to make API calls using PHP. You can hide a lot of the details when making an API call. See the sample usage below.

# $dev_name = developer name (ID)
# $cert_name = certificate name (ID)
function BonapititSecureApiCall($dev_name, $cert_name, $api_call_and_args) {
  $url = "https://api.bonanza.com/api_requests/secure_request";
  $headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name, "X-BONANZLE-API-CERT-NAME: " . $cert_name);
  $resp = BonapititSendHttpRequest($url,$headers, $api_call_and_args);
  return $resp;
}

# $dev_name = developer ID
# $api_call_and_args - string of the form: api_call={json_data}
function BonapititStandardApiCall($dev_name, $api_call_and_args) {
  $url = "https://api.bonanza.com/api_requests/standard_request";
  $headers = array("X-BONANZLE-API-DEV-NAME: " . $dev_name);
  $resp = BonapititSendHttpRequest($url,$headers, $api_call_and_args);
  return $resp;
}

# $url - string - url of the bonanza api
# $headers - string - http headers containing X-BONANZLE-API-DEV-NAME and/or X-BONANZLE-API-CERT-NAME
# $post_fields - string - data that will be posted to the $url.
function BonapititSendHttpRequest($url, $headers, $post_fields) {
  $connection = curl_init();
  curl_setopt($connection, CURLOPT_URL, $url);
  curl_setopt($connection, CURLOPT_SSL_VERIFYPEER, 0);  //stop CURL from verifying the peer's certificate
  curl_setopt($connection, CURLOPT_SSL_VERIFYHOST, 0);
  curl_setopt($connection, CURLOPT_HTTPHEADER, $headers); //set the headers using the array of headers
  curl_setopt($connection, CURLOPT_POST, 1);  //set method as POST
  curl_setopt($connection, CURLOPT_POSTFIELDS, $post_fields);
  curl_setopt($connection, CURLOPT_RETURNTRANSFER, 1);  //set it to return the transfer as a string from curl_exec
  $response = curl_exec($connection);
  curl_close($connection);
  return $response;
}

# $api_call_name - string - like UpdateBooth
# $assoc_array - array - associative array of data
function BonapititBuildRequest($api_call_name, $assoc_array) {
  $request_name = $api_call_name . "Request";
  $json = json_encode($assoc_array, JSON_HEX_AMP);
  $request = $request_name . "=" .  $json;
  return $request;
}

PHP Examples - Usage of functions for updateBooth

Use the Bonapitit functions (above) to update the booth. Build the $request. Make the secure API call. Use JSON to decode the response. Print the full response.

$dev_name = "xxx";
$cert_name = "yyy";
$token = "zzz";
$args = array();
$args['requesterCredentials']['bonanzleAuthToken'] = $token;
$request = BonapititBuildRequest("updateBooth",$args);
$json_response = BonapititSecureApiCall($dev_name, $cert_name, $request);
$response = json_decode($json_response,true);
print_r($response);

PHP Examples - Usage of functions for getSingleItem

Use the Bonapitit functions (above) to get the item ID 23266642. Build the getSingle Item $request. Make the standard API call. Use JSON to decode the response. Print the full response.

$dev_name = "xxx";
$args = array("itemId" => "23266642");
$request = BonapititBuildRequest("getSingleItem",$args);
$json_response =  BonapititStandardApiCall($dev_name, $request);
$response = json_decode($json_response,true);
print_r($response);