Skip to main content

Order Data Source

Zuora

Order Data Source

  1. Last updated
  2. Save as PDF

This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. Join the Orders Harmonization Community group for more information. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions. 

Use the Order data source to report on information for a given order. See Overview of Orders for more information about orders.

Accessing the Data Source

​Navigation: Reporting > Data Sources and select Order as the data source.

Data Source Details

The following base and related (joint) objects are available for an order.

Base Object Description

The following table provides descriptions for the base object.

Object Description
Order

Contains the following fields:

  • Category
  • Created By ID
  • Created Date
  • Created By Migration - A Boolean value. The value "true" indicates this order is auto-generated by the system for a subscription or amendment created through the Subscribe and Amend UI and APIs.
  • Description
  • ID
  • Order Date
  • Order Number

The following five fields have values only when the Revert Order order action is performed. If you manually revert order A, order B is automatically generated.

  • Reverted By Order Id - This value is available on order A and indicates the ID of order B.

  • Reversion Order - This value indicates whether this order reverts another order. If this order is order B, the value is TRUE; otherwise, it is FALSE.

  • Reverted Date - This value is available on order A and indicates the execution date of the Revert Order order action. 

  • Reverted Order Id - This value is available on order B and indicates the ID of order A.

  • Reverted Order Number - This value is available on order B and indicates the order number of order A.

  • Scheduled Date - The date when the scheduled order is executed and completed.
  • Scheduled Date Policy - The value must be "SpecificDate".
  • State - The Order state. The possible value is Executing, Complete, or Canceled.
  • Status - The Order status. The possible value is Draft, Pending, Completed, Cancelled, Scheduled, Executing, Failedor Reverted.
  • Updated By ID
  • UpdatedDate
  • Custom Fields

Related Object Description

The following table provides descriptions for related objects.

Object Description
Account

The customer account information. Note this is the Invoice Owner account.
Bill To

The contact associated with the account to whom your product or service is billed.
Default Payment Method

The default payment method used to make payments.
Parent Account

Refers to the parent account associated with the customer account, if applicable.
Sold To

The contact associated with the account to whom your product or service is sold.