exportReportData
get
/ccadmin/v1/reports/export
Export Report Data. Export report data as a csv file. There is no json response for this request. The browser will download the csv file directly from the server. Optionally takes the x-ccasset-language header to get translated content in another language.
Request
Supported Media Types
- application/json
Query Parameters
-
billingCountry(optional): string
Billing country ids as comma separated string.
-
billingRegions(optional): string
Billing region ids as comma separated string.
-
categoryTypes(optional): string
Category Types for the deleted, unassigned, allcollection are sent as comma separated string.
-
cateogryIds(optional): string
Category ids as comma separated string.
-
couponCodes(optional): string
Coupon ids as comma separted string.
-
endDate(optional): string
End date of the custom time frame.
-
format: string
Format of the report. Default is CSV
-
groupBy(optional): string
Group by information for the report.
-
metric(optional): string
Metric selected if any.
-
priceListGroups(optional): string
Pricelist groups as comma separted string.
-
productIds(optional): string
Product ids as comma separted string.
-
promotionIds(optional): string
Promotion ids as comma separted string.
-
promotionTypeId(optional): string
Promotion type id
-
reportId: string
Report Id of the report to be downloaded.
-
shippingCountry(optional): string
Shipping country ids as comma separated string.
-
shippingRegions(optional): string
Shipping region ids as comma separated string.
-
siteIds(optional): string
Site ids as comma separated string.
-
startDate(optional): string
Start date of the custom time frame.
-
timeFrame: string
Time frame selected for the report.
-
timeZoneOffset: string
Offset in minutes between the client time zone and UTC time.
-
transactionCurrency(optional): string
currency for the reporting graph.
Header Parameters
-
X-CCAsset-Language(optional): string
The asset language of the request
Response
Supported Media Types
- */*
200 Response
Following model is returned when operation succeeds.
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|94028|emptyReportCacheParameters.|
|94039|invalidParamValue.|
|94027|getReportDataCacheFailed.|
|94015|reportNotConfigured.|
|94003|Product filter transform error.|
|94014|Log off to OBIEE failed.|
|94007|InvalidReportInput.|
|94018|reportDataNotSupported.|
|94064|Transaction currency filter transform error.|
|94063|Transaction currency filter parsing error.|
|94040|fileWriteOperationFailed.|
|94002|Location filter transform error.|
|94013|getSessionFailed.|
|94001|Product filter parsing error.|
|94012|getObieeDataFailed.|
|94023|unconfiguredReportVaribaleError.|
|94000|Location filter parsing error.|
|94066|price list group filter transfrom error.|
|94065|price list group filter parsing error.|
|94074|Site Ids filter parsing error|
|94075|Site Ids filter transform parsing error.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code