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.



4568
4569
4570
# File 'generated/google/apis/content_v2_1/classes.rb', line 4568

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



4477
4478
4479
# File 'generated/google/apis/content_v2_1/classes.rb', line 4477

def adjustments
  @adjustments
end

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

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



4482
4483
4484
# File 'generated/google/apis/content_v2_1/classes.rb', line 4482

def annotations
  @annotations
end

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

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



4487
4488
4489
# File 'generated/google/apis/content_v2_1/classes.rb', line 4487

def cancellations
  @cancellations
end

#idString

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

Returns:

  • (String)


4492
4493
4494
# File 'generated/google/apis/content_v2_1/classes.rb', line 4492

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



4498
4499
4500
# File 'generated/google/apis/content_v2_1/classes.rb', line 4498

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



4505
4506
4507
# File 'generated/google/apis/content_v2_1/classes.rb', line 4505

def product
  @product
end

#quantity_canceledFixnum

Number of items canceled. Corresponds to the JSON property quantityCanceled

Returns:

  • (Fixnum)


4510
4511
4512
# File 'generated/google/apis/content_v2_1/classes.rb', line 4510

def quantity_canceled
  @quantity_canceled
end

#quantity_deliveredFixnum

Number of items delivered. Corresponds to the JSON property quantityDelivered

Returns:

  • (Fixnum)


4515
4516
4517
# File 'generated/google/apis/content_v2_1/classes.rb', line 4515

def quantity_delivered
  @quantity_delivered
end

#quantity_orderedFixnum

Number of items ordered. Corresponds to the JSON property quantityOrdered

Returns:

  • (Fixnum)


4520
4521
4522
# File 'generated/google/apis/content_v2_1/classes.rb', line 4520

def quantity_ordered
  @quantity_ordered
end

#quantity_pendingFixnum

Number of items pending. Corresponds to the JSON property quantityPending

Returns:

  • (Fixnum)


4525
4526
4527
# File 'generated/google/apis/content_v2_1/classes.rb', line 4525

def quantity_pending
  @quantity_pending
end

#quantity_ready_for_pickupFixnum

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

Returns:

  • (Fixnum)


4530
4531
4532
# File 'generated/google/apis/content_v2_1/classes.rb', line 4530

def quantity_ready_for_pickup
  @quantity_ready_for_pickup
end

#quantity_returnedFixnum

Number of items returned. Corresponds to the JSON property quantityReturned

Returns:

  • (Fixnum)


4535
4536
4537
# File 'generated/google/apis/content_v2_1/classes.rb', line 4535

def quantity_returned
  @quantity_returned
end

#quantity_shippedFixnum

Number of items shipped. Corresponds to the JSON property quantityShipped

Returns:

  • (Fixnum)


4540
4541
4542
# File 'generated/google/apis/content_v2_1/classes.rb', line 4540

def quantity_shipped
  @quantity_shipped
end

#quantity_undeliverableFixnum

Number of items undeliverable. Corresponds to the JSON property quantityUndeliverable

Returns:

  • (Fixnum)


4545
4546
4547
# File 'generated/google/apis/content_v2_1/classes.rb', line 4545

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



4550
4551
4552
# File 'generated/google/apis/content_v2_1/classes.rb', line 4550

def return_info
  @return_info
end

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

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



4555
4556
4557
# File 'generated/google/apis/content_v2_1/classes.rb', line 4555

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



4560
4561
4562
# File 'generated/google/apis/content_v2_1/classes.rb', line 4560

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



4566
4567
4568
# File 'generated/google/apis/content_v2_1/classes.rb', line 4566

def tax
  @tax
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
# File 'generated/google/apis/content_v2_1/classes.rb', line 4573

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