Sign in
Orders

Retrieve the order delta metrics of an order

Note: This operation is only available if you have the Order Delta Metrics feature enabled. The Orders feature must be enabled before you can access Order Delta Metrics.

Retrieves the Order Delta Metrics of a specified order, including the following metrics:

Order Delta Metrics are generated asynchronously after an order is completed. Use the generationStatus field in the response to tell whether the metrics are ready. If generationStatus is PROCESSING, the metrics are not available yet and you can retry the request later.

get/v1/orders/deltaMetrics/{orderNumber}

Request

  • Base URL: https://rest.test.zuora.com
  • URL: https://rest.test.zuora.com/v1/orders/deltaMetrics/{orderNumber}
  • Auth: HTTP bearer

Path parameters

orderNumberstring required

The number of the existing order.

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.

Authorizationstring

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

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

The minor API version.

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

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.

Response

OK

generationStatus'PROCESSING' | 'COMPLETED' | 'ERROR'

The status of the Order Delta Metrics generation for the order.

  • PROCESSING - The metrics are not available yet, either because the order is not completed, or because the asynchronous generation is still in progress. Retry the request later.

For orders whose status is Draft or Scheduled, generationStatus is always PROCESSING because Order Delta Metrics are not generated until the order is completed.

  • COMPLETED - The metrics have been generated. Note that the metrics arrays can still be empty if the order does not produce any metric.

  • ERROR - The metrics could not be retrieved. Retry the request later, and contact Zuora Global Support if the error persists.

processIdstring

The ID of the process that handles the operation.

requestIdstring uuid

Unique identifier of the request.

successboolean

Indicates whether the call succeeded.

Example response

{
  "orderDeltaMetrics": {
    "orderDeltaTcb": [
      {
        "currency": "USD"
      }
    ],
    "orderDeltaTcv": [
      {
        "currency": "USD"
      }
    ]
  }
}

Changes

No operation changes recorded.