Retrieve a lead
Overview
Use the getLead method to retrieve leads created in the 2Checkout systems by fetching the lead code.
Request Parameters
Parameters | Required | Type/Description |
---|---|---|
LeadCode |
Optional |
String/Array of strings. Retrieves all leads based on their unique identification code (system-generated).
|
|
Optional |
String. A valid email address used by the customer |
Type |
Optional | String. Must be one of the existing types of leads:
|
StartDate |
Optional | String. The start date of the interval; format must be yyyy-mm-dd. |
EndDate |
Optional | String. The end date of the interval; format must be yyyy-mm-dd. |
ProductCode |
Optional |
String/Array of strings. Searches for all leads containing the product code. |
Language |
Optional | String. The language of the shopper cart; ISO 639-1 two-letter code. |
Country |
Optional | String. The customers billing country; ISO 3166 two-letter code. |
GeneratedFrom |
Optional | String. API, shopping cart, ConvertPlus. Display the leads based on the source where they were created – via API or via the 2Checkout ordering engines. |
Request Example
<?php require ('PATH_TO_AUTH'); $jsonRpcRequest = array ( 'method' => 'getLead', 'params' => array($sessionID, '60E6C4B574'), 'id' => $i++, 'jsonrpc' => '2.0' ); var_dump (callRPC((Object)$jsonRpcRequest, $host, true));
Response Parameters
Response Example
class stdClass#18 (14) { public $LeadCode => string(10) "60E6C4B574" public $GeneratedFrom => string(3) "API" public $CartId => string(11) "CartIdValue" public $Currency => string(3) "EUR" public $Language => string(2) "BG" public $ExternalReference => string(18) "REST_API_3CHECKOUT" public $MachineId => string(6) "123asd" public $LocalTime => string(19) "2019-11-05 16:48:28" public $Items => class stdClass#19 (1) { public $0 => class stdClass#20 (15) { public $Code => string(10) "04C26C50F8" public $Quantity => string(1) "2" public $SKU => NULL public $Name => string(5) "softy" public $Description => NULL public $IsDynamic => bool(false) public $Tangible => bool(false) public $PurchaseType => string(7) "PRODUCT" public $PriceOptions => NULL public $RecurringOptions => class stdClass#21 (5) { public $CycleLength => NULL public $CycleUnit => NULL public $CycleAmount => NULL public $ContractLength => NULL public $ContractUnit => NULL } public $RenewalInformation => class stdClass#22 (1) { public $SubscriptionReference => NULL } public $MarketingCampaigns => class stdClass#23 (3) { public $Type => string(2) "23" public $ParentCode => string(1) "m" public $CampaignCode => string(2) "23" } public $Price => class stdClass#24 (2) { public $Amount => string(2) "20" public $Type => string(6) "CUSTOM" } public $AdditionalFields => NULL public $SubscriptionStartDate => string(19) "2019-11-05 16:48:28" } } public $BillingDetails => class stdClass#25 (12) { public $FirstName => string(8) "Customer" public $LastName => string(9) "2Checkout" public $Phone => NULL public $Company => NULL public $FiscalCode => string(8) "32423423" public $Email => string(22) "customer@2checkout.com" public $Address1 => string(12) "Test Address" public $Address2 => NULL public $City => string(2) "LA" public $Zip => string(5) "12345" public $CountryCode => string(2) "RO" public $State => string(2) "CA" } public $DeliveryDetails => class stdClass#26 (12) { public $FirstName => string(8) "Customer" public $LastName => string(9) "2Checkout" public $Phone => NULL public $Company => NULL public $FiscalCode => string(8) "32423423" public $Email => string(22) "customer@2checkout.com" public $Address1 => string(12) "Test Address" public $Address2 => NULL public $City => string(2) "LA" public $Zip => string(5) "12345" public $CountryCode => string(2) "RO" public $State => string(2) "CA" } public $DeliveryInformation => class stdClass#27 (1) { public $ShippingMethod => class stdClass#28 (1) { public $Code => string(5) "sdfsd" } } public $PaymentDetails => class stdClass#29 (4) { public $Type => string(2) "CC" public $Currency => string(3) "EUR" public $PaymentMethod => class stdClass#30 (2) { public $RecurringEnabled => bool(false) public $CardPayment => class stdClass#31 (1) { public $InstallmentsNumber => string(2) "23" } } public $CustomerIP => string(7) "1.2.3.4" } public $Promotions => array(1) { [0] => string(0) "" } }