ZEzentail
Report

Retrieve data for report

Retrieve report data for the supplied reportId.

get/report/{reportId}

Request

  • Base URL
    https://api.zentail.com/v1
  • Auth
    API key in header AUTHORIZATION

Path parameters

reportIdinteger required

You can find the reportId in the response to posting a new Report, in a report GET response, or in the import/export UI.

Response

Success

reportIdinteger
labelstring
isExportboolean

If true, this is an export. Otherwise it's an import.

requestedTsstring date-time

Timestamp when the report was requested to be run.

completedTsstring date-time

Timestamp when the report was completed.

columnTypesstring[]

Array of the column headers in this report.

status'PENDING' | 'PROCESSING' | 'CANCELED' | 'COMPLETE'
totalLinesinteger

Total number of lines processed successfully.

linesSuccessfullyProcessedinteger
filePathstring

Path to access the stored file. Use this to download an exported file when it is "COMPLETE"

errorMessagestring

Returns an error message if we ran into an error processing the report.

overwriteWithBlankboolean

For imports only: If set to true, blank values supplied in the upload data will overwrite. NULL is equivalent to false.

createNewProductsboolean

For imports only: If set to true, if a SKU doesn't exist in zentail we will create one. NULL is equivalent to false.

activeOnlyboolean

For exports only: If set to true, export will only include active products.

insertOnlyboolean

For imports only: If set to true, report will only fill in blank data on Zentail. Any data that already exists on Zentail will not be overwritten by data in the file.

includeHeaderboolean

For exports only: If set to true, export will include a header

exportForExcelboolean

For exports only: If set to true, will export as an Excel file.

filterstring

For exports only: Use this to pass in filters to restrict the products being exported. See how to write a filter formula here.

delimiterstring

For exports only: We will use this delimiter to separate the data in the export.

headersOnlyboolean

For exports only: If true, this export will only have header rows.

uploaderstring

If this is null, then the report was created by the API.

Changes

No recorded changes to this operation across all 1 revision of this API.