Class: Google::Apis::ContentV2::OrdersCustomBatchRequestEntryCancelLineItem

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OrdersCustomBatchRequestEntryCancelLineItem

Returns a new instance of OrdersCustomBatchRequestEntryCancelLineItem.



6492
6493
6494
 
# File 'lib/google/apis/content_v2/classes.rb', line 6492

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

Instance Attribute Details

#amount ⇒ Google::Apis::ContentV2::Price

Deprecated. Please use amountPretax and amountTax instead. Corresponds to the JSON property amount

Returns:



6447
6448
6449
 
# File 'lib/google/apis/content_v2/classes.rb', line 6447

def amount
  @amount
end

#amount_pretax ⇒ Google::Apis::ContentV2::Price

Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order. Corresponds to the JSON property amountPretax

Returns:



6454
6455
6456
 
# File 'lib/google/apis/content_v2/classes.rb', line 6454

def amount_pretax
  @amount_pretax
end

#amount_tax ⇒ Google::Apis::ContentV2::Price

Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided. Corresponds to the JSON property amountTax

Returns:



6461
6462
6463
 
# File 'lib/google/apis/content_v2/classes.rb', line 6461

def amount_tax
  @amount_tax
end

#line_item_id ⇒ String

The ID of the line item to cancel. Either lineItemId or productId is required. Corresponds to the JSON property lineItemId

Returns:

  • (String) 


6466
6467
6468
 
# File 'lib/google/apis/content_v2/classes.rb', line 6466

def line_item_id
  @line_item_id
end

#product_id ⇒ String

The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required. Corresponds to the JSON property productId

Returns:

  • (String) 


6472
6473
6474
 
# File 'lib/google/apis/content_v2/classes.rb', line 6472

def product_id
  @product_id
end

#quantity ⇒ Fixnum

The quantity to cancel. Corresponds to the JSON property quantity

Returns:

  • (Fixnum) 


6477
6478
6479
 
# File 'lib/google/apis/content_v2/classes.rb', line 6477

def quantity
  @quantity
end

#reason ⇒ String

The reason for the cancellation. Acceptable values are: - " customerInitiatedCancel" - "invalidCoupon" - "malformedShippingAddress" - "noInventory" - "other" - "priceError" - "shippingPriceError" - " taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" Corresponds to the JSON property reason

Returns:

  • (String) 


6485
6486
6487
 
# File 'lib/google/apis/content_v2/classes.rb', line 6485

def reason
  @reason
end

#reason_text ⇒ String

The explanation of the reason. Corresponds to the JSON property reasonText

Returns:

  • (String) 


6490
6491
6492
 
# File 'lib/google/apis/content_v2/classes.rb', line 6490

def reason_text
  @reason_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
 
# File 'lib/google/apis/content_v2/classes.rb', line 6497

def update!(**args)
  @amount = args[:amount] if args.key?(:amount)
  @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax)
  @amount_tax = args[:amount_tax] if args.key?(:amount_tax)
  @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
  @product_id = args[:product_id] if args.key?(:product_id)
  @quantity = args[:quantity] if args.key?(:quantity)
  @reason = args[:reason] if args.key?(:reason)
  @reason_text = args[:reason_text] if args.key?(:reason_text)
end