This documentation has moved

XML API documentation can now be found at developer.openprovider.com. This page will remain available until September 2026, but will no longer be updated.

The XML API itself is not changing. Your existing integration continues to work.

API Module Financial searchPromotionBillingRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Module Reseller > Search Transactions)
 
Line 1: Line 1:
-
==Module Reseller > Search Transactions==
+
==Module Reseller > Search Promotions==
{| border="1" cellpadding="4"
{| border="1" cellpadding="4"
|- style="background-color:#BBBBBB;"
|- style="background-color:#BBBBBB;"
Line 32: Line 32:
===Using PHP class===
===Using PHP class===
  $request = new OP_Request;
  $request = new OP_Request;
-
  $request->setCommand('searchTransactionResellerRequest')
+
  $request->setCommand('searchPromotionBillingRequest')
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setArgs(array(
   ->setArgs(array(

Current revision as of 14:30, 29 September 2020

Contents

Module Reseller > Search Promotions

Module reseller
Command name searchPromotionBillingRequest
Use Retrieves all running and future promotions
Input
Output
  • promotionId
  • tld
  • currency
  • memberPrice
  • promoPrice
  • operation
  • period
  • periodUnit
  • startDate
  • endDate
  • applicableForMembers

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('searchPromotionBillingRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
  ));

Raw XML

Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <searchPromotionBillingRequest>
  </searchPromotionBillingRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc />
    <data>
      <results>
        <array>
          <item>
            <promotionId>1293</promotionId>
            <tld>rent</tld>
            <currency>USD</currency>
            <memberPrice>45.18</memberPrice>
            <promoPrice>15.18</promoPrice>
            <operation>create</operation>
            <period>1</period>
            <periodUnit>year</periodUnit>
            <startDate>2019-10-04</startDate> 
            <endDate>2020-12-31</endDate> 
            <applicableForMembers>supreme</applicableForMembers>
          </item>
          <item>
            <promotionId>1494</promotionId>
            <tld>agency</tld>
            <currency>USD</currency>
            <memberPrice>14.18</memberPrice>
            <promoPrice>2.68</promoPrice>
            <operation>create</operation>
            <period>1</period>
            <periodUnit>year</periodUnit>
            <startDate>2020-05-01</startDate>
            <endDate>2020-12-31</endDate>
            <applicableForMembers>supreme</applicableForMembers>
          </item>
        </array>
      </results>
    </data>
  </reply>
</openXML>
Views
Personal tools