Search promotions

Use the searchPromotions method to extract information on promotions you set up for your account.

Request parameters

Parameter
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:

  • REGULAR

  • GLOBAL

  • SPECIAL_PRICE

  • RENEWAL

Channel

String Channel:

  • ECOMMERCE

  • CHANNEL_MANAGER

  • ALL

ProductCode

String Unique code that you set for each of your products.

Pagination

Object Details below.

Pagination.Limit

Int Set a limit for the number of results that should be returned.

Pagination.Page

Int Set the number of pages that should be returned.

Coupons

String A string composed by comma-separated coupon codes (XYX,GGG,BBBB, etc).

ProductTaxCategoryUUID

String or NULL The UUID of the tax category used for the product. Must be a category existent on your account. Required only for Cumulative promotions.

Request sample

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

try {
    $Discounts = $client->searchPromotions($sessionID, $SearchOptions);
}

catch (SoapFault $e) {
    echo "Discounts: " . $e->getMessage();
    exit;
}

var_dump("Promotions", $Discounts);

Response parameters

Parameter
Type

Array of objects

Last updated

Was this helpful?