endFixedPriceItem
endFixedPriceItem allows you to remove one or more items from a user's booth.
endFixedPriceItem Input
endFixedPriceItem 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 endFixedPriceItemRequest.
Here are the available input parameters that can be serialized into JSON:
| 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 | |||
| itemID | integer (optionally 1..100 entries) | Required | The ID of the single item to remove, or an array of up to 100 item IDs you wish to remove. |
endFixedPriceItem Output
The name for the output returned from this request is endFixedPriceItemResponse. So, after parsing the serialized response into JSON, you can access the data with something like my_json_hash['endFixedPriceItemResponse']
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. |
| 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 | |||
| itemsRemoved | integer | Always | The number of items successfully removed from this booth. |
