Get Job Status of an Async Bulk Sales Order Import

Request

Path Params

businessUnitId

string

required

bulkJobId

string

required

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Body

data

object (SalesOrderCreateAsyncJob)

optional

A job that represents the state of a bulk import of sales orders.

jobId

string

required

status

enum<string>

required

The initial response that returns the jobId for polling will be in the CREATED status.

Status will be PROCESSING as the batch of items are imported.

COMPLETED means the entire batch has been processed whether or not there were failures. If there were any failures, that should be reflected by adding them to the failedItems array.

Allowed values:

CREATEDINITIATEDPROCESSINGCOMPLETED

failedOrders

array [object {3}]

required

This will be populated with any SalesOrders that failed to import upon completion. The item field on a failed item will contain the original request. If all imports were sucessful, this array will be empty.

progress

object

optional

This would be nice to have when possible, but we're interested to know the level of effort.

Example

{
    "data": {
        "jobId": "string",
        "status": "CREATED",
        "failedOrders": [
            {
                "customerOrderNumber": "string",
                "message": "string",
                "lines": [
                    {
                        "customerLineNumber": "string",
                        "message": "string"
                    }
                ]
            }
        ],
        "progress": {
            "processed": 0,
            "total": 0
        }
    }
}

🟠404Job Not Found