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.



5632
5633
5634
# File 'lib/google/apis/content_v2_1/classes.rb', line 5632

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

Instance Attribute Details

#adjustmentsArray<Google::Apis::ContentV2_1::OrderLineItemAdjustment>

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



5541
5542
5543
# File 'lib/google/apis/content_v2_1/classes.rb', line 5541

def adjustments
  @adjustments
end

#annotationsArray<Google::Apis::ContentV2_1::OrderMerchantProvidedAnnotation>

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



5546
5547
5548
# File 'lib/google/apis/content_v2_1/classes.rb', line 5546

def annotations
  @annotations
end

#cancellationsArray<Google::Apis::ContentV2_1::OrderCancellation>

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



5551
5552
5553
# File 'lib/google/apis/content_v2_1/classes.rb', line 5551

def cancellations
  @cancellations
end

#idString

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

Returns:

  • (String)


5556
5557
5558
# File 'lib/google/apis/content_v2_1/classes.rb', line 5556

def id
  @id
end

#priceGoogle::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



5562
5563
5564
# File 'lib/google/apis/content_v2_1/classes.rb', line 5562

def price
  @price
end

#productGoogle::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



5569
5570
5571
# File 'lib/google/apis/content_v2_1/classes.rb', line 5569

def product
  @product
end

#quantity_canceledFixnum

Number of items canceled. Corresponds to the JSON property quantityCanceled

Returns:

  • (Fixnum)


5574
5575
5576
# File 'lib/google/apis/content_v2_1/classes.rb', line 5574

def quantity_canceled
  @quantity_canceled
end

#quantity_deliveredFixnum

Number of items delivered. Corresponds to the JSON property quantityDelivered

Returns:

  • (Fixnum)


5579
5580
5581
# File 'lib/google/apis/content_v2_1/classes.rb', line 5579

def quantity_delivered
  @quantity_delivered
end

#quantity_orderedFixnum

Number of items ordered. Corresponds to the JSON property quantityOrdered

Returns:

  • (Fixnum)


5584
5585
5586
# File 'lib/google/apis/content_v2_1/classes.rb', line 5584

def quantity_ordered
  @quantity_ordered
end

#quantity_pendingFixnum

Number of items pending. Corresponds to the JSON property quantityPending

Returns:

  • (Fixnum)


5589
5590
5591
# File 'lib/google/apis/content_v2_1/classes.rb', line 5589

def quantity_pending
  @quantity_pending
end

#quantity_ready_for_pickupFixnum

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

Returns:

  • (Fixnum)


5594
5595
5596
# File 'lib/google/apis/content_v2_1/classes.rb', line 5594

def quantity_ready_for_pickup
  @quantity_ready_for_pickup
end

#quantity_returnedFixnum

Number of items returned. Corresponds to the JSON property quantityReturned

Returns:

  • (Fixnum)


5599
5600
5601
# File 'lib/google/apis/content_v2_1/classes.rb', line 5599

def quantity_returned
  @quantity_returned
end

#quantity_shippedFixnum

Number of items shipped. Corresponds to the JSON property quantityShipped

Returns:

  • (Fixnum)


5604
5605
5606
# File 'lib/google/apis/content_v2_1/classes.rb', line 5604

def quantity_shipped
  @quantity_shipped
end

#quantity_undeliverableFixnum

Number of items undeliverable. Corresponds to the JSON property quantityUndeliverable

Returns:

  • (Fixnum)


5609
5610
5611
# File 'lib/google/apis/content_v2_1/classes.rb', line 5609

def quantity_undeliverable
  @quantity_undeliverable
end

#return_infoGoogle::Apis::ContentV2_1::OrderLineItemReturnInfo

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



5614
5615
5616
# File 'lib/google/apis/content_v2_1/classes.rb', line 5614

def return_info
  @return_info
end

#returnsArray<Google::Apis::ContentV2_1::OrderReturn>

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



5619
5620
5621
# File 'lib/google/apis/content_v2_1/classes.rb', line 5619

def returns
  @returns
end

#shipping_detailsGoogle::Apis::ContentV2_1::OrderLineItemShippingDetails

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



5624
5625
5626
# File 'lib/google/apis/content_v2_1/classes.rb', line 5624

def shipping_details
  @shipping_details
end

#taxGoogle::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



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

def tax
  @tax
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
# File 'lib/google/apis/content_v2_1/classes.rb', line 5637

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