Class Order
The Order resource encapsulates comprehensive information about a transaction made on Google Play. It includes a variety of attributes that provide details about the order itself, the products purchased, and the history of events related to the order. The Orders APIs provide real-time access to your order data within the Google Play ecosystem. You can retrieve detailed information and metadata for both one-time and recurring orders, including transaction details like charges, taxes, and refunds, as well as metadata such as pricing phases for subscriptions. The Orders APIs let you automate tasks related to order management, reducing the need for manual checks via the Play Developer Console. The following are some of the use cases for this API: + Real-time order data retrieval - Get order details and metadata immediately after a purchase using an order ID. + Order update synchronization - Periodically sync order updates to maintain an up-to-date record of order information. Note: + The Orders API calls count towards your Play Developer API quota, which defaults to 200K daily, and may be insufficient to sync extensive order histories. + A maximum of 1000 orders can be retrieved per call. Using larger page sizes is recommended to minimize quota usage. Check your quota in the Cloud Console and request more if required.
Implements
Inherited Members
Namespace: Google.Apis.AndroidPublisher.v3.Data
Assembly: Google.Apis.AndroidPublisher.v3.dll
Syntax
public class Order : IDirectResponseSchema
Properties
BuyerAddress
Address information for the customer, for use in tax computation. When Google is the Merchant of Record for the order, only country is shown.
Declaration
[JsonProperty("buyerAddress")]
public virtual BuyerAddress BuyerAddress { get; set; }
Property Value
Type | Description |
---|---|
BuyerAddress |
CreateTime
object representation of CreateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
CreateTimeDateTimeOffset
DateTimeOffset representation of CreateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
CreateTimeRaw
The time when the order was created.
Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
DeveloperRevenueInBuyerCurrency
Your revenue for this order in the buyer's currency, including deductions of partial refunds, taxes and fees. Google deducts standard transaction and third party fees from each sale, including VAT in some regions.
Declaration
[JsonProperty("developerRevenueInBuyerCurrency")]
public virtual Money DeveloperRevenueInBuyerCurrency { get; set; }
Property Value
Type | Description |
---|---|
Money |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
LastEventTime
object representation of LastEventTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use LastEventTimeDateTimeOffset instead.")]
public virtual object LastEventTime { get; set; }
Property Value
Type | Description |
---|---|
object |
LastEventTimeDateTimeOffset
DateTimeOffset representation of LastEventTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? LastEventTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
LastEventTimeRaw
The time of the last event that occurred on the order.
Declaration
[JsonProperty("lastEventTime")]
public virtual string LastEventTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
LineItems
The individual line items making up this order.
Declaration
[JsonProperty("lineItems")]
public virtual IList<LineItem> LineItems { get; set; }
Property Value
Type | Description |
---|---|
IList<LineItem> |
OrderDetails
Detailed information about the order at creation time.
Declaration
[JsonProperty("orderDetails")]
public virtual OrderDetails OrderDetails { get; set; }
Property Value
Type | Description |
---|---|
OrderDetails |
OrderHistory
Details about events which modified the order.
Declaration
[JsonProperty("orderHistory")]
public virtual OrderHistory OrderHistory { get; set; }
Property Value
Type | Description |
---|---|
OrderHistory |
OrderId
The order ID.
Declaration
[JsonProperty("orderId")]
public virtual string OrderId { get; set; }
Property Value
Type | Description |
---|---|
string |
PointsDetails
Play points applied to the order, including offer information, discount rate and point values.
Declaration
[JsonProperty("pointsDetails")]
public virtual PointsDetails PointsDetails { get; set; }
Property Value
Type | Description |
---|---|
PointsDetails |
PurchaseToken
The token provided to the user's device when the subscription or item was purchased.
Declaration
[JsonProperty("purchaseToken")]
public virtual string PurchaseToken { get; set; }
Property Value
Type | Description |
---|---|
string |
State
The state of the order.
Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type | Description |
---|---|
string |
Tax
The total tax paid as a part of this order.
Declaration
[JsonProperty("tax")]
public virtual Money Tax { get; set; }
Property Value
Type | Description |
---|---|
Money |
Total
The final amount paid by the customer, taking into account discounts and taxes.
Declaration
[JsonProperty("total")]
public virtual Money Total { get; set; }
Property Value
Type | Description |
---|---|
Money |