Skip to main content

Post Query with API Version

Zuora

Post Query with API Version

  1. Last updated
  2. Save as PDF

This REST API submits an aggregate query with a specified API version, using the apiVersion query parameter. For integration purposes specify the apiVersion to ensure consistent and reliable query performance. For many other reporting purposes you do not have to specify the apiVersion and by default AQuA uses the latest Zuora API version to execute the query.

Request

Environment Request

Production for US Cloud Data Center 2

 POST https://rest.zuora.com/v1/batch-query/
API Sandbox for US Cloud Data Center 2 POST https://rest.apisandbox.zuora.com/v1/batch-query/
US Performance Test POST https://rest.pt1.zuora.com/v1/batch-query/
Production for US Cloud Data Center 1 POST https://rest.na.zuora.com/v1/batch-query/
API Sandbox for US Cloud Data Center 1 POST https://rest.sandbox.na.zuora.com/v1/batch-query/
Central Sandbox for US Cloud Data Center POST https://rest.test.zuora.com/v1/batch-query/
Production for EU Cloud Data Center POST https://rest.eu.zuora.com/v1/batch-query/
Sandbox for EU Cloud Data Center POST https://rest.sandbox.eu.zuora.com/v1/batch-query/
Central Sandbox for EU Cloud Data Center POST https://rest.test.eu.zuora.com/v1/batch-query/

Request Parameters

format

The supported values are csv, zip and gzip. The default value is csv.

version

The API version you want to use. Supported versions:

  • 1.1 Supports both modes
  • 1.0 Default. Supports Stateless mode only

See Stateless and Stateful Modes for more information.

name

The name of the job. 32 character limit.

encrypted

If enabled, you must supply the formatting (zip or unzip) first and decrypt it to get the actual contents.
Supported values are: pgp and none. 

partner

The partner field indicates the unique ID of a data integration partner. The dropdown list of this field displays partner IDs for the past thirty days.

It must be used together with "project" field to uniquely identify a data integration target.  

For example, if a continuous AQuA session is to retrieve data incrementally for a

Salesforce.com Org 00170000011K3Ub, you can use partner as "Salesforce", and "project" as "00170000011K3Ub." 

This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.

Zuora highly recommends you use the stateless mode instead of the stateful mode to extract bulk data. See Bulk data extraction from Zuora using AQuA for best practices.

Submit a request at Zuora Global Support to obtain a partner ID.

project

The project field contains the unique ID of a data integration project for a particular partner. The dropdown list of this field displays project IDs for the past thirty days.

This field must be used together with partner field to uniquely identify a data integration target. 

This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.

dateTimeUtc

When using WSDL 69 and later you can ensure that the exported output of dateTime records are rendered according to ISO-8601 generic UTC form by setting dateTimeUtc to "true".

When "dateTimeUtc" is set to "true", exports of dateTime data types will be rendered in the following generic format: 
  YYYY-MM-DDThh:mm:ss-hhmm or 
  YYYY-MM-DDThh:mm:ss+hhmm  

NOTE: Regardless of what batchType query is used (zoql or zoqlexport), the query response output for datetime data types can be standardized by setting dateTimeUtc to true. When true, the results will display datetime types with the format: YYYY-MM-DDThh:mm:ss+/-hhmm.  

queries

A JSON Array object that contains a list of query objects. The list of query objects are name and query.

name

The name of the job. 32 character limit.

query

A valid ZOQL query or Export ZOQL query statement.

type

The job execution type. The value can be zoql or zoqlexport.

apiVersion

The API version for the query. If an API version is not specified, the latest version is used by default. Using the latest WSDL version is most useful for reporting use cases. For integration purposes, specify the WSDL version to ensure consistent query behavior, i.e., what is supported and included in the response returned by the API.

As of API version 69 and later, Zuora changed the format of certain fields. See Date Field Changes in the SOAP API for more information and a list of affected fields.

deleted

This indicates that the AQuA incremental load will retrieve deleted records.

column

Name of the Column in the extracted file that points to the deleted records. 

format

Can be set to either “Numeric” or “Boolean.” If set to Numeric, deleted records are marked as 1. If set to Boolean, deleted records are marked as “true.”

Response Parameters

batches

A JSON array object that contains a list of batch objects.

deleted

This indicates that the AQuA incremental load will retrieve deleted records.

column

Name of the Column in the extracted file that points to the deleted records. 

format

Can be set to either “Numeric” or “Boolean.” If set to Numeric, deleted records are marked as 1. If set to Boolean, deleted records are marked as “true.”

full

Indicates a full or ncremental load. True = Full and False = Incremental.

name

The name of the job. 32 character limit.

query

A valid ZOQL query or Export ZOQL query statement.

status

The job status. Status types are:

  • Submitted: The job was successfully submitted upon successful validation of the JSON request.
  • Executing: The job is being processed.
  • Completed: The query was executed successfully. Click completed to download a gzip archive of the results.
  • Error: There are some validation errors in the JSON input, and the job ID will not be available.
  • Aborted: The execution stopped because one of the queries failed. Check the error code and error messages for more details.

