Class: Google::Apis::ContentV2_1::OrdersReturnRefundLineItemRequest

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

Constructor Details

#initialize(**args) ⇒ OrdersReturnRefundLineItemRequest

Returns a new instance of OrdersReturnRefundLineItemRequest.



7811
7812
7813
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 7811

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

Instance Attribute Details

#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) 


7765
7766
7767
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 7765

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) 


7770
7771
7772
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 7770

def operation_id
  @operation_id
end

#price_amount ⇒ Google::Apis::ContentV2_1::Price

The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. If omitted, refundless return is assumed. Corresponds to the JSON property priceAmount

Returns:



7776
7777
7778
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 7776

def price_amount
  @price_amount
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) 


7782
7783
7784
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 7782

def product_id
  @product_id
end

#quantity ⇒ Fixnum

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

Returns:

  • (Fixnum) 


7787
7788
7789
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 7787

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) 


7798
7799
7800
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 7798

def reason
  @reason
end

#reason_text ⇒ String

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

Returns:

  • (String) 


7803
7804
7805
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 7803

def reason_text
  @reason_text
end

#tax_amount ⇒ Google::Apis::ContentV2_1::Price

The amount of tax to be refunded. Optional, but if filled, then priceAmount must be set. Calculated automatically if not provided. Corresponds to the JSON property taxAmount

Returns:



7809
7810
7811
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 7809

def tax_amount
  @tax_amount
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 7816

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