Class: Google::Apis::ContentV2::Order

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/content_v2/classes.rb,
generated/google/apis/content_v2/representations.rb,
generated/google/apis/content_v2/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Order

Returns a new instance of Order.


2832
2833
2834
# File 'generated/google/apis/content_v2/classes.rb', line 2832

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#acknowledgedBoolean Also known as: acknowledged?

Whether the order was acknowledged. Corresponds to the JSON property acknowledged

Returns:

  • (Boolean)

2730
2731
2732
# File 'generated/google/apis/content_v2/classes.rb', line 2730

def acknowledged
  @acknowledged
end

#channel_typeString

The channel type of the order: "purchaseOnGoogle" or "googleExpress". Corresponds to the JSON property channelType

Returns:

  • (String)

2736
2737
2738
# File 'generated/google/apis/content_v2/classes.rb', line 2736

def channel_type
  @channel_type
end

#customerGoogle::Apis::ContentV2::OrderCustomer

The details of the customer who placed the order. Corresponds to the JSON property customer


2741
2742
2743
# File 'generated/google/apis/content_v2/classes.rb', line 2741

def customer
  @customer
end

#delivery_detailsGoogle::Apis::ContentV2::OrderDeliveryDetails

The details for the delivery. Corresponds to the JSON property deliveryDetails


2746
2747
2748
# File 'generated/google/apis/content_v2/classes.rb', line 2746

def delivery_details
  @delivery_details
end

#idString

The REST id of the order. Globally unique. Corresponds to the JSON property id

Returns:

  • (String)

2751
2752
2753
# File 'generated/google/apis/content_v2/classes.rb', line 2751

def id
  @id
end

#kindString

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

Returns:

  • (String)

2757
2758
2759
# File 'generated/google/apis/content_v2/classes.rb', line 2757

def kind
  @kind
end

#line_itemsArray<Google::Apis::ContentV2::OrderLineItem>

Line items that are ordered. Corresponds to the JSON property lineItems


2762
2763
2764
# File 'generated/google/apis/content_v2/classes.rb', line 2762

def line_items
  @line_items
end

#merchant_idString

Corresponds to the JSON property merchantId

Returns:

  • (String)

2767
2768
2769
# File 'generated/google/apis/content_v2/classes.rb', line 2767

def merchant_id
  @merchant_id
end

#merchant_order_idString

Merchant-provided id of the order. Corresponds to the JSON property merchantOrderId

Returns:

  • (String)

2772
2773
2774
# File 'generated/google/apis/content_v2/classes.rb', line 2772

def merchant_order_id
  @merchant_order_id
end

#net_amountGoogle::Apis::ContentV2::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


2779
2780
2781
# File 'generated/google/apis/content_v2/classes.rb', line 2779

def net_amount
  @net_amount
end

#payment_methodGoogle::Apis::ContentV2::OrderPaymentMethod

The details of the payment method. Corresponds to the JSON property paymentMethod


2784
2785
2786
# File 'generated/google/apis/content_v2/classes.rb', line 2784

def payment_method
  @payment_method
end

#payment_statusString

The status of the payment. Corresponds to the JSON property paymentStatus

Returns:

  • (String)

2789
2790
2791
# File 'generated/google/apis/content_v2/classes.rb', line 2789

def payment_status
  @payment_status
end

#placed_dateString

The date when the order was placed, in ISO 8601 format. Corresponds to the JSON property placedDate

Returns:

  • (String)

2794
2795
2796
# File 'generated/google/apis/content_v2/classes.rb', line 2794

def placed_date
  @placed_date
end

#promotionsArray<Google::Apis::ContentV2::OrderPromotion>

The details of the merchant provided promotions applied to the order. More details about the program are here. Corresponds to the JSON property promotions


2800
2801
2802
# File 'generated/google/apis/content_v2/classes.rb', line 2800

def promotions
  @promotions
end

#refundsArray<Google::Apis::ContentV2::OrderRefund>

Refunds for the order. Corresponds to the JSON property refunds


2805
2806
2807
# File 'generated/google/apis/content_v2/classes.rb', line 2805

def refunds
  @refunds
end

#shipmentsArray<Google::Apis::ContentV2::OrderShipment>

Shipments of the order. Corresponds to the JSON property shipments


2810
2811
2812
# File 'generated/google/apis/content_v2/classes.rb', line 2810

def shipments
  @shipments
end

#shipping_costGoogle::Apis::ContentV2::Price

The total cost of shipping for all items. Corresponds to the JSON property shippingCost


2815
2816
2817
# File 'generated/google/apis/content_v2/classes.rb', line 2815

def shipping_cost
  @shipping_cost
end

#shipping_cost_taxGoogle::Apis::ContentV2::Price

The tax for the total shipping cost. Corresponds to the JSON property shippingCostTax


2820
2821
2822
# File 'generated/google/apis/content_v2/classes.rb', line 2820

def shipping_cost_tax
  @shipping_cost_tax
end

#shipping_optionString

The requested shipping option. Corresponds to the JSON property shippingOption

Returns:

  • (String)

2825
2826
2827
# File 'generated/google/apis/content_v2/classes.rb', line 2825

def shipping_option
  @shipping_option
end

#statusString

The status of the order. Corresponds to the JSON property status

Returns:

  • (String)

2830
2831
2832
# File 'generated/google/apis/content_v2/classes.rb', line 2830

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
# File 'generated/google/apis/content_v2/classes.rb', line 2837

def update!(**args)
  @acknowledged = args[:acknowledged] if args.key?(:acknowledged)
  @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_method = args[:payment_method] if args.key?(:payment_method)
  @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