Bulk Processing

The bulk APIs let you upload a file that contains many changes to be processed at once. See the individual API endpoints for details on field types and sizes. Bulk processing consists of the following steps:

You upload a JSON file.
System pre-processes the file to validate its contents.

If an error is found, the system does not process the file and returns the processing status indicating the cause of the error.
System places the file in a processing queue.
System processes the file.

You obtain processing results.

To check status, submit a request with the requestId to the bulkStatusRequest endpoint. The status response includes details such as the processing time, objects processed, and errors, as shown in the following example:

{
    "requestId": 100,
    "successRecordCount": 1,
    "failedRecordCount": 2,
    "message": "Time taken to process the bulk request : 100 is 1 seconds",
    "status": "CompletedWithErrors",
    "comments": "Barcode_Insert",
    "response": [
        {
            "hierUnitId": 662,
            "objectNum": 1,
            "recordStatus": "Success"
        },
        {
            "hierUnitId": 662,
            "objectNum": 2,
            "recordStatus": "Error : barcode value already exists"
        },
        {
            "hierUnitId": 662,
            "objectNum": 3,
            "recordStatus": "Error : masterObjNum does not exist"
        }
    ]
}