Batch Job Status

Get Batch Creation Job Status

You can check on the status of a Create tasks in batch - async by using this endpoint.

Batch Job Status uses a GET request:

curl -X GET "https://onfleet.com/api/v2/tasks/batch/S3oI~WNX4b5cbF1adQxuEeJD" \
       -u "cd3b3de84cc1ee040bf06512d233719c:"
{
    "status": "completedWithErrors",
    "submitted": "Less than a minute ago.",
    "tasksReceived": 3,
    "tasksCreated": 2,
    "tasksErrored": 1,
    "errors": [
        {
            "statusCode": 400,
            "errorCode": 1000,
            "message": "The values of one or more parameters are invalid.",
            "cause": "Geocoding errors found. ",
            "taskData": {
                "destination": {
                    "address": {
                        "number": "420",
                        "street": "Infinite Loop",
                        "city": "Redmond",
                        "state": "WA",
                        "country": "USA"
                    }
                },
                "recipients": [
                    {
                        "name": "S.N.",
                        "phone": "206-341-8826"
                    }
                ]
            }
        }
    ],
    "failedTasks": [
        {
            "destination": {
                "address": {
                    "number": "420",
                    "street": "Infinite Loop",
                    "city": "Redmond",
                    "state": "WA",
                    "country": "USA"
                }
            },
            "recipients": [
                {
                    "name": "S.N.",
                    "phone": "206-341-8826"
                }
            ]
        }
    ],
    "newTasks": [
        {
            "id": "Du5FQzHhUPWgrQGbhjH*1g60",
            "timeCreated": 1685475228000,
            "timeLastModified": 1685475228101,
            "organization": "nYrkNP6jZMSKgBwG9qG7ci3J",
            "shortId": "14e00e4f",
            "trackingURL": "https://onf.lt/14e00e4f",
            "worker": null,
            "merchant": "nYrkNP6jZMSKgBwG9qG7ci3J",
            "executor": "nYrkNP6jZMSKgBwG9qG7ci3J",
            "creator": "vjw*RDMKDljKVDve1Vtcplgu",
            "dependencies": [],
            "state": 0,
            "completeAfter": null,
            "completeBefore": null,
            "pickupTask": true,
            "notes": "12 x 2016 Getariako Txakolina (Rosé)",
            "completionDetails": {
                "failureNotes": "",
                "successNotes": "",
                "failureReason": "NONE",
                "events": [],
                "actions": [],
                "time": null,
                "signatureUploadId": null,
                "photoUploadId": null,
                "photoUploadIds": null,
                "firstLocation": [],
                "lastLocation": [],
                "unavailableAttachments": []
            },
            "feedback": [],
            "metadata": [
                {
                    "type": "number",
                    "visibility": [
                        "api"
                    ],
                    "value": 33162,
                    "name": "caseId"
                }
            ],
            "overrides": {
                "recipientName": null,
                "recipientNotes": null,
                "recipientSkipSMSNotifications": null,
                "useMerchantForProxy": null
            },
            "quantity": 0,
            "additionalQuantities": {
                "quantityA": 0,
                "quantityB": 0,
                "quantityC": 0
            },
            "serviceTime": 0,
            "identity": {
                "failedScanCount": 0,
                "checksum": null
            },
            "appearance": {
                "triangleColor": null
            },
            "scanOnlyRequiredBarcodes": false,
            "container": {
                "type": "ORGANIZATION",
                "organization": "nYrkNP6jZMSKgBwG9qG7ci3J"
            },
            "trackingViewed": false,
            "recipients": [],
            "destination": {
                "id": "bxiJ0IJxyEKA~iDiTtop9oBR",
                "timeCreated": 1685475228000,
                "timeLastModified": 1685475228034,
                "location": [
                    -87.6611882,
                    41.8999943
                ],
                "address": {
                    "apartment": "",
                    "state": "Illinois",
                    "postalCode": "60642",
                    "number": "1264",
                    "street": "West Augusta Boulevard",
                    "city": "Chicago",
                    "country": "United States"
                },
                "notes": "",
                "metadata": [],
                "googlePlaceId": "EisxMjY0IFcgQXVndXN0YSBCbHZkLCBDaGljYWdvLCBJTCA2MDY0MiwgVVNBIjESLwoUChIJC3XaOdTSD4gRvWkApUN78tgQ8AkqFAoSCbEoXPNKzQ-IEfZd3WVEWaiw",
                "warnings": [],
                "useGPS": false
            }
        },
        {
            "id": "1PCBuPGezUle8DpeSc~ytxSM",
            "timeCreated": 1685475228000,
            "timeLastModified": 1685475228358,
            "organization": "nYrkNP6jZMSKgBwG9qG7ci3J",
            "shortId": "05b52298",
            "trackingURL": "https://onf.lt/05b52298b7",
            "worker": null,
            "merchant": "nYrkNP6jZMSKgBwG9qG7ci3J",
            "executor": "nYrkNP6jZMSKgBwG9qG7ci3J",
            "creator": "vjw*RDMKDljKVDve1Vtcplgu",
            "dependencies": [],
            "state": 0,
            "completeAfter": null,
            "completeBefore": null,
            "pickupTask": false,
            "notes": "Order 332: 24oz Stumptown Finca El Puente, 10 x Aji de Gallina Empanadas, 13-inch Lelenitas Tres Leches",
            "completionDetails": {
                "failureNotes": "",
                "successNotes": "",
                "failureReason": "NONE",
                "events": [],
                "actions": [],
                "time": null,
                "signatureUploadId": null,
                "photoUploadId": null,
                "photoUploadIds": null,
                "firstLocation": [],
                "lastLocation": [],
                "unavailableAttachments": []
            },
            "feedback": [],
            "metadata": [],
            "overrides": {
                "recipientName": null,
                "recipientNotes": null,
                "recipientSkipSMSNotifications": null,
                "useMerchantForProxy": null
            },
            "quantity": 0,
            "additionalQuantities": {
                "quantityA": 0,
                "quantityB": 0,
                "quantityC": 0
            },
            "serviceTime": 0,
            "identity": {
                "failedScanCount": 0,
                "checksum": null
            },
            "appearance": {
                "triangleColor": null
            },
            "scanOnlyRequiredBarcodes": false,
            "container": {
                "type": "ORGANIZATION",
                "organization": "nYrkNP6jZMSKgBwG9qG7ci3J"
            },
            "trackingViewed": false,
            "recipients": [
                {
                    "id": "lYJtdciPMZpWksO5zqTnoedw",
                    "timeCreated": 1643147927000,
                    "timeLastModified": 1685475228068,
                    "name": "Blas Silkovich",
                    "phone": "+16505554481",
                    "notes": "Knows Neiman, VIP status.",
                    "organization": "nYrkNP6jZMSKgBwG9qG7ci3J",
                    "skipSMSNotifications": false,
                    "metadata": []
                }
            ],
            "destination": {
                "id": "xFblWCJo2fqpC9nOM23w2gC9",
                "timeCreated": 1685475228000,
                "timeLastModified": 1685475228030,
                "location": [
                    -122.4438376,
                    37.7939987
                ],
                "address": {
                    "apartment": "",
                    "state": "California",
                    "postalCode": "94123",
                    "number": "2829",
                    "street": "Vallejo Street",
                    "city": "San Francisco",
                    "country": "United States"
                },
                "notes": "Small green door by garage door has pin pad, enter *4821*",
                "metadata": [],
                "googlePlaceId": "ChIJQSINYtKAhYARCKOYhQ6z3nI",
                "warnings": [],
                "useGPS": false
            }
        }
    ],
    "newTasksWithWarnings": []
}