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

Overview

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

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.



4161
4162
4163
 
# File 'generated/google/apis/content_v2/classes.rb', line 4161

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

Returns:

  • (Boolean) 


4049
4050
4051
 
# File 'generated/google/apis/content_v2/classes.rb', line 4049

def acknowledged
  @acknowledged
end

#channel_type ⇒ String

Deprecated. Corresponds to the JSON property channelType

Returns:

  • (String) 


4055
4056
4057
 
# File 'generated/google/apis/content_v2/classes.rb', line 4055

def channel_type
  @channel_type
end

#customer ⇒ Google::Apis::ContentV2::OrderCustomer

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

Returns:



4060
4061
4062
 
# File 'generated/google/apis/content_v2/classes.rb', line 4060

def customer
  @customer
end

#delivery_details ⇒ Google::Apis::ContentV2::OrderDeliveryDetails

Delivery details for shipments of type delivery. Corresponds to the JSON property deliveryDetails

Returns:



4065
4066
4067
 
# File 'generated/google/apis/content_v2/classes.rb', line 4065

def delivery_details
  @delivery_details
end

#id ⇒ String

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

Returns:

  • (String) 


4070
4071
4072
 
# File 'generated/google/apis/content_v2/classes.rb', line 4070

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

Returns:

  • (String) 


4076
4077
4078
 
# File 'generated/google/apis/content_v2/classes.rb', line 4076

def kind
  @kind
end

#line_items ⇒ Array<Google::Apis::ContentV2::OrderLineItem>

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

Returns:



4081
4082
4083
 
# File 'generated/google/apis/content_v2/classes.rb', line 4081

def line_items
  @line_items
end

#merchant_id ⇒ Fixnum

Corresponds to the JSON property merchantId

Returns:

  • (Fixnum) 


4086
4087
4088
 
# File 'generated/google/apis/content_v2/classes.rb', line 4086

def merchant_id
  @merchant_id
end

#merchant_order_id ⇒ String

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

Returns:

  • (String) 


4091
4092
4093
 
# File 'generated/google/apis/content_v2/classes.rb', line 4091

def merchant_order_id
  @merchant_order_id
end

#net_amount ⇒ Google::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

Returns:



4098
4099
4100
 
# File 'generated/google/apis/content_v2/classes.rb', line 4098

def net_amount
  @net_amount
end

#payment_method ⇒ Google::Apis::ContentV2::OrderPaymentMethod

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

Returns:



4103
4104
4105
 
# File 'generated/google/apis/content_v2/classes.rb', line 4103

def payment_method
  @payment_method
end

#payment_status ⇒ String

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

Returns:

  • (String) 


4108
4109
4110
 
# File 'generated/google/apis/content_v2/classes.rb', line 4108

def payment_status
  @payment_status
end

#pickup_details ⇒ Google::Apis::ContentV2::OrderPickupDetails

Pickup details for shipments of type pickup. Corresponds to the JSON property pickupDetails

Returns:



4113
4114
4115
 
# File 'generated/google/apis/content_v2/classes.rb', line 4113

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

Returns:

  • (String) 


4118
4119
4120
 
# File 'generated/google/apis/content_v2/classes.rb', line 4118

def placed_date
  @placed_date
end

#promotions ⇒ Array<Google::Apis::ContentV2::OrderLegacyPromotion>

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

Returns:



4124
4125
4126
 
# File 'generated/google/apis/content_v2/classes.rb', line 4124

def promotions
  @promotions
end

#refunds ⇒ Array<Google::Apis::ContentV2::OrderRefund>

Refunds for the order. Corresponds to the JSON property refunds

Returns:



4129
4130
4131
 
# File 'generated/google/apis/content_v2/classes.rb', line 4129

def refunds
  @refunds
end

#shipments ⇒ Array<Google::Apis::ContentV2::OrderShipment>

Shipments of the order. Corresponds to the JSON property shipments

Returns:



4134
4135
4136
 
# File 'generated/google/apis/content_v2/classes.rb', line 4134

def shipments
  @shipments
end

#shipping_cost ⇒ Google::Apis::ContentV2::Price

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

Returns:



4139
4140
4141
 
# File 'generated/google/apis/content_v2/classes.rb', line 4139

def shipping_cost
  @shipping_cost
end

#shipping_cost_tax ⇒ Google::Apis::ContentV2::Price

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

Returns:



4144
4145
4146
 
# File 'generated/google/apis/content_v2/classes.rb', line 4144

def shipping_cost_tax
  @shipping_cost_tax
end

#shipping_option ⇒ String

Deprecated. Shipping details are provided with line items instead. Corresponds to the JSON property shippingOption

Returns:

  • (String) 


4149
4150
4151
 
# File 'generated/google/apis/content_v2/classes.rb', line 4149

def shipping_option
  @shipping_option
end

#status ⇒ String

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

Returns:

  • (String) 


4154
4155
4156
 
# File 'generated/google/apis/content_v2/classes.rb', line 4154

def status
  @status
end

#tax_collector ⇒ String

The party responsible for collecting and remitting taxes. Corresponds to the JSON property taxCollector

Returns:

  • (String) 


4159
4160
4161
 
# File 'generated/google/apis/content_v2/classes.rb', line 4159

def tax_collector
  @tax_collector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
 
# File 'generated/google/apis/content_v2/classes.rb', line 4166

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)
  @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)
  @shipping_option = args[:shipping_option] if args.key?(:shipping_option)
  @status = args[:status] if args.key?(:status)
  @tax_collector = args[:tax_collector] if args.key?(:tax_collector)
end