Skip to main content
Last updated: 05-Jan-2022
Rate this article:

Overview

The create_comment call is used to add a comment to a specified sale.

URL: https://www.2checkout.com/api/sales/create_comment

HTTP Method: POST

Input Parameters

Parameter Description
sale_id The order number/sale ID of a sale to look for. Required.
sale_comment String value of comment to be submitted. Required.
cc_vendor Set to 1 to have a copy sent to the merchant. Optional.
cc_customer Set to 1 to have the buyer sent an email copy. Optional.

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/sales/create_comment -u \ 'username:password' -H 'Accept: application/json' -d 'sale_id=1234567890' \ -d 'sale_comment=Your order will be shipped this week.'

Example Successful Response

{ "response_code" : "OK", "response_message" : "Created comment 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 sale.
Rate this article:
Logo of Verifone