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