Update Option
Last updated: 05-Jan-2022
Rate this article:
Overview
The update_option call is used to update an option.
URL: https://www.2checkout.com/api/products/update_option
HTTP Method: POST
Input Parameters
Parameter | Description |
---|---|
option_id | ID of option being updated. Required. |
option_name | Name of new product option. Required. |
option_value_id | ID of existing option value to update/delete. Required when updating/deleting an option value. |
option_value_name | Name of option value. Required when creating an option value. |
option_value_surcharge | Amount of option surcharge. Required when creating an option value surcharge. |
Data Returned
Parameter | Description |
---|---|
response_code | Tells the user whether or not the operation was successful. |
response_message | Tells the user why the operation was or was not successful. |
Example API Call
curl -X POST https://www.2checkout.com/api/products/update_option \
-H 'Accept: application/json' -u 'username:password' \
-d 'option_id=1001' -d 'option_name=test option' -d 'option_value_name=colors'
-d 'option_value_surcharge=1.00'
Example Successful Response
{
"response_code" : "OK",
"response_message" : "Option updated successfully"
}
Common Error Codes
Code | Description |
---|---|
PARAMETER_MISSING | Required parameter missing: |
PARAMETER_INVALID | Invalid value for parameter: |
RECORD_NOT_FOUND | Unable to find record. |
FORBIDDEN | Access denied to option. |
Rate this article: