Class Order

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

Inheritance
object
Order
Implements
Inherited Members
Namespace: Google.Apis.ShoppingContent.v2_1.Data
Assembly: Google.Apis.ShoppingContent.v2_1.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
bool?

Annotations

List of key-value pairs that are attached to a given order.

Declaration
[JsonProperty("annotations")]
public virtual IList<OrderOrderAnnotation> Annotations { get; set; }
Property Value
Type Description
IList<OrderOrderAnnotation>

BillingAddress

The billing address.

Declaration
[JsonProperty("billingAddress")]
public virtual OrderAddress BillingAddress { get; set; }
Property Value
Type Description
OrderAddress

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
string

Id

The REST ID of the order. Globally unique.

Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type Description
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
string

LineItems

Line items that are ordered.

Declaration
[JsonProperty("lineItems")]
public virtual IList<OrderLineItem> LineItems { get; set; }
Property Value
Type Description
IList<OrderLineItem>

MerchantId

Declaration
[JsonProperty("merchantId")]
public virtual ulong? MerchantId { get; set; }
Property Value
Type Description
ulong?

MerchantOrderId

Merchant-provided ID of the order.

Declaration
[JsonProperty("merchantOrderId")]
public virtual string MerchantOrderId { get; set; }
Property Value
Type Description
string

NetPriceAmount

The net amount for the order (price part). For example, if an order was originally for $100 and a refund was issued for $20, the net amount will be $80.

Declaration
[JsonProperty("netPriceAmount")]
public virtual Price NetPriceAmount { get; set; }
Property Value
Type Description
Price

NetTaxAmount

The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment netTaxAmount might not match to a sum of tax field across all lineItems and refunds.

Declaration
[JsonProperty("netTaxAmount")]
public virtual Price NetTaxAmount { get; set; }
Property Value
Type Description
Price

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

Promotions

Promotions associated with the order. To determine which promotions apply to which products, check the Promotions[].appliedItems[].lineItemId field against the LineItems[].id 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 price paid by the customer for a single line item including the discount: For each promotion, subtract the LineItems[].adjustments[].priceAdjustment.value amount from the LineItems[].Price.value. 2. To calculate price paid by the customer for a single line item including the discount in case of multiple quantity: For each promotion, divide the LineItems[].adjustments[].priceAdjustment.value by the quantity of products then subtract the resulting value from the 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<OrderPromotion> Promotions { get; set; }
Property Value
Type Description
IList<OrderPromotion>

Refunds

Refunds for the order.

Declaration
[JsonProperty("refunds")]
public virtual IList<OrderRefund> Refunds { get; set; }
Property Value
Type Description
IList<OrderRefund>

Shipments

Shipments of the order.

Declaration
[JsonProperty("shipments")]
public virtual IList<OrderShipment> Shipments { get; set; }
Property Value
Type Description
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

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

Implements