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.



5720
5721
5722
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5720

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:



5629
5630
5631
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5629

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:



5634
5635
5636
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5634

def annotations
  @annotations
end

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

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

Returns:



5639
5640
5641
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5639

def cancellations
  @cancellations
end

#id ⇒ String

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

Returns:

  • (String) 


5644
5645
5646
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5644

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:



5650
5651
5652
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5650

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:



5657
5658
5659
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5657

def product
  @product
end

#quantity_canceled ⇒ Fixnum

Number of items canceled. Corresponds to the JSON property quantityCanceled

Returns:

  • (Fixnum) 


5662
5663
5664
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5662

def quantity_canceled
  @quantity_canceled
end

#quantity_delivered ⇒ Fixnum

Number of items delivered. Corresponds to the JSON property quantityDelivered

Returns:

  • (Fixnum) 


5667
5668
5669
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5667

def quantity_delivered
  @quantity_delivered
end

#quantity_ordered ⇒ Fixnum

Number of items ordered. Corresponds to the JSON property quantityOrdered

Returns:

  • (Fixnum) 


5672
5673
5674
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5672

def quantity_ordered
  @quantity_ordered
end

#quantity_pending ⇒ Fixnum

Number of items pending. Corresponds to the JSON property quantityPending

Returns:

  • (Fixnum) 


5677
5678
5679
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5677

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) 


5682
5683
5684
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5682

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) 


5687
5688
5689
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5687

def quantity_returned
  @quantity_returned
end

#quantity_shipped ⇒ Fixnum

Number of items shipped. Corresponds to the JSON property quantityShipped

Returns:

  • (Fixnum) 


5692
5693
5694
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5692

def quantity_shipped
  @quantity_shipped
end

#quantity_undeliverable ⇒ Fixnum

Number of items undeliverable. Corresponds to the JSON property quantityUndeliverable

Returns:

  • (Fixnum) 


5697
5698
5699
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5697

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:



5702
5703
5704
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5702

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:



5707
5708
5709
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5707

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:



5712
5713
5714
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5712

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:



5718
5719
5720
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5718

def tax
  @tax
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5725

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