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.



4179
4180
4181
 
# File 'generated/google/apis/content_v2/classes.rb', line 4179

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) 


4051
4052
4053
 
# File 'generated/google/apis/content_v2/classes.rb', line 4051

def acknowledged
  @acknowledged
end

#channel_type ⇒ String

Deprecated. Corresponds to the JSON property channelType

Returns:

  • (String) 


4057
4058
4059
 
# File 'generated/google/apis/content_v2/classes.rb', line 4057

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:



4062
4063
4064
 
# File 'generated/google/apis/content_v2/classes.rb', line 4062

def customer
  @customer
end

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

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

Returns:



4067
4068
4069
 
# File 'generated/google/apis/content_v2/classes.rb', line 4067

def delivery_details
  @delivery_details
end

#id ⇒ String

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

Returns:

  • (String) 


4072
4073
4074
 
# File 'generated/google/apis/content_v2/classes.rb', line 4072

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) 


4078
4079
4080
 
# File 'generated/google/apis/content_v2/classes.rb', line 4078

def kind
  @kind
end

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

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

Returns:



4083
4084
4085
 
# File 'generated/google/apis/content_v2/classes.rb', line 4083

def line_items
  @line_items
end

#merchant_id ⇒ Fixnum

Corresponds to the JSON property merchantId

Returns:

  • (Fixnum) 


4088
4089
4090
 
# File 'generated/google/apis/content_v2/classes.rb', line 4088

def merchant_id
  @merchant_id
end

#merchant_order_id ⇒ String

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

Returns:

  • (String) 


4093
4094
4095
 
# File 'generated/google/apis/content_v2/classes.rb', line 4093

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:



4100
4101
4102
 
# File 'generated/google/apis/content_v2/classes.rb', line 4100

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:



4105
4106
4107
 
# File 'generated/google/apis/content_v2/classes.rb', line 4105

def payment_method
  @payment_method
end

#payment_status ⇒ String

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

Returns:

  • (String) 


4110
4111
4112
 
# File 'generated/google/apis/content_v2/classes.rb', line 4110

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:



4115
4116
4117
 
# File 'generated/google/apis/content_v2/classes.rb', line 4115

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) 


4120
4121
4122
 
# File 'generated/google/apis/content_v2/classes.rb', line 4120

def placed_date
  @placed_date
end

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

The details of the merchant provided promotions applied to the order. To determine which promotions apply to which products, check the Promotions[]. Benefits[].OfferIds field against the LineItems[].Product.OfferId 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:

  • To calculate the line item level discount for a single specific item: For each promotion, subtract the Promotions[].Benefits[].Discount.value amount from the LineItems[].Price.value.
  • To calculate the line item level discount for multiple quantity of a specific item: For each promotion, divide the Promotions[].Benefits[].Discount. value by the quantity of products and substract it from 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

Returns:



4142
4143
4144
 
# File 'generated/google/apis/content_v2/classes.rb', line 4142

def promotions
  @promotions
end

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

Refunds for the order. Corresponds to the JSON property refunds

Returns:



4147
4148
4149
 
# File 'generated/google/apis/content_v2/classes.rb', line 4147

def refunds
  @refunds
end

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

Shipments of the order. Corresponds to the JSON property shipments

Returns:



4152
4153
4154
 
# File 'generated/google/apis/content_v2/classes.rb', line 4152

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:



4157
4158
4159
 
# File 'generated/google/apis/content_v2/classes.rb', line 4157

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:



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

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) 


4167
4168
4169
 
# File 'generated/google/apis/content_v2/classes.rb', line 4167

def shipping_option
  @shipping_option
end

#status ⇒ String

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

Returns:

  • (String) 


4172
4173
4174
 
# File 'generated/google/apis/content_v2/classes.rb', line 4172

def status
  @status
end

#tax_collector ⇒ String

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

Returns:

  • (String) 


4177
4178
4179
 
# File 'generated/google/apis/content_v2/classes.rb', line 4177

def tax_collector
  @tax_collector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
 
# File 'generated/google/apis/content_v2/classes.rb', line 4184

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