uploadAssets
post
/ccadmin/v1/asset/upload
Upload Assets. Upload a csv file containing catalog or inventory items.
Request
Supported Media Types
- application/json
Root Schema : uploadAssets_request
Type:
Show Source
object
-
file:
string
The file bytes encoded in base64.
-
filename:
string
The name of the import file.
Example:
{
"filename":"variants1.xls",
"file":"0M8R4KGxGuEAAAAAAAAAAAAAAAAAAAAAOwADAP7/CQAGAAAAAAAAAAAAAAABAAAAJAAAAAAAAAAAEAAAIgAAAAEAAAD+////AAAAAAAAAAD////////////////////////////////////////////////////////////////////////////////////////////////BFAG4AdAByAHkAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAWAAUA////////////////AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA/v///wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///////////////8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD+////AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAP///////////////wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAP7///8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA////////////////AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA/v///wAAAAAAAAAACQgQAAAGBQC7DcwHAAAAAAYAAADhAAIAsATBAAIAAADiAAAAXABwAAQAAENhbGMgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICBCAAIAsARhAQIAAADAAQAAPQECAAEAnAACAA4ArwECAAAAvAECAAAAPQASAAAAAAAAQAAgOAAAAAAAAQC/AEAAAgAAAI0AAgAAACIAAgAAAA4AAgABALcBAgAAANoAAgAAADEAGgDIAAAA/3+QAQAAAAIAAAUBQQByAGkAYQBsADEAGgDIAAAA/3+QAQAAAAAAAAUBQQByAGkAYQBsADEAGgDIAAAA/3+QAQAAAAAAAAUBQQByAGkAYQBsADEAGgDIAAAA/3+QAQAAAAAAAAUBQQByAGkAYQBsAB4EDACkAAcAAEdFTkVSQUzgABQAAACkAPX/IAAAAAAAAAAAAAAAwCDgABQAAQAAAPX/IAAA9AAAAAAAAAAAwCDgABQAAQAAAPX/IAAA9AAAAAAAAAAAwCDgABQAAgAAAPX/IAAA9AAAAAAAAAAAwCDgABQAAgAAAPX/IAAA9AAAAAAAAAAAwCDgABQAAAAAAPX/IAAA9AAAAAAAAAAAwCDgABQAAAAAAPX/IAAA9AAAAAAAAAAAwCDgABQAAAAAAPX/IAAA9AAAAAAAAAAAwCDgABQAAAAAAPX/IAAA9AAAAAAAAAAAwCDgABQAAAAAAPX/IAAA9AAAAAAAAAAAwCDgABQAAAAAAPX/IAAA9AAAAAAAAAAAwCDgABQAAAAAAPX/IAAA9AAAAAAAAAAAwCDgABQAAAAAAPX/IAAA9AAAAAAAAAAAwCDgABQAAAAAAPX/IAAA9AAAAAAAAAAAwCDgABQAAAAAAPX/IAAA9AAAAAAAAAAAwCDgABQAAACkAAEAIAAAAAAAAAAAAAAAwCDgABQAAQArAPX/IAAA8AAAAAAAAAAAwCDgABQAAQApAPX/IAAA8AAAAAAAAAAAwCDgABQAAQAsAPX/IAAA8AAAAAAAAAAAwCDgABQAAQAqAPX/IAAA8AAAAAAAAAAAwCDgABQAAQAJAPX/IAAA8AAAAAAAAAAAwCCTAgQAAIAA/5MCBAAQgAP/kwIEABGABv+TAgQAEoAE/5MCBAATgAf/kwIEABSABf9gAQIAAQCFAA4AHQUAAAAABgBTaGVldDGMAAQAAQABAMEBCADBAQAAVI0BAOsAWgAPAADwUgAAAAAABvAYAAAAAAQAAAIAAAABAAAAAQAAAAEAAAABAAAAMwAL8BIAAAC/AAgACACBAQkAAAjAAUAAAAhAAB7xEAAAAA0AAAgMAAAIFwAACPcAABD8ALoACwAAAAsAAAAoAAAvYXRnL2NvbW1lcmNlL2NhdGFsb2cvUHJvZHVjdENhdGFsb2c6c2t1AgAASUQLAABkaXNwbGF5TmFtZQoAAGxhcmdlSW1hZ2UOAAB0aHVtYm5haWxJbWFnZQsAACBzbWFsbEltYWdlAwAATkVXCAAAc29tZXNrdTAMAABpbWdjb3JhbGNvdmURAABpbWdjb3JhbGNvdmVUaHVtYhEAAGltZ2NvcmF"
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : uploadAssets_response
Type:
Show Source
object
-
message(optional):
string
Message string describing error if there was an error during file format or file header validation.
-
status(optional):
string
Status flag indicating result of file format and file header validation.
-
token(optional):
string
The unique token for this upload/validation/import operation sequence. Use this token for any subsequent validation, validation status, import or import status operation.
Example Response (application/json)
{
"status":"SUCCESS",
"token":"gWHikhGAm2997147nvFUQZpbgBw_10000"
}
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|
|------------------|------------------|
|13015|Please select a file for import.|
|13016|Bad file extension.|
|13017|The first column must be labeled 'ID'.|
|13018|The first column must be labeled 'catalogRefId'.|
|13019|Only the first column can be labeled 'ID'.|
|13020|Only the first column can be labeled 'catalogRefId'.|
|13021|The itemized format only allows one property column in addition to the 'ID' column.|
|13022|The following property names were not recognized: {0}.|
|13023|The following properties are not editable: {0}.|
|13024|The file is missing the item type and repository path information in the header.|
|13025|The item type and repository path cell could not be read.|
|13026|The repository path {0} could not be found.|
|13027|Cannot import to the repository {0}.|
|13028|The type {0} could not be found.|
|13029|The type {0} is not editable.|
|13030|The date format {0} is not a valid format.|
|13031|The timestamp format {0} is not a valid format.|
|13032|The date format is missing.|
|13033|The timestamp format is missing.|
|13034|There were errors reading the file.|
|13035|Locale key is missing.|
|13036|The language does not match any supported language for the site. Please select another file and try again.|
|13038|Invalid catalog id provided.|
|13039|It is not allowed to import with version 1 (legacy) catalog.|
|13041|It is not allowed to import with filtered view (version 3) catalog.|
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