Skip to content

IntegrationLogApi.md

Latest commit

 

History

History
306 lines (197 loc) · 9.83 KB

IntegrationLogApi.md

File metadata and controls

306 lines (197 loc) · 9.83 KB

UltraCartRestApiV2.IntegrationLogApi

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

Method HTTP request Description
getIntegrationLog GET /integration_log/query/{pk}/{sk} Retrieve an integration log
getIntegrationLogFile GET /integration_log/query/{pk}/{sk}/{uuid} Retrieve an integration log file
getIntegrationLogFilePdf GET /integration_log/query/{pk}/{sk}/{uuid}/pdf Retrieve an integration log file converted to PDF
getIntegrationLogSummariesQuery POST /integration_log/summary/query Retrieve integration log summaries
getIntegrationLogsQuery POST /integration_log/query Retrieve integration logs

getIntegrationLog

IntegrationLogResponse getIntegrationLog(pk, sk)

Retrieve an integration log

Retrieve an integration logs from the account based identifiers

Example

var ucApi = require('ultra_cart_rest_api_v2');
const { apiClient } = require('../api.js'); // https://github.com/UltraCart/sdk_samples/blob/master/javascript/api.js
let apiInstance = new ucApi.IntegrationLogApi(apiClient);

// This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
// As such, this might not be the best way to use this object.
// Please see https://github.com/UltraCart/sdk_samples for working examples.

let pk = "pk_example"; // String | 
let sk = "sk_example"; // String | 
apiInstance.getIntegrationLog(pk, sk, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pk String
sk String

Return type

IntegrationLogResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

getIntegrationLogFile

File getIntegrationLogFile(pk, sk, uuid)

Retrieve an integration log file

Retrieve an integration log file from the account based identifiers

Example

var ucApi = require('ultra_cart_rest_api_v2');
const { apiClient } = require('../api.js'); // https://github.com/UltraCart/sdk_samples/blob/master/javascript/api.js
let apiInstance = new ucApi.IntegrationLogApi(apiClient);

// This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
// As such, this might not be the best way to use this object.
// Please see https://github.com/UltraCart/sdk_samples for working examples.

let pk = "pk_example"; // String | 
let sk = "sk_example"; // String | 
let uuid = "uuid_example"; // String | 
apiInstance.getIntegrationLogFile(pk, sk, uuid, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pk String
sk String
uuid String

Return type

File

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

getIntegrationLogFilePdf

File getIntegrationLogFilePdf(pk, sk, uuid)

Retrieve an integration log file converted to PDF

Retrieve an integration log file from the account based identifiers

Example

var ucApi = require('ultra_cart_rest_api_v2');
const { apiClient } = require('../api.js'); // https://github.com/UltraCart/sdk_samples/blob/master/javascript/api.js
let apiInstance = new ucApi.IntegrationLogApi(apiClient);

// This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
// As such, this might not be the best way to use this object.
// Please see https://github.com/UltraCart/sdk_samples for working examples.

let pk = "pk_example"; // String | 
let sk = "sk_example"; // String | 
let uuid = "uuid_example"; // String | 
apiInstance.getIntegrationLogFilePdf(pk, sk, uuid, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pk String
sk String
uuid String

Return type

File

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

getIntegrationLogSummariesQuery

IntegrationLogSummaryQueryResponse getIntegrationLogSummariesQuery(integration_log_summaries_query)

Retrieve integration log summaries

Retrieves a set of integration log summaries from the account based on a query object.

Example

var ucApi = require('ultra_cart_rest_api_v2');
const { apiClient } = require('../api.js'); // https://github.com/UltraCart/sdk_samples/blob/master/javascript/api.js
let apiInstance = new ucApi.IntegrationLogApi(apiClient);

// This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
// As such, this might not be the best way to use this object.
// Please see https://github.com/UltraCart/sdk_samples for working examples.

let integration_log_summaries_query = new UltraCartRestApiV2.IntegrationLogSummaryQueryRequest(); // IntegrationLogSummaryQueryRequest | Integration log summaries query
apiInstance.getIntegrationLogSummariesQuery(integration_log_summaries_query, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
integration_log_summaries_query IntegrationLogSummaryQueryRequest Integration log summaries query

Return type

IntegrationLogSummaryQueryResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

getIntegrationLogsQuery

IntegrationLogQueryResponse getIntegrationLogsQuery(integration_log_query, opts)

Retrieve integration logs

Retrieves a set of integration logs from the account based on a query object.

Example

var ucApi = require('ultra_cart_rest_api_v2');
const { apiClient } = require('../api.js'); // https://github.com/UltraCart/sdk_samples/blob/master/javascript/api.js
let apiInstance = new ucApi.IntegrationLogApi(apiClient);

// This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
// As such, this might not be the best way to use this object.
// Please see https://github.com/UltraCart/sdk_samples for working examples.

let integration_log_query = new UltraCartRestApiV2.IntegrationLogQueryRequest(); // IntegrationLogQueryRequest | Integration log query
let opts = {
  '_limit': 100, // Number | The maximum number of records to return on this one API call. (Default 100, Max 500)
  '_offset': 0, // Number | Pagination of the record set.  Offset is a zero based index.
  '_sort': "_sort_example" // String | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
};
apiInstance.getIntegrationLogsQuery(integration_log_query, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
integration_log_query IntegrationLogQueryRequest Integration log query
_limit Number The maximum number of records to return on this one API call. (Default 100, Max 500) [optional] [default to 100]
_offset Number Pagination of the record set. Offset is a zero based index. [optional] [default to 0]
_sort String The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. [optional]

Return type

IntegrationLogQueryResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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