Add comments to an order
Overview
Use this method to attach a comment when placing a partner order.
Requirements
This method requires you to set a specific partner using setPartner.
Use this method before placeOrder.
Parameters
| Parameter | Type/Description |
|---|---|
| sessionID | Required (String) |
| Session identifier, which is the output of the Login method. An exception is thrown if the values are incorrect. | |
| comment | Required (String) |
| A comment visible to both you and the partner. |
Response
| Parameter | Type/Description |
|---|---|
| Response | Boolean |
| True or false |
Request
<?php
require ('PATH_TO_AUTH'); // Authentication example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/02Authentication
require ('PATH_TO_SET_PARTNER'); // setPartner example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/06Reference/Partner/00Set_partner
require ('PATH_TO_ADD_PRODUCT'); // addProduct example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/06Reference/08Place_an_order/00Add_product_to_cart
$comment = 'YOUR_COMMENT';
$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'setComment',
'params' => array($sessionID, $comment)
);
var_dump (callRPC((Object)$jsonRpcRequest, $host));
require ('PATH_TO_PLACE_ORDER');
Errors
| Error | Description |
|---|---|
|
INVALID_COMMENT |
The provided comment is empty. |