Skip to content

IntegrationLogApi.md

Latest commit

 

History

History
241 lines (162 loc) · 10.1 KB

IntegrationLogApi.md

File metadata and controls

241 lines (162 loc) · 10.1 KB

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

// (Internal API).  No sample for this method as a merchant will never need call it.

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

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

getIntegrationLogFile

File getIntegrationLogFile(pk, sk, uuid)

Retrieve an integration log file

Retrieve an integration log file from the account based identifiers

Example

// (Internal API).  No sample for this method as a merchant will never need call it.

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

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

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

// (Internal API).  No sample for this method as a merchant will never need call it.

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

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

getIntegrationLogSummariesQuery

IntegrationLogSummaryQueryResponse getIntegrationLogSummariesQuery(integrationLogSummariesQuery)

Retrieve integration log summaries

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

Example

// (Internal API).  No sample for this method as a merchant will never need call it.

Parameters

Name Type Description Notes
integrationLogSummariesQuery IntegrationLogSummaryQueryRequest Integration log summaries query

Return type

IntegrationLogSummaryQueryResponse

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

getIntegrationLogsQuery

IntegrationLogQueryResponse getIntegrationLogsQuery(integrationLogQuery, limit, offset, sort)

Retrieve integration logs

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

Example

// (Internal API).  No sample for this method as a merchant will never need call it.

Parameters

Name Type Description Notes
integrationLogQuery IntegrationLogQueryRequest Integration log query
limit Integer The maximum number of records to return on this one API call. (Default 100, Max 500) [optional] [default to 100]
offset Integer 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

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