Class: Google::Apis::ContentV2::OrdersReturnRefundLineItemRequest

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

Returns a new instance of OrdersReturnRefundLineItemRequest.



7563
7564
7565
 
# File 'lib/google/apis/content_v2/classes.rb', line 7563

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

Instance Attribute Details

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

The amount that is refunded. If omitted, refundless return is assumed (same as calling returnLineItem method). Corresponds to the JSON property amountPretax

Returns:



7517
7518
7519
 
# File 'lib/google/apis/content_v2/classes.rb', line 7517

def amount_pretax
  @amount_pretax
end

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

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

Returns:



7524
7525
7526
 
# File 'lib/google/apis/content_v2/classes.rb', line 7524

def amount_tax
  @amount_tax
end

#line_item_id ⇒ String

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

Returns:

  • (String) 


7529
7530
7531
 
# File 'lib/google/apis/content_v2/classes.rb', line 7529

def line_item_id
  @line_item_id
end

#operation_id ⇒ String

The ID of the operation. Unique across all operations for a given order. Corresponds to the JSON property operationId

Returns:

  • (String) 


7534
7535
7536
 
# File 'lib/google/apis/content_v2/classes.rb', line 7534

def operation_id
  @operation_id
end

#product_id ⇒ String

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

Returns:

  • (String) 


7540
7541
7542
 
# File 'lib/google/apis/content_v2/classes.rb', line 7540

def product_id
  @product_id
end

#quantity ⇒ Fixnum

The quantity to return and refund. Quantity is required. Corresponds to the JSON property quantity

Returns:

  • (Fixnum) 


7545
7546
7547
 
# File 'lib/google/apis/content_v2/classes.rb', line 7545

def quantity
  @quantity
end

#reason ⇒ String

The reason for the return. Acceptable values are: - " customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - " deliveredTooLate" - "expiredItem" - "invalidCoupon" - " malformedShippingAddress" - "other" - "productArrivedDamaged" - " productNotAsDescribed" - "qualityNotAsExpected" - " undeliverableShippingAddress" - "unsupportedPoBoxAddress" - " wrongProductShipped" Corresponds to the JSON property reason

Returns:

  • (String) 


7556
7557
7558
 
# File 'lib/google/apis/content_v2/classes.rb', line 7556

def reason
  @reason
end

#reason_text ⇒ String

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

Returns:

  • (String) 


7561
7562
7563
 
# File 'lib/google/apis/content_v2/classes.rb', line 7561

def reason_text
  @reason_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
 
# File 'lib/google/apis/content_v2/classes.rb', line 7568

def update!(**args)
  @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)
  @operation_id = args[:operation_id] if args.key?(:operation_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