API Module Financial searchPromotionBillingRequest

From Openprovider API documentation

Revision as of 06:07, 28 September 2020 (view source) WikiSysop (Talk | contribs) (Created page with '==Module Reseller > Search Transactions== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |reseller |- style="background-color:#EEEEEE;" |'''Comm…') ← Older edit		Revision as of 06:07, 28 September 2020 (view source) WikiSysop (Talk | contribs) (→Module Reseller > Search Transactions) Newer edit →
Line 9:		Line 9:
	|-		|-
	|'''Use'''		|'''Use'''
-	|Retrieves a list of transactions from your reseller account	+	|Retrieves all running and future promotions
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
	|'''Input'''		|'''Input'''
Line 16:		Line 16:
	|'''Output'''		|'''Output'''
	|		|
-
	*promotionId		*promotionId
	*tld		*tld

---

Revision as of 06:07, 28 September 2020

Contents 1 Module Reseller > Search Transactions 2 Examples 2.1 Using PHP class 2.2 Raw XML

Module Reseller > Search Transactions

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('searchTransactionResellerRequest')
  ->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>