Retrieve the status and response of a job

GET

/v1/async-jobs/:jobId

GET

/v1/async-jobs/:jobId

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.orders.get_job_status_and_response(
    job_id="jobId",
)

{
  "errors": null,
  "result": {
    "jobType": "AsyncPreviewOrder",
    "success": true,
    "accountNumber": "A00000001",
    "invoiceNumbers": [
      "INV00000001"
    ],
    "orderLineItems": [
      {
        "id": "bd78c0522adf42c2aa0fccacc997fa20",
        "itemNumber": "116"
      }
    ],
    "orderNumber": "OM-00002",
    "paidAmount": "300",
    "paymentNumber": "P-00000002",
    "status": "Pending",
    "subscriptions": [
      {
        "status": "Pending Activation",
        "subscriptionNumber": "SM-00001"
      },
      {
        "status": "Pending Acceptance",
        "subscriptionNumber": "SM-00002"
      },
      {
        "status": "Active",
        "subscriptionNumber": "SM-00003"
      },
      {
        "status": "Pending Acceptance",
        "subscriptionNumber": "SM-00004"
      }
    ]
  },
  "status": "Completed",
  "success": true
}

Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features 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.

Authentication

AuthorizationBearer

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

Path parameters

jobIdstringRequiredformat: "UUID"

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

Headers

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.

Response headers

Content-EncodingstringOptional

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

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional

The Zuora internal identifier of the API call. You cannot control the value of this header.

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.

Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

errorsstring or nullOptional

Error messages returned if the job failed.

resultobjectOptional

Variant:

statusenumOptional

Type of job status.

Allowed values:

successbooleanOptional

Indicates whether the operation call succeeded.

Errors

4XX

Client Request Error

500

Internal Server Error