Retrieve price option groups
Overview
Use the searchPriceOptionGroups to extract information on the price option groups you configured.
Parameters
| Parameters | Type/Description |
|---|---|
|
sessionID |
Required (string) |
|
|
Session identifier, the output of the Login method. Include sessionID into all your requests. 2Checkout throws an exception if the values are incorrect. The sessionID expires in 10 minutes. |
|
PriceOptionGroupSearch |
Optional (object) |
|
|
Details below. |
|
PriceOptionGroupSearch |
Object |
|
Name |
Optional (string) |
|
|
The name of the pricing options groups configured in the 2Checkout system. Can be NULL. |
|
Types |
Optional (array) |
|
|
Possible values: · RADIO · CHECKBOX · INTERVAL · COMBO Can be NULL. |
|
Limit |
Optional (int) |
|
|
Number of results displayed per page. Default maximum value is 10. Can be NULL. |
|
Page |
Optional (int) |
|
|
A specific page of search results. Default value is 1. Can be NULL. |
Response
| Parameters | Type/Description |
|---|---|
|
Array of objects |
Request
<?php
require ('PATH_TO_AUTH');
$groupCode = 'USERS';
$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'getPriceOptionGroup',
'params' => array($sessionID, $groupCode)
);
var_dump (callRPC((Object)$jsonRpcRequest, $host));
?>
