Sign in
Orders

Retrieve the status and response of a job

Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora <a href="https://docs.zuora.com?resourceId=billing-subscribe-and-amend" target="_blank">Subscribe and Amend</a> customer, we recommend you enable <a href="https://docs.zuora.com?resourceId=billing-overview-orders" target="_blank">Orders Harmonization</a> to access the <a href="https://docs.zuora.com?resourceId=billing-overview-orders" target="_blank">Orders</a> feature. With Orders, you can access both existing functions for subscription and billing management and the <a href="https://docs.zuora.com?resourceId=billing-orders-harmonization" target="_blank">new features</a> on Zuora Billing.

Note: The Order Line Items feature is now generally available to all Zuora customers. You need to enable the Orders feature to access the Order Line Items feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on Orders will have the Order Line Items feature enabled by default.

Get the status and response of an asynchronous job. Currently, an asynchronous job created by "Create an order asynchronously" or "Preview an order asynchronously" is supported.

get/v1/async-jobs/{jobId}

Path parameters

jobIdstring UUID required

UUID of the asynchronous job created by an asynchronous API operation.

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

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

errorsstring nullable

Error messages returned if the job failed.

status'Processing' | 'Failed' | 'Completed'

Type of job status.

successboolean

Indicates whether the operation call succeeded.

Example response

{
  "result": {
    "commitments": [
      {
        "prepaymentType": "FullyPrepaid"
      }
    ],
    "refunds": [
      {
        "number": "R-00009564"
      }
    ],
    "writeOff": [
      {
        "invoiceNumber": "INV00051208"
      }
    ]
  }
}

Changes

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