Class Order

Order. Production access (all methods) requires the order manager role. Sandbox access does not.

Inheritance

System.Object

Order

Implements

Google.Apis.Requests.IDirectResponseSchema

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.ShoppingContent.v2.Data

Assembly: Google.Apis.ShoppingContent.v2.dll

Syntax

public class Order : IDirectResponseSchema

Properties

Acknowledged

Whether the order was acknowledged.

Declaration

[JsonProperty("acknowledged")]
public virtual bool? Acknowledged { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ChannelType

Deprecated. Acceptable values are: - "googleExpress" - "purchasesOnGoogle"

Declaration

[JsonProperty("channelType")]
public virtual string ChannelType { get; set; }

Property Value

Type	Description
System.String

Customer

The details of the customer who placed the order.

Declaration

[JsonProperty("customer")]
public virtual OrderCustomer Customer { get; set; }

Property Value

Type	Description
OrderCustomer

DeliveryDetails

Delivery details for shipments of type delivery.

Declaration

[JsonProperty("deliveryDetails")]
public virtual OrderDeliveryDetails DeliveryDetails { get; set; }

Property Value

Type	Description
OrderDeliveryDetails

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
System.String

Id

The REST ID of the order. Globally unique.

Declaration

[JsonProperty("id")]
public virtual string Id { get; set; }

Property Value

Type	Description
System.String

Kind

Identifies what kind of resource this is. Value: the fixed string "content#order"

Declaration

[JsonProperty("kind")]
public virtual string Kind { get; set; }

Property Value

Type	Description
System.String

LineItems

Line items that are ordered.

Declaration

[JsonProperty("lineItems")]
public virtual IList<OrderLineItem> LineItems { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<OrderLineItem>

MerchantId

Declaration

[JsonProperty("merchantId")]
public virtual ulong? MerchantId { get; set; }

Property Value

Type	Description
System.Nullable<System.UInt64>

MerchantOrderId

Merchant-provided ID of the order.

Declaration

[JsonProperty("merchantOrderId")]
public virtual string MerchantOrderId { get; set; }

Property Value

Type	Description
System.String

NetAmount

The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.

Declaration

[JsonProperty("netAmount")]
public virtual Price NetAmount { get; set; }

Property Value

Type	Description
Price

PaymentMethod

The details of the payment method.

Declaration

[JsonProperty("paymentMethod")]
public virtual OrderPaymentMethod PaymentMethod { get; set; }

Property Value

Type	Description
OrderPaymentMethod

PaymentStatus

The status of the payment. Acceptable values are: - "paymentCaptured" - "paymentRejected" - "paymentSecured" - "pendingAuthorization"

Declaration

[JsonProperty("paymentStatus")]
public virtual string PaymentStatus { get; set; }

Property Value

Type	Description
System.String

PickupDetails

Pickup details for shipments of type pickup.

Declaration

[JsonProperty("pickupDetails")]
public virtual OrderPickupDetails PickupDetails { get; set; }

Property Value

Type	Description
OrderPickupDetails

PlacedDate

The date when the order was placed, in ISO 8601 format.

Declaration

[JsonProperty("placedDate")]
public virtual string PlacedDate { get; set; }

Property Value

Type	Description
System.String

Promotions

The details of the merchant provided promotions applied to the order. To determine which promotions apply to which products, check the Promotions[].Benefits[].OfferIds field against the LineItems[].Product.OfferId field for each promotion. If a promotion is applied to more than 1 offerId, divide the discount value by the number of affected offers to determine how much discount to apply to each offerId. Examples: 1. To calculate the line item level discount for a single specific item: For each promotion, subtract the Promotions[].Benefits[].Discount.value amount from the LineItems[].Price.value. 2. To calculate the line item level discount for multiple quantity of a specific item: For each promotion, divide the Promotions[].Benefits[].Discount.value by the quantity of products and substract it from LineItems[].Product.Price.value for each quantity item. Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price. More details about the program are here.

Declaration

[JsonProperty("promotions")]
public virtual IList<OrderLegacyPromotion> Promotions { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<OrderLegacyPromotion>

Refunds

Refunds for the order.

Declaration

[JsonProperty("refunds")]
public virtual IList<OrderRefund> Refunds { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<OrderRefund>

Shipments

Shipments of the order.

Declaration

[JsonProperty("shipments")]
public virtual IList<OrderShipment> Shipments { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<OrderShipment>

ShippingCost

The total cost of shipping for all items.

Declaration

[JsonProperty("shippingCost")]
public virtual Price ShippingCost { get; set; }

Property Value

Type	Description
Price

ShippingCostTax

The tax for the total shipping cost.

Declaration

[JsonProperty("shippingCostTax")]
public virtual Price ShippingCostTax { get; set; }

Property Value

Type	Description
Price

ShippingOption

Deprecated. Shipping details are provided with line items instead. Acceptable values are: - "economy" - "expedited" - "oneDay" - "sameDay" - "standard" - "twoDay"

Declaration

[JsonProperty("shippingOption")]
public virtual string ShippingOption { get; set; }

Property Value

Type	Description
System.String

Status

The status of the order. Acceptable values are: - "canceled" - "delivered" - "inProgress" - "partiallyDelivered" - "partiallyReturned" - "partiallyShipped" - "pendingShipment" - "returned" - "shipped"

Declaration

[JsonProperty("status")]
public virtual string Status { get; set; }

Property Value

Type	Description
System.String

TaxCollector

The party responsible for collecting and remitting taxes. Acceptable values are: - "marketplaceFacilitator" - "merchant"

Declaration

[JsonProperty("taxCollector")]
public virtual string TaxCollector { get; set; }

Property Value

Type	Description
System.String

Implements

Google.Apis.Requests.IDirectResponseSchema