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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/content_v2/classes.rb,
generated/google/apis/content_v2/representations.rb,
generated/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.



7547
7548
7549
 
# File 'generated/google/apis/content_v2/classes.rb', line 7547

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:



7501
7502
7503
 
# File 'generated/google/apis/content_v2/classes.rb', line 7501

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:



7508
7509
7510
 
# File 'generated/google/apis/content_v2/classes.rb', line 7508

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) 


7513
7514
7515
 
# File 'generated/google/apis/content_v2/classes.rb', line 7513

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) 


7518
7519
7520
 
# File 'generated/google/apis/content_v2/classes.rb', line 7518

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) 


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

def product_id
  @product_id
end

#quantity ⇒ Fixnum

The quantity to return and refund. Corresponds to the JSON property quantity

Returns:

  • (Fixnum) 


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

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) 


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

def reason
  @reason
end

#reason_text ⇒ String

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

Returns:

  • (String) 


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

def reason_text
  @reason_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
 
# File 'generated/google/apis/content_v2/classes.rb', line 7552

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