Skip to content

Latest commit

 

History

History
118 lines (82 loc) · 5.61 KB

AffiliateApi.md

File metadata and controls

118 lines (82 loc) · 5.61 KB
Raw

ultracart\v2\AffiliateApi

All URIs are relative to https://secure.ultracart.com/rest/v2

Method HTTP request Description
getClicksByQuery POST /affiliate/clicks/query Retrieve clicks
getLedgersByQuery POST /affiliate/ledgers/query Retrieve ledger entries

getClicksByQuery

\ultracart\v2\models\AffiliateClicksResponse getClicksByQuery($click_query, $_limit, $_offset, $_expand)

Retrieve clicks

Retrieves a group of clicks from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the clicks returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\AffiliateApi::usingApiKey($simple_key);

$click_query = new \ultracart\v2\models\AffiliateClickQuery(); // \ultracart\v2\models\AffiliateClickQuery | Click query
$_limit = 10000; // int | The maximum number of records to return on this one API call. (Maximum 10000)
$_offset = 0; // int | Pagination of the record set.  Offset is a zero based index.
$_expand = "_expand_example"; // string | The object expansion to perform on the result.  Only option is link.

try {
    $result = $apiInstance->getClicksByQuery($click_query, $_limit, $_offset, $_expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AffiliateApi->getClicksByQuery: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
click_query \ultracart\v2\models\AffiliateClickQuery Click query
_limit int The maximum number of records to return on this one API call. (Maximum 10000) [optional] [default to 10000]
_offset int Pagination of the record set. Offset is a zero based index. [optional] [default to 0]
_expand string The object expansion to perform on the result. Only option is link. [optional]

Return type

\ultracart\v2\models\AffiliateClicksResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLedgersByQuery

\ultracart\v2\models\AffiliateLedgersResponse getLedgersByQuery($ledger_query, $_limit, $_offset, $_expand)

Retrieve ledger entries

Retrieves a group of ledger entries from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the ledgers returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\AffiliateApi::usingApiKey($simple_key);

$ledger_query = new \ultracart\v2\models\AffiliateLedgerQuery(); // \ultracart\v2\models\AffiliateLedgerQuery | Ledger query
$_limit = 100; // int | The maximum number of records to return on this one API call. (Maximum 200)
$_offset = 0; // int | Pagination of the record set.  Offset is a zero based index.
$_expand = "_expand_example"; // string | The object expansion to perform on the result.  Only option is link.

try {
    $result = $apiInstance->getLedgersByQuery($ledger_query, $_limit, $_offset, $_expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AffiliateApi->getLedgersByQuery: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
ledger_query \ultracart\v2\models\AffiliateLedgerQuery Ledger query
_limit int The maximum number of records to return on this one API call. (Maximum 200) [optional] [default to 100]
_offset int Pagination of the record set. Offset is a zero based index. [optional] [default to 0]
_expand string The object expansion to perform on the result. Only option is link. [optional]

Return type

\ultracart\v2\models\AffiliateLedgersResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]