Skip to navigation
Data LoaderBulk Data

Create a bulk job

View as Markdown

Creates a new bulk job. The job type can be one of Import, Delete, Update, or Cancel. The response includes the job ID and information needed to upload your data file to S3.

Next Step: Upload the File to S3

After creating a bulk job, you must upload the data file to Amazon S3 using the information returned in the uploadFileInfo object. This includes:

  • uploadUrl: The S3 endpoint to which the file must be uploaded.
  • formFields: Key-value pairs to include in a multipart/form-data POST request.
  • jobId: The ID of the job, used for later submission.

You can use the following cURL command to upload the file:

curl --request POST \
  --url '<uploadUrl>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'key=<formFields.key>' \
  --form 'bucket=<formFields.bucket>' \
  --form 'x-amz-algorithm=<formFields["x-amz-algorithm"]>' \
  --form 'x-amz-credential=<formFields["x-amz-credential"]>' \
  --form 'x-amz-date=<formFields["x-amz-date"]>' \
  --form 'Policy=<formFields.Policy>' \
  --form 'x-amz-signature=<formFields["x-amz-signature"]>' \
  --form 'x-amz-security-token=<formFields["x-amz-security-token"]>' \
  --form 'file=@/path/to/your/file.csv'

Note: Always use the exact form field keys returned in the formFields object of the API response. This is a presigned Amazon S3 POST operation and not a Zuora endpoint.

After uploading the file, you must call the “Submit a bulk job for processing” operation endpoint to start processing the job.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Headers

Accept-EncodingstringOptional

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-EncodingstringOptional

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-IdsstringOptional

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-IdsstringOptional

Comma separated IDs. If you have Zuora Multi-Org 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-IdstringOptional<=64 characters

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 (').

Request

This endpoint expects an object.
namestringRequired
Name of the job. Max length is 255 characters
objectTypestringRequired

Type of the object. Supported object types:

  • account
  • accountingcode
  • accountingperiod
  • amendment
  • bill-run
  • bill-run-batches
  • bill-run-filters
  • contact
  • credit-memo
  • credit-memo-from-charge
  • credit-memo-from-invoice
  • debit-memo
  • debit-memo-from-charge
  • debit-memo-from-invoice
  • invoice
  • journal-entry
  • journal-run
  • offer
  • omni-channel-subscription
  • order
  • order-create-order-line-item
  • order-create-subscription-existing-account
  • order-create-subscription-existing-account-with-volume-charge
  • order-create-subscription-with-new-account
  • order-remove-product
  • order-update-subscription-add-product
  • order-update-subscription-change-plan
  • order-update-subscription-price-quantity-change
  • payment
  • payment-profile
  • payment-schedule
  • payment-schedule-item
  • payments-simple
  • payments-unapply
  • price-book-item
  • product
  • product-charge-definition
  • product-rate-plan
  • product-rate-plan-charge
  • product-rate-plan-charge-tier
  • product-rate-plan-definition
  • refund
  • revenue-accounting-code
  • subscription
  • subscription-add-rate-plan
  • subscription-change-rate-plan
  • subscription-remove-rate-plan
  • subscription-update-rate-plan
  • taxation-item
  • unitofmeasure
  • usage
descriptionstringOptional
Short description of the job. Max length is 255 characters
mappingslist of objectsOptional
List of mappings. Each mapping maps a source field to a target field in the object. If the field is an array, the type and arrayType must be specified.
headerslist of stringsOptional
List of headers in the source file. Required if the source file does not have a header row.
rowIdHeaderstringOptional
Header in the source file that contains the row id.
delimiterstringOptional

Delimiter used in the source file. Default is comma. Supported values: comma, tab, pipe, semicolon, colon, caret, tilde, dot/period

hasHeadersbooleanOptional
Indicates if the source file has a header row. Default is false
fileTypeenumOptional

Type of the source file. Supported values: csv, jsonl Default is csv, which means delimited file where the delimiter can be comma but can also be one of the other supported delimiters

Allowed values:
jobTypeenumOptional
Type of the bulk job being created. Default is IMPORT
Allowed values:
isCustomObjectbooleanOptional
Indicates if the object type is a custom object. Default is false
customObjectNamespacestringOptional
Namespace of the custom object. Applicable only when isCustomObject is true. Default namespace is 'default'.

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding request header and the response contains over 1000 bytes of data.

RateLimit-LimitstringOptional
The request limit quota for the time window closest to exhaustion.
RateLimit-Remainingdouble
The number of requests remaining in the time window closest to quota exhaustion.
RateLimit-Resetdouble
The number of seconds until the quota resets for the time window closest to quota exhaustion.
Zuora-Request-IdstringOptional
The Zuora internal identifier of the API call.
Zuora-Track-IdstringOptional
A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Response

Job creation successful
idstringOptionalformat: "uuid"
Unique identifier for the job
uploadUrlstringOptional
URL to upload the file. This is the URL to which the file should be uploaded using a PUT request.
uploadRequestobjectOptional
statusenumOptional
Status of the job
jobTypeenumOptional
Type of the job
Allowed values: