Class: Google::Apis::ContentV2_1::Order
- Inherits:
-
Object
- Object
- Google::Apis::ContentV2_1::Order
- Defined in:
- generated/google/apis/content_v2_1/classes.rb,
generated/google/apis/content_v2_1/representations.rb,
generated/google/apis/content_v2_1/representations.rb
Overview
Order. All methods require the order manager role.
Instance Attribute Summary collapse
-
#acknowledged ⇒ Boolean
(also: #acknowledged?)
Whether the order was acknowledged.
-
#billing_address ⇒ Google::Apis::ContentV2_1::OrderAddress
The billing address.
-
#channel_type ⇒ String
The channel type of the order: "purchaseOnGoogle" or "googleExpress".
-
#customer ⇒ Google::Apis::ContentV2_1::OrderCustomer
The details of the customer who placed the order.
-
#delivery_details ⇒ Google::Apis::ContentV2_1::OrderDeliveryDetails
The details for the delivery.
-
#id ⇒ String
The REST id of the order.
-
#kind ⇒ String
Identifies what kind of resource this is.
-
#line_items ⇒ Array<Google::Apis::ContentV2_1::OrderLineItem>
Line items that are ordered.
-
#merchant_id ⇒ Fixnum
Corresponds to the JSON property
merchantId
. -
#merchant_order_id ⇒ String
Merchant-provided id of the order.
-
#net_amount ⇒ Google::Apis::ContentV2_1::Price
The net amount for the order.
-
#payment_status ⇒ String
The status of the payment.
-
#placed_date ⇒ String
The date when the order was placed, in ISO 8601 format.
-
#promotions ⇒ Array<Google::Apis::ContentV2_1::OrderPromotion>
Promotions associated with the order.
-
#refunds ⇒ Array<Google::Apis::ContentV2_1::OrderRefund>
Refunds for the order.
-
#shipments ⇒ Array<Google::Apis::ContentV2_1::OrderShipment>
Shipments of the order.
-
#shipping_cost ⇒ Google::Apis::ContentV2_1::Price
The total cost of shipping for all items.
-
#shipping_cost_tax ⇒ Google::Apis::ContentV2_1::Price
The tax for the total shipping cost.
-
#shipping_option ⇒ String
The requested shipping option.
-
#status ⇒ String
The status of the order.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Order
constructor
A new instance of Order.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Order
Returns a new instance of Order
3490 3491 3492 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3490 def initialize(**args) update!(**args) end |
Instance Attribute Details
#acknowledged ⇒ Boolean Also known as: acknowledged?
Whether the order was acknowledged.
Corresponds to the JSON property acknowledged
3389 3390 3391 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3389 def acknowledged @acknowledged end |
#billing_address ⇒ Google::Apis::ContentV2_1::OrderAddress
The billing address.
Corresponds to the JSON property billingAddress
3395 3396 3397 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3395 def billing_address @billing_address end |
#channel_type ⇒ String
The channel type of the order: "purchaseOnGoogle" or "googleExpress".
Corresponds to the JSON property channelType
3400 3401 3402 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3400 def channel_type @channel_type end |
#customer ⇒ Google::Apis::ContentV2_1::OrderCustomer
The details of the customer who placed the order.
Corresponds to the JSON property customer
3405 3406 3407 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3405 def customer @customer end |
#delivery_details ⇒ Google::Apis::ContentV2_1::OrderDeliveryDetails
The details for the delivery.
Corresponds to the JSON property deliveryDetails
3410 3411 3412 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3410 def delivery_details @delivery_details end |
#id ⇒ String
The REST id of the order. Globally unique.
Corresponds to the JSON property id
3415 3416 3417 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3415 def id @id end |
#kind ⇒ String
Identifies what kind of resource this is. Value: the fixed string "content#
order".
Corresponds to the JSON property kind
3421 3422 3423 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3421 def kind @kind end |
#line_items ⇒ Array<Google::Apis::ContentV2_1::OrderLineItem>
Line items that are ordered.
Corresponds to the JSON property lineItems
3426 3427 3428 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3426 def line_items @line_items end |
#merchant_id ⇒ Fixnum
Corresponds to the JSON property merchantId
3431 3432 3433 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3431 def merchant_id @merchant_id end |
#merchant_order_id ⇒ String
Merchant-provided id of the order.
Corresponds to the JSON property merchantOrderId
3436 3437 3438 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3436 def merchant_order_id @merchant_order_id end |
#net_amount ⇒ Google::Apis::ContentV2_1::Price
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.
Corresponds to the JSON property netAmount
3443 3444 3445 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3443 def net_amount @net_amount end |
#payment_status ⇒ String
The status of the payment.
Corresponds to the JSON property paymentStatus
3448 3449 3450 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3448 def payment_status @payment_status end |
#placed_date ⇒ String
The date when the order was placed, in ISO 8601 format.
Corresponds to the JSON property placedDate
3453 3454 3455 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3453 def placed_date @placed_date end |
#promotions ⇒ Array<Google::Apis::ContentV2_1::OrderPromotion>
Promotions associated with the order.
Corresponds to the JSON property promotions
3458 3459 3460 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3458 def promotions @promotions end |
#refunds ⇒ Array<Google::Apis::ContentV2_1::OrderRefund>
Refunds for the order.
Corresponds to the JSON property refunds
3463 3464 3465 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3463 def refunds @refunds end |
#shipments ⇒ Array<Google::Apis::ContentV2_1::OrderShipment>
Shipments of the order.
Corresponds to the JSON property shipments
3468 3469 3470 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3468 def shipments @shipments end |
#shipping_cost ⇒ Google::Apis::ContentV2_1::Price
The total cost of shipping for all items.
Corresponds to the JSON property shippingCost
3473 3474 3475 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3473 def shipping_cost @shipping_cost end |
#shipping_cost_tax ⇒ Google::Apis::ContentV2_1::Price
The tax for the total shipping cost.
Corresponds to the JSON property shippingCostTax
3478 3479 3480 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3478 def shipping_cost_tax @shipping_cost_tax end |
#shipping_option ⇒ String
The requested shipping option.
Corresponds to the JSON property shippingOption
3483 3484 3485 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3483 def shipping_option @shipping_option end |
#status ⇒ String
The status of the order.
Corresponds to the JSON property status
3488 3489 3490 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3488 def status @status end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3495 def update!(**args) @acknowledged = args[:acknowledged] if args.key?(:acknowledged) @billing_address = args[:billing_address] if args.key?(:billing_address) @channel_type = args[:channel_type] if args.key?(:channel_type) @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_amount = args[:net_amount] if args.key?(:net_amount) @payment_status = args[:payment_status] if args.key?(:payment_status) @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) @shipping_option = args[:shipping_option] if args.key?(:shipping_option) @status = args[:status] if args.key?(:status) end |