This API is deprecated, please see Batch upload status

❗️

Deprecated

This API is deprecated, please see Batch upload status

KeyDescription
companyIdOur company id
statusThe status of the upload
originalNameThe original name of the file you oploaded
convertedNameThe converted name of the file. It would only be difference from originalName, if you didn't uploaded a JSON file
mimeTypeThe mime type of the file you oploaded
processPercentHow many procent of the task that have been processed
doneHow many of the orders that's done processing. Only orders without errors will count
failedHow many of the orders that have failed the processing
orderIdsThe list of order ids that have been created
errorsAn array that contains information of why the failed orders failed. Can be used to correct the errors.

status

This is a list of all the different status the batch upload can have

statusDescription
initThis is the status when the upload starts
uploadedThis is the status when the file have been uploaded
uploadFailThis is the status if the file haven't been uploaded
convertingThis is the status when the file is being converted
convertedThis is the status when the file have been converted
convertFailThis is the status when the file haven't been converted due to an error
processingThe is the status when the file is being processed
processFailThe is the status when the file haven't been processed due to an error
sentToTraySorterThis is the status when all the orders is being send to the tray sorter. This is also the status when the batch upload is finished

errors

errors is an array containing object of information on what went wrong. An object in errors could look like this:

{
    "index" : 0,
    "path" : [ 
        "", 
        "origin", 
        "phone", 
        "number"
    ],
    "message" : "should be number,null"
}

A more detail description of the keys in the object:

KeyDescription
indexTells which order went wrong. It starts from 0
pathThe path in the order object where in went wrong. In the example it's the origins phone number.
messageDescribes what was wrong. In the example the message is the origins phone number should be a number
Language
Click Try It! to start a request and see the response here!