• 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

getCheckoutLink

Gets a link that can send a buyer directly to Bonanza checkout with items already in their cart. If the items are eligible for affiliate commissions, the commission tracking information will be automatically built into the checkout link URL.

getCheckoutLink Input

getCheckoutLinkis 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 getCheckoutLinkRequest.

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
  "getCheckoutLinkRequest=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
itemIds int Conditionally, repeatable [0..*] The ID of an item you want to add to the user's cart while sending them to checkout.

getCheckoutLink Output

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

my_json_hash['getCheckoutLinkResponse']

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.
checkoutUrl anyURI Always The full URL of a cart with the items and affiliate information passed in.
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.

getCheckoutLink 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