Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 2 KB

File metadata and controls

58 lines (38 loc) · 2 KB

BulkJob

Properties

Name Type Description Notes
completedAt String When the job reached a terminal status [optional]
duplicateCount Integer Records short-circuited as duplicates [optional]
errorCode String Job-level failure code when status is failed [optional]
failCount Integer Records that failed [optional]
jobId String Public-facing job id (uc-bulk-<ulid>) [optional]
_object ObjectEnum Object type this job processes [optional]
operation OperationEnum Mutation mode this job runs (the bulk surface is write-only) [optional]
processedRecords Integer Records processed so far [optional]
queuePosition Integer Position behind the merchant's active job (queued jobs only) [optional]
resultsSummaryUrl String Presigned S3 URL to the full per-record results NDJSON (set when finished) [optional]
startedAt String When the worker started the job [optional]
status StatusEnum Job status [optional]
submittedAt String When the job was submitted [optional]
successCount Integer Records that landed [optional]
totalRecords Integer Total records counted on the first pass (null until counted) [optional]

Enum: ObjectEnum

Name Value
ORDER "order"
CUSTOMER "customer"

Enum: OperationEnum

Name Value
INSERT "insert"
UPSERT "upsert"

Enum: StatusEnum

Name Value
QUEUED "queued"
IN_PROGRESS "in_progress"
SUCCEEDED "succeeded"
PARTIAL_SUCCESS "partial_success"
FAILED "failed"
CANCELLED "cancelled"