Welcome‎ > ‎Version 3‎ > ‎Publisher Api‎ > ‎Methods‎ > ‎4 - Publisher Related‎ > ‎

Get Pending Credits

** The Authentication of this method will change.  If you'd like to be notified of the change, please post in the comment section below so you can be notified before the change. **

Will retrieve a list of pending credits from the system based on the query.

Method: GET /api/v3/publisher/pendingcredits
Authentication: oauth
 
Parameters
Required QueryString Value
Explanation
No
AwardTriggerType
If provided, only pending credits with this AwardTriggerType will be returned.
No
CampaignKey
If provided, only pending credits with this CampaignKey will be reutrned.
No
EmailAddress
If provided, only pending credits for this EmailAddress will be returned.
No
ExpirationDateRange
If provided, only pending credits within this date range will be returned.
No
PageSize
The number of pending credits to return per page. Default is 100
No
PageNumber The page number of pending credits to return. Default is 1

Returns
pendingCredits - Will return a list of Pending Credit.
base response fields

Sample Request:

GET http://api.groupcommerce.com/api/v3/publisher/pendingcredits?pagenumber=1&pagesize=10&ExpirationDateRange=t585633600-t935467200&EmailAddress=pendingcredits@groupcommerce.com&CampaignKey=heart-of-it-all&AwardTriggerType=ForNextPurchase


Authorization: OAuth oauth_signature="ng2b24QIw%2Bo22w0K4H6EHJ2lC8Q%3D", oauth_nonce="3823130", oauth_timestamp="1347493045", oauth_consumer_key="eeb6b959-b854-4ad1-b563-e801c83cf81d", oauth_signature_method="HMAC-SHA1", oauth_version="1.0"

Sample JSON Response:

{
    "errors": [],
    "lastPublished": "/Date(1347493045518)/",
    "success": true,
    "version": "3",
    "metaData": {
        "pageCount": 1,
        "pageNumber": 1,
        "pageSize": 10,
        "totalItems": 3
    },
    "pendingCredits": [
        {
            /* see pending credit */
        },
        {
            /* see pending credit */
        }
    ]
}


Sample XML Response:

<getPendingCreditsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <errors />
  <lastPublished>2012-09-12T23:39:55.1790157Z</lastPublished>
  <success>true</success>
  <version>3</version>
  <metaData>
    <pageCount>1</pageCount>
    <pageNumber>1</pageNumber>
    <pageSize>10</pageSize>
    <totalItems>3</totalItems>
  </metaData>
  <pendingCredits>
        <pendingCredit>
            <!--
see pending credit -->
        </pendingCredit>

        <pendingCredit>
            <!--
see pending credit -->
        </pendingCredit>

  </pendingCredits>
</getPendingCreditsResponse>
Comments