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

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ OrdersReturnRefundLineItemRequest

Returns a new instance of OrdersReturnRefundLineItemRequest.



6929
6930
6931
# File 'generated/google/apis/content_v2_1/classes.rb', line 6929

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

Instance Attribute Details

#line_item_idString

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

Returns:

  • (String)


6875
6876
6877
# File 'generated/google/apis/content_v2_1/classes.rb', line 6875

def line_item_id
  @line_item_id
end

#operation_idString

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

Returns:

  • (String)


6880
6881
6882
# File 'generated/google/apis/content_v2_1/classes.rb', line 6880

def operation_id
  @operation_id
end

#price_amountGoogle::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



6886
6887
6888
# File 'generated/google/apis/content_v2_1/classes.rb', line 6886

def price_amount
  @price_amount
end

#product_idString

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)


6892
6893
6894
# File 'generated/google/apis/content_v2_1/classes.rb', line 6892

def product_id
  @product_id
end

#quantityFixnum

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

Returns:

  • (Fixnum)


6897
6898
6899
# File 'generated/google/apis/content_v2_1/classes.rb', line 6897

def quantity
  @quantity
end

#reasonString

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)


6916
6917
6918
# File 'generated/google/apis/content_v2_1/classes.rb', line 6916

def reason
  @reason
end

#reason_textString

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

Returns:

  • (String)


6921
6922
6923
# File 'generated/google/apis/content_v2_1/classes.rb', line 6921

def reason_text
  @reason_text
end

#tax_amountGoogle::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



6927
6928
6929
# File 'generated/google/apis/content_v2_1/classes.rb', line 6927

def tax_amount
  @tax_amount
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
# File 'generated/google/apis/content_v2_1/classes.rb', line 6934

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