recordCount

The actual number of records retrieved.

apiVersion

The API version for the query. If an API version is not specified, the latest version is used by default. Using the latest WSDL version is most useful for reporting use cases. For integration purposes, specify the WSDL version to ensure consistent query behavior, i.e., what is supported and included in the response returned by the API.

As of API version 69 and later, Zuora changed the format of certain fields. See Date Field Changes in the SOAP API for more information and a list of affected fields.

batchType

The kind of batch job being submitted. Possible values are zoql or zoqlexport.

batchId

A 32-character ID of the query batch.

project

The project field contains the unique ID of a data integration project for a particular partner. The dropdown list of this field displays project IDs for the past thirty days.

This field must be used together with partner field to uniquely identify a data integration target. 

This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.

partner

The partner field indicates the unique ID of a data integration partner. The dropdown list of this field displays partner IDs for the past thirty days.

It must be used together with "project" field to uniquely identify a data integration target.  

For example, if a continuous AQuA session is to retrieve data incrementally for a

Salesforce.com Org 00170000011K3Ub, you can use partner as "Salesforce", and "project" as "00170000011K3Ub." 

This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.

Zuora highly recommends you use the stateless mode instead of the stateful mode to extract bulk data. See Bulk data extraction from Zuora using AQuA for best practices.

Submit a request at Zuora Global Support to obtain a partner ID.

notifyUrl

If URL is provided, the AQuA job will call this notifyUrl once the job has completed. 

name

The name of the job. 32 character limit.

id

The job ID created for the AQuA API request. The job ID can be used for querying for the query status.
The ID exists only if the JSON request can be parsed and validated successfully. Otherwise, the job ID is null.

version

The API version you want to use. Supported versions:

  • 1.1 Supports both modes
  • 1.0 Default. Supports Stateless mode only

See Stateless and Stateful Modes for more information.

format

The supported values are csv, zip and gzip. The default value is csv.

startTime

The start time of the query. 

status

The job status. Status types are:

  • Submitted: The job was successfully submitted upon successful validation of the JSON request.
  • Executing: The job is being processed.
  • Completed: The query was executed successfully. Click completed to download a gzip archive of the results.
  • Error: There are some validation errors in the JSON input, and the job ID will not be available.
  • Aborted: The execution stopped because one of the queries failed. Check the error code and error messages for more details.

encrypted

If enabled, you must supply the formatting (zip or unzip) first and decrypt it to get the actual contents.
Supported values are: pgp and none. 

JSON Example

Example 1

This example shows submitting a JSON request with the apiVersion = 58.0.

HTTP request:

POST https://www.zuora.com/apps/api/batch-query/

POST https://apisandbox.zuora.com/apps/api/batch-query/

JSON request:

{
    "format": "csv",
    "version": "1.1",
    "name": "Example",
    "encrypted": "none",
    "partner": "salesforce",
    "project": "00170000011K3Ub",
    "queries": [
        {
            "name": "Account",
            "query": "select UpdatedDate from ProductRatePlanCharge",
            "type": "zoqlexport",
            "apiVersion": "58.0",
            "deleted": {
                "column": "Deleted",
                "format": "Boolean"
            }
        }
    ]
}

Successful JSON response:

{
    "batches": [
        {
            "deleted": {
                "column": "Deleted",
                "format": "Boolean"
            },
            "full": true,
            "name": "Account",
            "query": "select UpdatedDate from ProductRatePlanCharge",
            "status": "pending",
            "recordCount": 0,
            "apiVersion": "58.0",
            "batchType": "zoqlexport",
            "batchId": "402881824835bb2a0148463a2c3804d0"
        }
    ],
    "project": "00170000011K3Ub",
    "partner": "salesforce",
    "name": "Example",
    "id": "402881824835bb2a0148463a2c3704cf",
    "version": "1.1",
    "format": "CSV",
    "status": "submitted",
    "encrypted": "none"
}

Example 2

This example shows submitting a JSON request with the apiVersion= 19.0.

HTTP request:

POST https://www.zuora.com/apps/api/batch-query/

POST https://apisandbox.zuora.com/apps/api/batch-query/

{
    "format": "csv",
    "version": "1.1",
    "name": "Example",
    "encrypted": "none",
    "partner": "salesforce",
    "project": "00170000011K3Ub",
    "notifyUrl" : "http://requestb.in/1ju8vhu1",
    "queries": [
        {
            "name": "Account",
            "query": "select Id,ProductRatePlan.Id,BillCycleDay,AccountingCode,ChargeModel,ChargeType,Description,Name,UpdatedDate from ProductRatePlanCharge",
            "type": "zoqlexport",
            "apiVersion": "19.0",
            "deleted": {
                "column": "Deleted",
                "format": "Boolean"
            }
        }
    ]
}

JSON response with error:

Error.zoql.noSuchFieldId\n