All URIs are relative to https://secure.ultracart.com/rest/v2
| Method | HTTP request | Description |
|---|---|---|
| analyzeCustomReport | PUT /datawarehouse/custom_reports/{custom_report_oid}/analysis | Analyze a custom report |
| deleteCustomDashboard | DELETE /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard |
| deleteCustomDashboardSchedule | DELETE /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid} | Delete a custom dashboard schedule |
| deleteCustomReport | DELETE /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report |
| deleteReport | DELETE /datawarehouse/reports/{report_oid} | Delete a report |
| dryRunReportQueries | PUT /datawarehouse/reports/dryrun | Dry run the report queries |
| executeCustomReport | PUT /datawarehouse/custom_reports/{custom_report_oid}/execute | Execute a custom report |
| executeCustomReports | PUT /datawarehouse/custom_reports/execute | Execute a custom reports |
| executeReportQueries | PUT /datawarehouse/reports/execute | Execute the report queries |
| getCustomDashboard | GET /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Get a custom dashboard |
| getCustomDashboardSchedules | GET /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules | Get custom dashboards |
| getCustomDashboards | GET /datawarehouse/custom_dashboards | Get custom dashboards |
| getCustomReport | GET /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report |
| getCustomReportAccountConfig | GET /datawarehouse/custom_reports/account_config | Get custom report account configuration |
| getCustomReportChartPngUploadUrl | GET /datawarehouse/custom_reports/{custom_report_oid}/chart_png | Upload a PNG of a custom report chart |
| getCustomReports | GET /datawarehouse/custom_reports | Get custom reports |
| getReport | GET /datawarehouse/reports/{report_oid} | Get a report |
| getReportDataSet | GET /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set |
| getReportDataSetPage | GET /datawarehouse/reports/dataset/{dataset_uuid}/pages/{page_number} | Get a report data set page |
| getReportWebsocketAuthorization | PUT /datawarehouse/reports/auth | Get report websocket authorization |
| getReports | GET /datawarehouse/reports | Get list of reports available |
| insertCustomDashboard | POST /datawarehouse/custom_dashboards | Create a custom dashboard |
| insertCustomDashboardSchedule | POST /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules | Create a custom dashboard schedule |
| insertCustomReport | POST /datawarehouse/custom_reports | Create a custom report |
| insertReport | POST /datawarehouse/reports | Create a report |
| updateCustomDashboard | PUT /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Update a custom dashboard |
| updateCustomDashboardSchedule | PUT /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid} | Update a custom dashboard schedule |
| updateCustomReport | PUT /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report |
| updateCustomReportAccountConfig | PUT /datawarehouse/custom_reports/account_config | Update custom report account config |
| updateReport | PUT /datawarehouse/reports/{report_oid} | Update a report |
CustomReportAnalysisResponse analyzeCustomReport(customReportOid, analyzeRequest)
Analyze a custom report
Analyze a custom report on the UltraCart account.
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| customReportOid | Integer | The report oid to analyze. | |
| analyzeRequest | CustomReportAnalysisRequest | Request to analyze custom report |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
| 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 |
deleteCustomDashboard(customDashboardOid)
Delete a custom dashboard
Delete a custom dashboard on the UltraCart account.
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| customDashboardOid | Integer | The dashboard oid to delete. |
null (empty response body)
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | No Content | - |
| 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 |
deleteCustomDashboardSchedule(customDashboardScheduleOid, customDashboardOid)
Delete a custom dashboard schedule
delete a custom dashboard schedule on the UltraCart account.
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| customDashboardScheduleOid | Integer | The dashboard schedule oid to delete. | |
| customDashboardOid | Integer | The dashboard oid that owns the schedule. |
null (empty response body)
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 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 |
deleteCustomReport(customReportOid)
Delete a custom report
Delete a custom report on the UltraCart account.
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| customReportOid | Integer | The report oid to delete. |
null (empty response body)
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | No Content | - |
| 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 |
deleteReport(reportOid)
Delete a report
Delete a report on the UltraCart account.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| reportOid | Integer | The report oid to delete. |
null (empty response body)
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | No Content | - |
| 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 |
ReportDryRunQueriesResponse dryRunReportQueries(queryRequest)
Dry run the report queries
Dry run the report queries
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| queryRequest | ReportDryRunQueriesRequest | Dry run request |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| 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 |
CustomReportExecutionResponse executeCustomReport(customReportOid, executionRequest)
Execute a custom report
Execute a custom report on the UltraCart account.
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| customReportOid | Integer | The report oid to execute. | |
| executionRequest | CustomReportExecutionRequest | Request to execute custom report |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
| 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 |
CustomReportsExecutionResponse executeCustomReports(executionRequest)
Execute a custom reports
Execute a custom reports on the UltraCart account.
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| executionRequest | CustomReportsExecutionRequest | Request to execute custom reports |
CustomReportsExecutionResponse
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
| 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 |
executeReportQueries(queryRequest)
Execute the report queries
Execute the report queries
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| queryRequest | ReportExecuteQueriesRequest | Query request |
null (empty response body)
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 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 |
CustomDashboardResponse getCustomDashboard(customDashboardOid)
Get a custom dashboard
Retrieve a custom dashboard
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| customDashboardOid | Integer |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| 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 |
CustomDashboardSchedulesResponse getCustomDashboardSchedules(customDashboardOid)
Get custom dashboards
Retrieve a custom dashboards
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| customDashboardOid | Integer |
CustomDashboardSchedulesResponse
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| 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 |
CustomDashboardsResponse getCustomDashboards()
Get custom dashboards
Retrieve a custom dashboards
(No example for this operation).
This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| 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 |
CustomReportResponse getCustomReport(customReportOid)
Get a custom report
Retrieve a custom report
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| customReportOid | Integer |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| 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 |
CustomReportAccountConfigResponse getCustomReportAccountConfig()
Get custom report account configuration
Retrieve a custom report account configuration
(No example for this operation).
This endpoint does not need any parameter.
CustomReportAccountConfigResponse
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| 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 |
CustomReportChartPngUploadResponse getCustomReportChartPngUploadUrl(customReportOid)
Upload a PNG of a custom report chart
Upload a PNG of a custom report chart
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| customReportOid | Integer | The report oid to upload a chart PNG for. |
CustomReportChartPngUploadResponse
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| 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 |
CustomReportsResponse getCustomReports()
Get custom reports
Retrieve a custom reports
(No example for this operation).
This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| 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 |
ReportResponse getReport(reportOid)
Get a report
Retrieve a report
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| reportOid | Integer |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| 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 |
ReportDataSetResponse getReportDataSet(datasetUuid)
Get a report data set
Retrieve a report data set
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| datasetUuid | String |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| 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 |
ReportDataSetPageResponse getReportDataSetPage(datasetUuid, pageNumber)
Get a report data set page
Retrieve a report data set page
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| datasetUuid | String | ||
| pageNumber | Integer |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| 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 |
ReportAuthResponse getReportWebsocketAuthorization()
Get report websocket authorization
Retrieve a JWT to authorize a report to make a websocket connection.
// (Internal API). No sample for this method as a merchant will never need call it.This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| 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 |
ReportsResponse getReports()
Get list of reports available
Retrieve a list of reports available
// (Internal API). No sample for this method as a merchant will never need call it.This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: Not defined
- Accept: application/json
| 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 |
CustomDashboardResponse insertCustomDashboard(dashboard)
Create a custom dashboard
Create a new custom dashboard on the UltraCart account.
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| dashboard | CustomDashboard | Dashboard to create |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
| 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 |
CustomDashboardScheduleResponse insertCustomDashboardSchedule(customDashboardOid, dashboardSchedule)
Create a custom dashboard schedule
Create a new custom dashboard schedule on the UltraCart account.
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| customDashboardOid | Integer | ||
| dashboardSchedule | CustomDashboardSchedule | Dashboard schedule to create |
CustomDashboardScheduleResponse
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
| 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 |
CustomReportResponse insertCustomReport(report)
Create a custom report
Create a new custom report on the UltraCart account.
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| report | CustomReport | Report to create |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
| 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 |
ReportResponse insertReport(report)
Create a report
Create a new report on the UltraCart account.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| report | Report | Report to create |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
| 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 |
CustomDashboardResponse updateCustomDashboard(customDashboardOid, dashboard)
Update a custom dashboard
Update a custom dashboard on the UltraCart account.
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| customDashboardOid | Integer | The dashboard oid to custom update. | |
| dashboard | CustomDashboard | Dashboard to custom update |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
| 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 |
CustomDashboardResponse updateCustomDashboardSchedule(customDashboardScheduleOid, customDashboardOid, dashboardSchedule)
Update a custom dashboard schedule
Update a custom dashboard schedule on the UltraCart account.
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| customDashboardScheduleOid | Integer | The dashboard schedule oid to update. | |
| customDashboardOid | Integer | The dashboard oid to update. | |
| dashboardSchedule | CustomDashboardSchedule | Dashboard schedule to update |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
| 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 |
CustomReportResponse updateCustomReport(customReportOid, report)
Update a custom report
Update a custom report on the UltraCart account.
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| customReportOid | Integer | The report oid to custom update. | |
| report | CustomReport | Report to custom update |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
| 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 |
CustomReportAccountConfigResponse updateCustomReportAccountConfig(accountConfig)
Update custom report account config
Update custom report account config.
(No example for this operation).
| Name | Type | Description | Notes |
|---|---|---|---|
| accountConfig | CustomReportAccountConfig | Account config to update |
CustomReportAccountConfigResponse
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
| 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 |
ReportResponse updateReport(reportOid, report)
Update a report
Update a report on the UltraCart account.
// (Internal API). No sample for this method as a merchant will never need call it.| Name | Type | Description | Notes |
|---|---|---|---|
| reportOid | Integer | The report oid to update. | |
| report | Report | Report to update |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
| 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 |