Batch upload status (Deprecated)

This API is deprecated, please see Batch upload status

❗️

Deprecated

This API is deprecated, please see Batch upload status

Key

Description

companyId

Our company id

status

The status of the upload

originalName

The original name of the file you oploaded

convertedName

The converted name of the file. It would only be difference from originalName, if you didn't uploaded a JSON file

mimeType

The mime type of the file you oploaded

processPercent

How many procent of the task that have been processed

done

How many of the orders that's done processing. Only orders without errors will count

failed

How many of the orders that have failed the processing

orderIds

The list of order ids that have been created

errors

An 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

status

Description

init

This is the status when the upload starts

uploaded

This is the status when the file have been uploaded

uploadFail

This is the status if the file haven't been uploaded

converting

This is the status when the file is being converted

converted

This is the status when the file have been converted

convertFail

This is the status when the file haven't been converted due to an error

processing

The is the status when the file is being processed

processFail

The is the status when the file haven't been processed due to an error

sentToTraySorter

This 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:

Key

Description

index

Tells which order went wrong. It starts from 0

path

The path in the order object where in went wrong. In the example it's the origins phone number.

message

Describes 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!