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.



6071
6072
6073
 
# File 'lib/google/apis/content_v2/classes.rb', line 6071

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:



6021
6022
6023
 
# File 'lib/google/apis/content_v2/classes.rb', line 6021

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:



6028
6029
6030
 
# File 'lib/google/apis/content_v2/classes.rb', line 6028

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:



6035
6036
6037
 
# File 'lib/google/apis/content_v2/classes.rb', line 6035

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) 


6040
6041
6042
 
# File 'lib/google/apis/content_v2/classes.rb', line 6040

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) 


6045
6046
6047
 
# File 'lib/google/apis/content_v2/classes.rb', line 6045

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) 


6051
6052
6053
 
# File 'lib/google/apis/content_v2/classes.rb', line 6051

def product_id
  @product_id
end

#quantity ⇒ Fixnum

The quantity to cancel. Corresponds to the JSON property quantity

Returns:

  • (Fixnum) 


6056
6057
6058
 
# File 'lib/google/apis/content_v2/classes.rb', line 6056

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) 


6064
6065
6066
 
# File 'lib/google/apis/content_v2/classes.rb', line 6064

def reason
  @reason
end

#reason_text ⇒ String

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

Returns:

  • (String) 


6069
6070
6071
 
# File 'lib/google/apis/content_v2/classes.rb', line 6069

def reason_text
  @reason_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
 
# File 'lib/google/apis/content_v2/classes.rb', line 6076

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