Skip to content

IntegrationLogApi.md

Latest commit

 

History

History
225 lines (137 loc) · 6.54 KB

IntegrationLogApi.md

File metadata and controls

225 lines (137 loc) · 6.54 KB

ultracart\v2\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()

getIntegrationLog($pk, $sk): \ultracart\v2\models\IntegrationLogResponse

Retrieve an integration log

Retrieve an integration logs from the account based identifiers

Example

<?php // Please see the README.md in this directory for an explanation on why there are no samples here.

Parameters

Name Type Description Notes
pk string
sk string

Return type

\ultracart\v2\models\IntegrationLogResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getIntegrationLogFile()

getIntegrationLogFile($pk, $sk, $uuid): \SplFileObject

Retrieve an integration log file

Retrieve an integration log file from the account based identifiers

Example

<?php // Please see the README.md in this directory for an explanation on why there are no samples here.

Parameters

Name Type Description Notes
pk string
sk string
uuid string

Return type

\SplFileObject

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getIntegrationLogFilePdf()

getIntegrationLogFilePdf($pk, $sk, $uuid): \SplFileObject

Retrieve an integration log file converted to PDF

Retrieve an integration log file from the account based identifiers

Example

<?php // Please see the README.md in this directory for an explanation on why there are no samples here.

Parameters

Name Type Description Notes
pk string
sk string
uuid string

Return type

\SplFileObject

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getIntegrationLogSummariesQuery()

getIntegrationLogSummariesQuery($integration_log_summaries_query): \ultracart\v2\models\IntegrationLogSummaryQueryResponse

Retrieve integration log summaries

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

Example

<?php // Please see the README.md in this directory for an explanation on why there are no samples here.

Parameters

Name Type Description Notes
integration_log_summaries_query \ultracart\v2\models\IntegrationLogSummaryQueryRequest Integration log summaries query

Return type

\ultracart\v2\models\IntegrationLogSummaryQueryResponse

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]

getIntegrationLogsQuery()

getIntegrationLogsQuery($integration_log_query, $_limit, $_offset, $_sort): \ultracart\v2\models\IntegrationLogQueryResponse

Retrieve integration logs

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

Example

<?php // Please see the README.md in this directory for an explanation on why there are no samples here.

Parameters

Name Type Description Notes
integration_log_query \ultracart\v2\models\IntegrationLogQueryRequest Integration log query
_limit int The maximum number of records to return on this one API call. (Default 100, Max 500) [optional] [default to 100]
_offset int 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

\ultracart\v2\models\IntegrationLogQueryResponse

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]