Search 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'); $SearchOptions = new \stdClass(); //$searchObject->Name = 'optionGroupA'; $SearchOptions->Types = ["RADIO"]; $SearchOptions->Pagination = new stdClass(); $SearchOptions->Pagination->Page = 1; $SearchOptions->Pagination->Limit = 200; $jsonRpcRequest = new stdClass(); $jsonRpcRequest->jsonrpc = '2.0'; $jsonRpcRequest->method = 'searchPriceOptionGroups'; $jsonRpcRequest->params = array($sessionID, $SearchOptions); $jsonRpcRequest->id = $i++; $searchProducts = callRPC($jsonRpcRequest, $host); ?>