content  v2.1
Properties | List of all members
Google.Apis.ShoppingContent.v2_1.Data.Order Class Reference

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

Inheritance diagram for Google.Apis.ShoppingContent.v2_1.Data.Order:
Google::Apis::Requests::IDirectResponseSchema

Properties

virtual System.Nullable< bool > Acknowledged [get, set]
 Whether the order was acknowledged. More...
 
virtual OrderAddress BillingAddress [get, set]
 The billing address. More...
 
virtual OrderCustomer Customer [get, set]
 The details of the customer who placed the order. More...
 
virtual OrderDeliveryDetails DeliveryDetails [get, set]
 Delivery details for shipments of type delivery. More...
 
virtual string Id [get, set]
 The REST ID of the order. Globally unique. More...
 
virtual string Kind [get, set]
 Identifies what kind of resource this is. Value: the fixed string "content#order". More...
 
virtual System.Collections.Generic.IList< OrderLineItemLineItems [get, set]
 Line items that are ordered. More...
 
virtual System.Nullable< ulong > MerchantId [get, set]
 
virtual string MerchantOrderId [get, set]
 Merchant-provided ID of the order. More...
 
virtual Price NetPriceAmount [get, set]
 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. More...
 
virtual Price NetTaxAmount [get, set]
 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. More...
 
virtual string PaymentStatus [get, set]
 The status of the payment. More...
 
virtual OrderPickupDetails PickupDetails [get, set]
 Pickup details for shipments of type pickup. More...
 
virtual string PlacedDate [get, set]
 The date when the order was placed, in ISO 8601 format. More...
 
virtual System.Collections.Generic.IList< OrderPromotionPromotions [get, set]
 Promotions associated with the order. More...
 
virtual System.Collections.Generic.IList< OrderRefundRefunds [get, set]
 Refunds for the order. More...
 
virtual System.Collections.Generic.IList< OrderShipmentShipments [get, set]
 Shipments of the order. More...
 
virtual Price ShippingCost [get, set]
 The total cost of shipping for all items. More...
 
virtual Price ShippingCostTax [get, set]
 The tax for the total shipping cost. More...
 
virtual string Status [get, set]
 The status of the order. More...
 
virtual string TaxCollector [get, set]
 The party responsible for collecting and remitting taxes. More...
 
virtual string ETag [get, set]
 The ETag of the item. More...
 
- Properties inherited from Google::Apis::Requests::IDirectResponseSchema
string ETag
 

Detailed Description

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

Property Documentation

◆ Acknowledged

virtual System.Nullable<bool> Google.Apis.ShoppingContent.v2_1.Data.Order.Acknowledged
getset

Whether the order was acknowledged.

◆ BillingAddress

virtual OrderAddress Google.Apis.ShoppingContent.v2_1.Data.Order.BillingAddress
getset

The billing address.

◆ Customer

virtual OrderCustomer Google.Apis.ShoppingContent.v2_1.Data.Order.Customer
getset

The details of the customer who placed the order.

◆ DeliveryDetails

virtual OrderDeliveryDetails Google.Apis.ShoppingContent.v2_1.Data.Order.DeliveryDetails
getset

Delivery details for shipments of type delivery.

◆ ETag

virtual string Google.Apis.ShoppingContent.v2_1.Data.Order.ETag
getset

The ETag of the item.

◆ Id

virtual string Google.Apis.ShoppingContent.v2_1.Data.Order.Id
getset

The REST ID of the order. Globally unique.

◆ Kind

virtual string Google.Apis.ShoppingContent.v2_1.Data.Order.Kind
getset

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

◆ LineItems

virtual System.Collections.Generic.IList<OrderLineItem> Google.Apis.ShoppingContent.v2_1.Data.Order.LineItems
getset

Line items that are ordered.

◆ MerchantOrderId

virtual string Google.Apis.ShoppingContent.v2_1.Data.Order.MerchantOrderId
getset

Merchant-provided ID of the order.

◆ NetPriceAmount

virtual Price Google.Apis.ShoppingContent.v2_1.Data.Order.NetPriceAmount
getset

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.

◆ NetTaxAmount

virtual Price Google.Apis.ShoppingContent.v2_1.Data.Order.NetTaxAmount
getset

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.

◆ PaymentStatus

virtual string Google.Apis.ShoppingContent.v2_1.Data.Order.PaymentStatus
getset

The status of the payment.

◆ PickupDetails

virtual OrderPickupDetails Google.Apis.ShoppingContent.v2_1.Data.Order.PickupDetails
getset

Pickup details for shipments of type pickup.

◆ PlacedDate

virtual string Google.Apis.ShoppingContent.v2_1.Data.Order.PlacedDate
getset

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

◆ Promotions

virtual System.Collections.Generic.IList<OrderPromotion> Google.Apis.ShoppingContent.v2_1.Data.Order.Promotions
getset

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: - 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. - 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.

◆ Refunds

virtual System.Collections.Generic.IList<OrderRefund> Google.Apis.ShoppingContent.v2_1.Data.Order.Refunds
getset

Refunds for the order.

◆ Shipments

virtual System.Collections.Generic.IList<OrderShipment> Google.Apis.ShoppingContent.v2_1.Data.Order.Shipments
getset

Shipments of the order.

◆ ShippingCost

virtual Price Google.Apis.ShoppingContent.v2_1.Data.Order.ShippingCost
getset

The total cost of shipping for all items.

◆ ShippingCostTax

virtual Price Google.Apis.ShoppingContent.v2_1.Data.Order.ShippingCostTax
getset

The tax for the total shipping cost.

◆ Status

virtual string Google.Apis.ShoppingContent.v2_1.Data.Order.Status
getset

The status of the order.

◆ TaxCollector

virtual string Google.Apis.ShoppingContent.v2_1.Data.Order.TaxCollector
getset

The party responsible for collecting and remitting taxes.


The documentation for this class was generated from the following file: