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. Production access (all methods) requires the order manager role. Sandbox access does not.
Instance Attribute Summary collapse
-
#acknowledged ⇒ Boolean
(also: #acknowledged?)
Whether the order was acknowledged.
-
#billing_address ⇒ Google::Apis::ContentV2_1::OrderAddress
The billing address.
-
#customer ⇒ Google::Apis::ContentV2_1::OrderCustomer
The details of the customer who placed the order.
-
#delivery_details ⇒ Google::Apis::ContentV2_1::OrderDeliveryDetails
Delivery details for shipments of type 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_price_amount ⇒ Google::Apis::ContentV2_1::Price
The net amount for the order (price part).
-
#net_tax_amount ⇒ Google::Apis::ContentV2_1::Price
The net amount for the order (tax part).
-
#payment_status ⇒ String
The status of the payment.
-
#pickup_details ⇒ Google::Apis::ContentV2_1::OrderPickupDetails
Pickup details for shipments of type pickup.
-
#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.
-
#status ⇒ String
The status of the order.
-
#tax_collector ⇒ String
The party responsible for collecting and remitting taxes.
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.
3627 3628 3629 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3627 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
3519 3520 3521 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3519 def acknowledged @acknowledged end |
#billing_address ⇒ Google::Apis::ContentV2_1::OrderAddress
The billing address.
Corresponds to the JSON property billingAddress
3525 3526 3527 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3525 def billing_address @billing_address end |
#customer ⇒ Google::Apis::ContentV2_1::OrderCustomer
The details of the customer who placed the order.
Corresponds to the JSON property customer
3530 3531 3532 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3530 def customer @customer end |
#delivery_details ⇒ Google::Apis::ContentV2_1::OrderDeliveryDetails
Delivery details for shipments of type delivery.
Corresponds to the JSON property deliveryDetails
3535 3536 3537 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3535 def delivery_details @delivery_details end |
#id ⇒ String
The REST ID of the order. Globally unique.
Corresponds to the JSON property id
3540 3541 3542 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3540 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
3546 3547 3548 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3546 def kind @kind end |
#line_items ⇒ Array<Google::Apis::ContentV2_1::OrderLineItem>
Line items that are ordered.
Corresponds to the JSON property lineItems
3551 3552 3553 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3551 def line_items @line_items end |
#merchant_id ⇒ Fixnum
Corresponds to the JSON property merchantId
3556 3557 3558 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3556 def merchant_id @merchant_id end |
#merchant_order_id ⇒ String
Merchant-provided ID of the order.
Corresponds to the JSON property merchantOrderId
3561 3562 3563 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3561 def merchant_order_id @merchant_order_id end |
#net_price_amount ⇒ Google::Apis::ContentV2_1::Price
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
3568 3569 3570 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3568 def net_price_amount @net_price_amount end |
#net_tax_amount ⇒ 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
3575 3576 3577 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3575 def net_tax_amount @net_tax_amount end |
#payment_status ⇒ String
The status of the payment.
Corresponds to the JSON property paymentStatus
3580 3581 3582 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3580 def payment_status @payment_status end |
#pickup_details ⇒ Google::Apis::ContentV2_1::OrderPickupDetails
Pickup details for shipments of type pickup.
Corresponds to the JSON property pickupDetails
3585 3586 3587 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3585 def pickup_details @pickup_details end |
#placed_date ⇒ String
The date when the order was placed, in ISO 8601 format.
Corresponds to the JSON property placedDate
3590 3591 3592 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3590 def placed_date @placed_date end |
#promotions ⇒ Array<Google::Apis::ContentV2_1::OrderPromotion>
Promotions associated with the order.
Corresponds to the JSON property promotions
3595 3596 3597 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3595 def promotions @promotions end |
#refunds ⇒ Array<Google::Apis::ContentV2_1::OrderRefund>
Refunds for the order.
Corresponds to the JSON property refunds
3600 3601 3602 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3600 def refunds @refunds end |
#shipments ⇒ Array<Google::Apis::ContentV2_1::OrderShipment>
Shipments of the order.
Corresponds to the JSON property shipments
3605 3606 3607 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3605 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
3610 3611 3612 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3610 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
3615 3616 3617 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3615 def shipping_cost_tax @shipping_cost_tax end |
#status ⇒ String
The status of the order.
Corresponds to the JSON property status
3620 3621 3622 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3620 def status @status end |
#tax_collector ⇒ String
The party responsible for collecting and remitting taxes.
Corresponds to the JSON property taxCollector
3625 3626 3627 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3625 def tax_collector @tax_collector end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 3632 def update!(**args) @acknowledged = args[:acknowledged] if args.key?(:acknowledged) @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 |