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

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

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) ⇒ OrderLineItem

Returns a new instance of OrderLineItem



3898
3899
3900
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3898

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:



3807
3808
3809
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3807

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:



3812
3813
3814
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3812

def annotations
  @annotations
end

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

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

Returns:



3817
3818
3819
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3817

def cancellations
  @cancellations
end

#id ⇒ String

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

Returns:

  • (String) 


3822
3823
3824
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3822

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:



3828
3829
3830
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3828

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:



3835
3836
3837
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3835

def product
  @product
end

#quantity_canceled ⇒ Fixnum

Number of items canceled. Corresponds to the JSON property quantityCanceled

Returns:

  • (Fixnum) 


3840
3841
3842
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3840

def quantity_canceled
  @quantity_canceled
end

#quantity_delivered ⇒ Fixnum

Number of items delivered. Corresponds to the JSON property quantityDelivered

Returns:

  • (Fixnum) 


3845
3846
3847
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3845

def quantity_delivered
  @quantity_delivered
end

#quantity_ordered ⇒ Fixnum

Number of items ordered. Corresponds to the JSON property quantityOrdered

Returns:

  • (Fixnum) 


3850
3851
3852
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3850

def quantity_ordered
  @quantity_ordered
end

#quantity_pending ⇒ Fixnum

Number of items pending. Corresponds to the JSON property quantityPending

Returns:

  • (Fixnum) 


3855
3856
3857
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3855

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) 


3860
3861
3862
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3860

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) 


3865
3866
3867
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3865

def quantity_returned
  @quantity_returned
end

#quantity_shipped ⇒ Fixnum

Number of items shipped. Corresponds to the JSON property quantityShipped

Returns:

  • (Fixnum) 


3870
3871
3872
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3870

def quantity_shipped
  @quantity_shipped
end

#quantity_undeliverable ⇒ Fixnum

Number of items undeliverable. Corresponds to the JSON property quantityUndeliverable

Returns:

  • (Fixnum) 


3875
3876
3877
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3875

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:



3880
3881
3882
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3880

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:



3885
3886
3887
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3885

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:



3890
3891
3892
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3890

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:



3896
3897
3898
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3896

def tax
  @tax
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 3903

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