Class: Google::Apis::ContentV2_1::OrdersCancelLineItemRequest

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/content_v2_1/classes.rb,
lib/google/apis/content_v2_1/representations.rb,
lib/google/apis/content_v2_1/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OrdersCancelLineItemRequest

Returns a new instance of OrdersCancelLineItemRequest.



7520
7521
7522
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7520

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

Instance Attribute Details

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


7489
7490
7491
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7489

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) 


7494
7495
7496
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7494

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) 


7500
7501
7502
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7500

def product_id
  @product_id
end

#quantity ⇒ Fixnum

The quantity to cancel. Corresponds to the JSON property quantity

Returns:

  • (Fixnum) 


7505
7506
7507
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7505

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) 


7513
7514
7515
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7513

def reason
  @reason
end

#reason_text ⇒ String

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

Returns:

  • (String) 


7518
7519
7520
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7518

def reason_text
  @reason_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7525
7526
7527
7528
7529
7530
7531
7532
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7525

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