Search promotions
Last updated: 05-Feb-2021
Rate this article:
Overview
Use the searchPromotions method to extract information on promotions you set up for your account.
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. |
|
Types |
StringArray |
|
|
Discount type:
|
|
Channel |
String |
|
|
Channel:
|
|
ProductCode |
String |
|
|
Unique code that you set for each of your products. |
| Pagination |
Object. Details below. |
|
Page |
Int |
|
|
Set the number of pages that should be returned. |
|
Limit |
Int |
|
|
Set a limit for the number of results that should be returned. |
| Coupons | String |
| A string composed by comma-separated coupon codes (XYX,GGG,BBBB, etc). |
Response
| Parameters | Type/Description |
|---|---|
| Promotion | Array of objects |
Request
<?php
require ('PATH_TO_AUTH');
$searchOptions = new stdClass();
$searchOptions->Types = array ('REGULAR');
$searchOptions->Channel = 'ECOMMERCE';
$searchOptions->ProductCode = 'Product_Code_1';
$searchOptions->Enabled = TRUE;
$searchOptions->Limit = 99;
$searchOptions->Page = 1;
$searchOptions->Coupons = “81XS55D1,E14SSF17;
$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'searchPromotions',
'params' => array($sessionID, $searchOptions)
);
var_dump (callRPC((Object)$jsonRpcRequest, $host));
?>
Rate this article:
