OrderCsvImport Data Type

Metadata for a CSV batch import file uploaded to the platform. Contains parsing configuration, import status, and a link to retrieve individual imported order lines.

Available Since
1.4.86
Properties
Name Type Description
id number Unique numeric identifier for the csv import.
fileName string The name of the csv file.
createdDate number The autogenerated date and time (ISO 8601 format) when the file was uploaded.
processedDate number The autogenerated date and time (ISO 8601 format) when the file was completely processed.
processed boolean Wheter the csv file was completely processed.
error boolean Whether a processing error occurred during CSV import.
errorMessage string Human-readable description of the import error, if any.
Used in
POST /accounts/{accountId}/shops/{shopId}/orderCsvImport response GET /accounts/{accountId}/shops/{shopId}/orderCsvImport/{id} response
OrderCsvImport (JSON) 
{
  "productionOrderCsvImport" : {
    "id" : 12345,
    "fileName" : "orders.csv",
    "createdDate" : 12345,
    "processedDate" : 12345,
    "processed" : true,
    "error" : true,
    "errorMessage" : "..."
  }
}
OrderCsvImport Data Type

Metadata for a CSV batch import file uploaded to the platform. Contains parsing configuration, import status, and a link to retrieve individual imported order lines.

Available Since
1.4.86
Properties
Name Type Description
createdDate dateTime The autogenerated date and time (ISO 8601 format) when the file was uploaded.
error boolean Whether a processing error occurred during CSV import.
errorMessage string Human-readable description of the import error, if any.
fileName string The name of the csv file.
id int Unique numeric identifier for the csv import.
processed boolean Wheter the csv file was completely processed.
processedDate dateTime The autogenerated date and time (ISO 8601 format) when the file was completely processed.
Used in
POST /accounts/{accountId}/shops/{shopId}/orderCsvImport response GET /accounts/{accountId}/shops/{shopId}/orderCsvImport/{id} response
OrderCsvImport (XML) 
<productionOrderCsvImport>
  <id>...</id>
  <fileName>orders.csv</fileName>
  <createdDate>2020-10-22T18:02:07+02:00</createdDate>
  <processedDate>2020-10-22T18:02:07+02:00</processedDate>
  <processed>...</processed>
  <error>...</error>
  <errorMessage>...</errorMessage>
</productionOrderCsvImport>