class Google::Apis::ContentV2_1::Order
Order
. Production access (all methods) requires the order manager role. Sandbox access does not.
Attributes
Whether the order was acknowledged. Corresponds to the JSON property `acknowledged` @return [Boolean]
Whether the order was acknowledged. Corresponds to the JSON property `acknowledged` @return [Boolean]
List of key-value pairs that are attached to a given order. Corresponds to the JSON property `annotations` @return [Array<Google::Apis::ContentV2_1::OrderOrderAnnotation>]
The billing address. Corresponds to the JSON property `billingAddress` @return [Google::Apis::ContentV2_1::OrderAddress]
The details of the customer who placed the order. Corresponds to the JSON property `customer` @return [Google::Apis::ContentV2_1::OrderCustomer]
Delivery details for shipments of type `delivery`. Corresponds to the JSON property `deliveryDetails` @return [Google::Apis::ContentV2_1::OrderDeliveryDetails]
The REST ID of the order. Globally unique. Corresponds to the JSON property `id` @return [String]
Identifies what kind of resource this is. Value: the fixed string “`content# order`” Corresponds to the JSON property `kind` @return [String]
Line items that are ordered. Corresponds to the JSON property `lineItems` @return [Array<Google::Apis::ContentV2_1::OrderLineItem>]
Corresponds to the JSON property `merchantId` @return [Fixnum]
Merchant-provided ID of the order. Corresponds to the JSON property `merchantOrderId` @return [String]
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. Corresponds to the JSON property `netPriceAmount` @return [Google::Apis::ContentV2_1::Price]
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. Corresponds to the JSON property `netTaxAmount` @return [Google::Apis::ContentV2_1::Price]
The status of the payment. Acceptable values are: - “`paymentCaptured`” - “` paymentRejected`” - “`paymentSecured`” - “`pendingAuthorization`” Corresponds to the JSON property `paymentStatus` @return [String]
Pickup details for shipments of type `pickup`. Corresponds to the JSON property `pickupDetails` @return [Google::Apis::ContentV2_1::OrderPickupDetails]
The date when the order was placed, in ISO 8601 format. Corresponds to the JSON property `placedDate` @return [String]
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`.
-
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. Corresponds to the JSON property `promotions` @return [Array<Google::Apis::ContentV2_1::OrderPromotion>]
Refunds for the order. Corresponds to the JSON property `refunds` @return [Array<Google::Apis::ContentV2_1::OrderRefund>]
Shipments of the order. Corresponds to the JSON property `shipments` @return [Array<Google::Apis::ContentV2_1::OrderShipment>]
The total cost of shipping for all items. Corresponds to the JSON property `shippingCost` @return [Google::Apis::ContentV2_1::Price]
The tax for the total shipping cost. Corresponds to the JSON property `shippingCostTax` @return [Google::Apis::ContentV2_1::Price]
The status of the order. Acceptable values are: - “`canceled`” - “`delivered`”
-
“`inProgress`” - “`partiallyDelivered`” - “`partiallyReturned`” - “`
partiallyShipped`“ - ”`pendingShipment`“ - ”`returned`“ - ”`shipped`“ Corresponds to the JSON property `status` @return [String]
The party responsible for collecting and remitting taxes. Acceptable values are: - “`marketplaceFacilitator`” - “`merchant`” Corresponds to the JSON property `taxCollector` @return [String]
Public Class Methods
# File lib/google/apis/content_v2_1/classes.rb, line 5369 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/content_v2_1/classes.rb, line 5374 def update!(**args) @acknowledged = args[:acknowledged] if args.key?(:acknowledged) @annotations = args[:annotations] if args.key?(:annotations) @billing_address = args[:billing_address] if args.key?(:billing_address) @customer = args[:customer] if args.key?(:customer) @delivery_details = args[:delivery_details] if args.key?(:delivery_details) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @line_items = args[:line_items] if args.key?(:line_items) @merchant_id = args[:merchant_id] if args.key?(:merchant_id) @merchant_order_id = args[:merchant_order_id] if args.key?(:merchant_order_id) @net_price_amount = args[:net_price_amount] if args.key?(:net_price_amount) @net_tax_amount = args[:net_tax_amount] if args.key?(:net_tax_amount) @payment_status = args[:payment_status] if args.key?(:payment_status) @pickup_details = args[:pickup_details] if args.key?(:pickup_details) @placed_date = args[:placed_date] if args.key?(:placed_date) @promotions = args[:promotions] if args.key?(:promotions) @refunds = args[:refunds] if args.key?(:refunds) @shipments = args[:shipments] if args.key?(:shipments) @shipping_cost = args[:shipping_cost] if args.key?(:shipping_cost) @shipping_cost_tax = args[:shipping_cost_tax] if args.key?(:shipping_cost_tax) @status = args[:status] if args.key?(:status) @tax_collector = args[:tax_collector] if args.key?(:tax_collector) end