Class: Google::Apis::ContentV2::OrdersCancelLineItemRequest

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

Returns a new instance of OrdersCancelLineItemRequest.



6017
6018
6019
 
# File 'lib/google/apis/content_v2/classes.rb', line 6017

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:



5967
5968
5969
 
# File 'lib/google/apis/content_v2/classes.rb', line 5967

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:



5974
5975
5976
 
# File 'lib/google/apis/content_v2/classes.rb', line 5974

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:



5981
5982
5983
 
# File 'lib/google/apis/content_v2/classes.rb', line 5981

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) 


5986
5987
5988
 
# File 'lib/google/apis/content_v2/classes.rb', line 5986

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) 


5991
5992
5993
 
# File 'lib/google/apis/content_v2/classes.rb', line 5991

def operation_id
  @operation_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) 


5997
5998
5999
 
# File 'lib/google/apis/content_v2/classes.rb', line 5997

def product_id
  @product_id
end

#quantity ⇒ Fixnum

The quantity to cancel. Corresponds to the JSON property quantity

Returns:

  • (Fixnum) 


6002
6003
6004
 
# File 'lib/google/apis/content_v2/classes.rb', line 6002

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) 


6010
6011
6012
 
# File 'lib/google/apis/content_v2/classes.rb', line 6010

def reason
  @reason
end

#reason_text ⇒ String

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

Returns:

  • (String) 


6015
6016
6017
 
# File 'lib/google/apis/content_v2/classes.rb', line 6015

def reason_text
  @reason_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
 
# File 'lib/google/apis/content_v2/classes.rb', line 6022

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