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.



5837
5838
5839
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5837

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:



5746
5747
5748
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5746

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:



5751
5752
5753
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5751

def annotations
  @annotations
end

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

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

Returns:



5756
5757
5758
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5756

def cancellations
  @cancellations
end

#id ⇒ String

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

Returns:

  • (String) 


5761
5762
5763
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5761

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:



5767
5768
5769
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5767

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:



5774
5775
5776
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5774

def product
  @product
end

#quantity_canceled ⇒ Fixnum

Number of items canceled. Corresponds to the JSON property quantityCanceled

Returns:

  • (Fixnum) 


5779
5780
5781
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5779

def quantity_canceled
  @quantity_canceled
end

#quantity_delivered ⇒ Fixnum

Number of items delivered. Corresponds to the JSON property quantityDelivered

Returns:

  • (Fixnum) 


5784
5785
5786
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5784

def quantity_delivered
  @quantity_delivered
end

#quantity_ordered ⇒ Fixnum

Number of items ordered. Corresponds to the JSON property quantityOrdered

Returns:

  • (Fixnum) 


5789
5790
5791
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5789

def quantity_ordered
  @quantity_ordered
end

#quantity_pending ⇒ Fixnum

Number of items pending. Corresponds to the JSON property quantityPending

Returns:

  • (Fixnum) 


5794
5795
5796
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5794

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) 


5799
5800
5801
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5799

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) 


5804
5805
5806
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5804

def quantity_returned
  @quantity_returned
end

#quantity_shipped ⇒ Fixnum

Number of items shipped. Corresponds to the JSON property quantityShipped

Returns:

  • (Fixnum) 


5809
5810
5811
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5809

def quantity_shipped
  @quantity_shipped
end

#quantity_undeliverable ⇒ Fixnum

Number of items undeliverable. Corresponds to the JSON property quantityUndeliverable

Returns:

  • (Fixnum) 


5814
5815
5816
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5814

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:



5819
5820
5821
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5819

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:



5824
5825
5826
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5824

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:



5829
5830
5831
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5829

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:



5835
5836
5837
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5835

def tax
  @tax
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 5842

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