Skip to content

AffiliateApi.md

Latest commit

 

History

History
116 lines (76 loc) · 5.33 KB

AffiliateApi.md

File metadata and controls

116 lines (76 loc) · 5.33 KB

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

AffiliateClicksResponse getClicksByQuery(clickQuery, 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

package affiliate;

public class GetClicksByQuery {
    // The Affiliate API is internal.  We do not envision a merchant needing this API.
}

Parameters

Name Type Description Notes
clickQuery AffiliateClickQuery Click query
limit Integer The maximum number of records to return on this one API call. (Maximum 10000) [optional] [default to 10000]
offset Integer 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

AffiliateClicksResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

getLedgersByQuery

AffiliateLedgersResponse getLedgersByQuery(ledgerQuery, 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

package affiliate;

public class GetLedgersByQuery {
  // The Affiliate API is internal.  We do not envision a merchant needing this API.
}

Parameters

Name Type Description Notes
ledgerQuery AffiliateLedgerQuery Ledger query
limit Integer The maximum number of records to return on this one API call. (Maximum 200) [optional] [default to 100]
offset Integer 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

AffiliateLedgersResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message