Skip to content

Latest commit

 

History

History
122 lines (86 loc) · 5.7 KB

AffiliateApi.md

File metadata and controls

122 lines (86 loc) · 5.7 KB
Raw

ultracart.AffiliateApi

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

Method HTTP request Description
get_clicks_by_query POST /affiliate/clicks/query Retrieve clicks
get_ledgers_by_query POST /affiliate/ledgers/query Retrieve ledger entries

get_clicks_by_query

AffiliateClicksResponse get_clicks_by_query(click_query, limit=limit, offset=offset, expand=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

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.AffiliateApi.fromApiKey(simple_key, False, True)

click_query = ultracart.AffiliateClickQuery() # AffiliateClickQuery | Click query
limit = 10000 # int | The maximum number of records to return on this one API call. (Maximum 10000) (optional) (default to 10000)
offset = 0 # int | Pagination of the record set.  Offset is a zero based index. (optional) (default to 0)
expand = 'expand_example' # str | The object expansion to perform on the result.  Only option is link. (optional)

try:
    # Retrieve clicks
    api_response = api_instance.get_clicks_by_query(click_query, limit=limit, offset=offset, expand=expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AffiliateApi->get_clicks_by_query: %s\n" % e)

Parameters

Name Type Description Notes
click_query 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 str The object expansion to perform on the result. Only option is link. [optional]

Return type

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]

get_ledgers_by_query

AffiliateLedgersResponse get_ledgers_by_query(ledger_query, limit=limit, offset=offset, expand=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

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.AffiliateApi.fromApiKey(simple_key, False, True)

ledger_query = ultracart.AffiliateLedgerQuery() # AffiliateLedgerQuery | Ledger query
limit = 100 # int | The maximum number of records to return on this one API call. (Maximum 200) (optional) (default to 100)
offset = 0 # int | Pagination of the record set.  Offset is a zero based index. (optional) (default to 0)
expand = 'expand_example' # str | The object expansion to perform on the result.  Only option is link. (optional)

try:
    # Retrieve ledger entries
    api_response = api_instance.get_ledgers_by_query(ledger_query, limit=limit, offset=offset, expand=expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AffiliateApi->get_ledgers_by_query: %s\n" % e)

Parameters

Name Type Description Notes
ledger_query 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 str The object expansion to perform on the result. Only option is link. [optional]

Return type

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]