Class: Google::Apis::ContentV2_1::OrderLineItem

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OrderLineItem

Returns a new instance of OrderLineItem.



5341
5342
5343
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5341

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

Instance Attribute Details

#adjustments ⇒ Array<Google::Apis::ContentV2_1::OrderLineItemAdjustment>

Price and tax adjustments applied on the line item. Corresponds to the JSON property adjustments

Returns:



5250
5251
5252
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5250

def adjustments
  @adjustments
end

#annotations ⇒ Array<Google::Apis::ContentV2_1::OrderMerchantProvidedAnnotation>

Annotations that are attached to the line item. Corresponds to the JSON property annotations

Returns:



5255
5256
5257
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5255

def annotations
  @annotations
end

#cancellations ⇒ Array<Google::Apis::ContentV2_1::OrderCancellation>

Cancellations of the line item. Corresponds to the JSON property cancellations

Returns:



5260
5261
5262
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5260

def cancellations
  @cancellations
end

#id ⇒ String

The ID of the line item. Corresponds to the JSON property id

Returns:

  • (String) 


5265
5266
5267
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5265

def id
  @id
end

#price ⇒ Google::Apis::ContentV2_1::Price

Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20. Corresponds to the JSON property price

Returns:



5271
5272
5273
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5271

def price
  @price
end

#product ⇒ Google::Apis::ContentV2_1::OrderLineItemProduct

Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed. Corresponds to the JSON property product

Returns:



5278
5279
5280
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5278

def product
  @product
end

#quantity_canceled ⇒ Fixnum

Number of items canceled. Corresponds to the JSON property quantityCanceled

Returns:

  • (Fixnum) 


5283
5284
5285
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5283

def quantity_canceled
  @quantity_canceled
end

#quantity_delivered ⇒ Fixnum

Number of items delivered. Corresponds to the JSON property quantityDelivered

Returns:

  • (Fixnum) 


5288
5289
5290
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5288

def quantity_delivered
  @quantity_delivered
end

#quantity_ordered ⇒ Fixnum

Number of items ordered. Corresponds to the JSON property quantityOrdered

Returns:

  • (Fixnum) 


5293
5294
5295
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5293

def quantity_ordered
  @quantity_ordered
end

#quantity_pending ⇒ Fixnum

Number of items pending. Corresponds to the JSON property quantityPending

Returns:

  • (Fixnum) 


5298
5299
5300
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5298

def quantity_pending
  @quantity_pending
end

#quantity_ready_for_pickup ⇒ Fixnum

Number of items ready for pickup. Corresponds to the JSON property quantityReadyForPickup

Returns:

  • (Fixnum) 


5303
5304
5305
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5303

def quantity_ready_for_pickup
  @quantity_ready_for_pickup
end

#quantity_returned ⇒ Fixnum

Number of items returned. Corresponds to the JSON property quantityReturned

Returns:

  • (Fixnum) 


5308
5309
5310
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5308

def quantity_returned
  @quantity_returned
end

#quantity_shipped ⇒ Fixnum

Number of items shipped. Corresponds to the JSON property quantityShipped

Returns:

  • (Fixnum) 


5313
5314
5315
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5313

def quantity_shipped
  @quantity_shipped
end

#quantity_undeliverable ⇒ Fixnum

Number of items undeliverable. Corresponds to the JSON property quantityUndeliverable

Returns:

  • (Fixnum) 


5318
5319
5320
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5318

def quantity_undeliverable
  @quantity_undeliverable
end

#return_info ⇒ Google::Apis::ContentV2_1::OrderLineItemReturnInfo

Details of the return policy for the line item. Corresponds to the JSON property returnInfo

Returns:



5323
5324
5325
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5323

def return_info
  @return_info
end

#returns ⇒ Array<Google::Apis::ContentV2_1::OrderReturn>

Returns of the line item. Corresponds to the JSON property returns

Returns:



5328
5329
5330
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5328

def returns
  @returns
end

#shipping_details ⇒ Google::Apis::ContentV2_1::OrderLineItemShippingDetails

Details of the requested shipping for the line item. Corresponds to the JSON property shippingDetails

Returns:



5333
5334
5335
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5333

def shipping_details
  @shipping_details
end

#tax ⇒ Google::Apis::ContentV2_1::Price

Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4. Corresponds to the JSON property tax

Returns:



5339
5340
5341
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5339

def tax
  @tax
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5346

def update!(**args)
  @adjustments = args[:adjustments] if args.key?(:adjustments)
  @annotations = args[:annotations] if args.key?(:annotations)
  @cancellations = args[:cancellations] if args.key?(:cancellations)
  @id = args[:id] if args.key?(:id)
  @price = args[:price] if args.key?(:price)
  @product = args[:product] if args.key?(:product)
  @quantity_canceled = args[:quantity_canceled] if args.key?(:quantity_canceled)
  @quantity_delivered = args[:quantity_delivered] if args.key?(:quantity_delivered)
  @quantity_ordered = args[:quantity_ordered] if args.key?(:quantity_ordered)
  @quantity_pending = args[:quantity_pending] if args.key?(:quantity_pending)
  @quantity_ready_for_pickup = args[:quantity_ready_for_pickup] if args.key?(:quantity_ready_for_pickup)
  @quantity_returned = args[:quantity_returned] if args.key?(:quantity_returned)
  @quantity_shipped = args[:quantity_shipped] if args.key?(:quantity_shipped)
  @quantity_undeliverable = args[:quantity_undeliverable] if args.key?(:quantity_undeliverable)
  @return_info = args[:return_info] if args.key?(:return_info)
  @returns = args[:returns] if args.key?(:returns)
  @shipping_details = args[:shipping_details] if args.key?(:shipping_details)
  @tax = args[:tax] if args.key?(:tax)
end