Sign in
Bulk Data

Retrieve the summary of a bulk job

Get the summary of a specific job by its ID. This operation returns a summary of the specified bulk job.

get/bulk-data/bulk-jobs/{id}/summary

Path parameters

idstring uuid required

The unique identifier of the job whose summary is being queried.

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Response

Job summary retrieved successfully

idstring uuid

Unique identifier for the job

namestring

Name of the job

descriptionstring

Description of the job

createdAtinteger

Time the job was created

createdBystring

User who created the job

status'Created' | 'Submitted' | 'In Progress' | 'Aborting' | 'Completed' | 'Failed' | 'Aborted' | 'Cancelled' | 'Downloading'

Status of the job

rowCountinteger

Number of rows in the job

rowsSucceededinteger

Number of rows that succeeded in the job

rowsFailedinteger

Number of rows that failed in the job

lastUpdatedAtinteger

Time the job was last updated

failureReasonstring

Reason the job failed

objectTypestring

Type of object the job is for

jobType'Import' | 'Delete' | 'Update' | 'Cancel'

Type of job

isCustomObjectboolean

Whether the job is for a custom object

customObjectNamespacestring

Namespace of the custom object the job is for

dataSourceType'UserUpload' | 'Salesforce' | 'Chargebee' | 'Stripe'

Type of data source the job is for

systemType'BILLING'

Type of system the job is for

fileType'csv' | 'jsonl'

Type of the source file

Changes

No recorded changes to this endpoint across all 4 revisions of this API.