Set external order reference

Use this method to set an external reference for a partner order. This is helpful if you use unique identifiers in your own order management system and you want to mirror the IDs in the 2Checkout system.

Use this method before placeOrder.

Request 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.
externalRef	Required (string) The unique identifier of an order placed in the Avangate system mirroring the reference you're using to manage order data in your system.

Request sample

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

$externalRef = 'NEW_REFERENCE';

$jsonRpcRequest = array (
  'jsonrpc' => '2.0',
  'id' => $i++,
  'method' => 'setExternalRef',
  'params' => array($sessionID, $externalRef)
);
var_dump (callRPC((Object)$jsonRpcRequest, $host));

$jsonRpcRequest = array (
  'jsonrpc' => '2.0',
  'id' => $i++,
  'method' => 'placeOrder',
  'params' => array($sessionID)
);
var_dump (callRPC((Object)$jsonRpcRequest,$host));

require ('PATH_TO_PLACE_ORDER');

Response parameters

Parameter	Type / Description
Response	Boolean True or false

Errors

Error	Description
INVALID_SOURCE	The provided external reference is empty.