csharp
java
javascript
php
python
ruby
typescript

integration_log

/integration_log

Retrieve integration logs

Permissions:
  • integration_log_read

Produces: application/json
post
/integration_log/query

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

SDK Function Name: getIntegrationLogsQuery

Parameters
Parameter Description Location Data Type Required
integration_log_query Integration log query body IntegrationLogQueryRequest required
_limit The maximum number of records to return on this one API call. (Default 100, Max 500)
Default: 100
query integer optional
_offset Pagination of the record set. Offset is a zero based index.
Default: 0
query integer optional
_sort The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
Allowed Values
  • status
  • log_dts
  • log_type
  • logger_name
  • action
  • direction
query string optional
Responses
Status Code Reason Response Model
200
Successful response IntegrationLogQueryResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Retrieve an integration log

Permissions:
  • integration_log_read

Produces: application/json
get
/integration_log/query/{pk}/{sk}

Retrieve an integration logs from the account based identifiers

SDK Function Name: getIntegrationLog

Parameters
Parameter Description Location Data Type Required
pk path string optional
sk path string optional
Responses
Status Code Reason Response Model
200
Successful response IntegrationLogResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Retrieve an integration log file

Permissions:
  • integration_log_read

Produces: application/octet-stream
get
/integration_log/query/{pk}/{sk}/{uuid}

Retrieve an integration log file from the account based identifiers

SDK Function Name: getIntegrationLogFile

Parameters
Parameter Description Location Data Type Required
pk path string optional
sk path string optional
uuid path string optional
Responses
Status Code Reason Response Model
200
Successful response file
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Retrieve integration log summaries

Permissions:
  • integration_log_read

Produces: application/json
post
/integration_log/summary/query

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

SDK Function Name: getIntegrationLogSummariesQuery

Parameters
Parameter Description Location Data Type Required
integration_log_summaries_query Integration log summaries query body IntegrationLogSummaryQueryRequest required
Responses
Status Code Reason Response Model
200
Successful response IntegrationLogSummaryQueryResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Error

Attributes
Name Data Type Description
developer_message string A technical message meant to be read by a developer
error_code string HTTP status code
more_info string Additional information often a link to additional documentation
object_id string Object id that the error is associated with
user_message string An end-user friendly message suitable for display to the customer

ErrorResponse

Attributes
Name Data Type Description
error Error Error object if unsuccessful
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

file

Attributes
Name Data Type Description

IntegrationLog

Attributes
Name Data Type Description
action string
direction string
email string
files array of IntegrationLogFile
integration_log_oid integer (int32)
item_id string
item_ipn_oid integer (int32)
log_dts (read only) string (dateTime) Date/time the integration log was created
log_type string
logger_id string
logger_name string
logs array of IntegrationLogLog
omit_log_map boolean
order_ids array of string
pk string
sk string
status string
status_code integer (int32)

IntegrationLogFile

Attributes
Name Data Type Description
mime_type string
name string
size integer (int32)
uuid string

IntegrationLogLog

Attributes
Name Data Type Description
contents string
name string

IntegrationLogQueryFilterValues

Attributes
Name Data Type Description
actions array of string
directions array of string
emails array of string
file_names array of string
item_ids array of string
item_ipn_oids array of integer (int32)
log_dts_max (read only) string (dateTime) Maximum date/time log date/time
log_dts_min (read only) string (dateTime) Minimum date/time log date/time
log_types array of string
logger_names array of string
order_ids array of string
statuses array of string

IntegrationLogQueryRequest

Attributes
Name Data Type Description
action string
direction string
email string
file_names array of string
item_id string
item_ipn_oid integer (int32)
log_dts_begin string (dateTime) Log date/time begin
log_dts_end string (dateTime) Log date/time end
log_type string
logger_id string
logger_name string
order_ids array of string
status string

IntegrationLogQueryResponse

Attributes
Name Data Type Description
error Error Error object if unsuccessful
filter_values IntegrationLogQueryFilterValues
integration_logs array of IntegrationLog
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

IntegrationLogResponse

Attributes
Name Data Type Description
error Error Error object if unsuccessful
integration_log IntegrationLog
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

IntegrationLogSummary

Attributes
Name Data Type Description
critical integer (int32)
error integer (int32)
events integer (int32)
log_type string
logger_id string
logger_name string
success integer (int32)
view_url string
warning integer (int32)

IntegrationLogSummaryQueryRequest

Attributes
Name Data Type Description
log_dts_begin string (dateTime) Log date/time begin
log_dts_end string (dateTime) Log date/time end

IntegrationLogSummaryQueryResponse

Attributes
Name Data Type Description
error Error Error object if unsuccessful
integration_log_summaries array of IntegrationLogSummary
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful
warning Warning Warning object if a non-fatal issue or side-effect occurs

ResponseMetadata

Attributes
Name Data Type Description
payload_name string Payload name
result_set ResultSet Result set

ResultSet

Attributes
Name Data Type Description
count integer (int32) Number of results in this set
limit integer (int32) Maximum number of results that can be returned in a set
more boolean True if there are more results to query
next_offset integer (int32) The next offset that you should query to retrieve more results
offset integer (int32) Offset of this result set (zero based)
total_records integer (int32) The total number of records in the result set. May be null if the number is not known and the client should continue iterating as long as more is true.

Warning

Attributes
Name Data Type Description
more_info string Additional information often a link to additional documentation
warning_message string A technical message meant to be read by a developer

400
Status Code 400: bad request input such as invalid json

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse

401
Status Code 401: invalid credentials supplied

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse

410
Status Code 410: Your authorized application has been disabled by UltraCart

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse

429
Status Code 429: you have exceeded the allowed API call rate limit for your application.

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse

500
Status Code 500: any server side error. the body will contain a generic server error message

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse