Class: Google::Apis::ContentV2_1::MerchantOrderReturnItem

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

Returns a new instance of MerchantOrderReturnItem.



4258
4259
4260
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4258

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

Instance Attribute Details

#customer_return_reason ⇒ Google::Apis::ContentV2_1::CustomerReturnReason

The reason that the customer chooses to return an item. Corresponds to the JSON property customerReturnReason

Returns:



4202
4203
4204
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4202

def customer_return_reason
  @customer_return_reason
end

#item_id ⇒ String

Product level item ID. If the returned items are of the same product, they will have the same ID. Corresponds to the JSON property itemId

Returns:

  • (String) 


4208
4209
4210
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4208

def item_id
  @item_id
end

#merchant_rejection_reason ⇒ Google::Apis::ContentV2_1::MerchantRejectionReason

The reason that the merchant chose to reject an item return. Corresponds to the JSON property merchantRejectionReason

Returns:



4213
4214
4215
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4213

def merchant_rejection_reason
  @merchant_rejection_reason
end

#merchant_return_reason ⇒ Google::Apis::ContentV2_1::RefundReason

The reason that merchant chooses to accept a return item. Corresponds to the JSON property merchantReturnReason

Returns:



4218
4219
4220
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4218

def merchant_return_reason
  @merchant_return_reason
end

#product ⇒ Google::Apis::ContentV2_1::OrderLineItemProduct

Product data from the time of the order placement. Corresponds to the JSON property product

Returns:



4223
4224
4225
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4223

def product
  @product
end

#refundable_amount ⇒ Google::Apis::ContentV2_1::MonetaryAmount

Maximum amount that can be refunded for this return item. Corresponds to the JSON property refundableAmount

Returns:



4228
4229
4230
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4228

def refundable_amount
  @refundable_amount
end

#return_item_id ⇒ String

Unit level ID for the return item. Different units of the same product will have different IDs. Corresponds to the JSON property returnItemId

Returns:

  • (String) 


4234
4235
4236
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4234

def return_item_id
  @return_item_id
end

#return_shipment_ids ⇒ Array<String>

IDs of the return shipments that this return item belongs to. Corresponds to the JSON property returnShipmentIds

Returns:

  • (Array<String>) 


4239
4240
4241
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4239

def return_shipment_ids
  @return_shipment_ids
end

#shipment_group_id ⇒ String

ID of the original shipment group. Provided for shipments with invoice support. Corresponds to the JSON property shipmentGroupId

Returns:

  • (String) 


4244
4245
4246
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4244

def shipment_group_id
  @shipment_group_id
end

#shipment_unit_id ⇒ String

ID of the shipment unit assigned by the merchant. Provided for shipments with invoice support. Corresponds to the JSON property shipmentUnitId

Returns:

  • (String) 


4250
4251
4252
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4250

def shipment_unit_id
  @shipment_unit_id
end

#state ⇒ String

State of the item. Acceptable values are: - "canceled" - "new" - " received" - "refunded" - "rejected" Corresponds to the JSON property state

Returns:

  • (String) 


4256
4257
4258
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4256

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4263

def update!(**args)
  @customer_return_reason = args[:customer_return_reason] if args.key?(:customer_return_reason)
  @item_id = args[:item_id] if args.key?(:item_id)
  @merchant_rejection_reason = args[:merchant_rejection_reason] if args.key?(:merchant_rejection_reason)
  @merchant_return_reason = args[:merchant_return_reason] if args.key?(:merchant_return_reason)
  @product = args[:product] if args.key?(:product)
  @refundable_amount = args[:refundable_amount] if args.key?(:refundable_amount)
  @return_item_id = args[:return_item_id] if args.key?(:return_item_id)
  @return_shipment_ids = args[:return_shipment_ids] if args.key?(:return_shipment_ids)
  @shipment_group_id = args[:shipment_group_id] if args.key?(:shipment_group_id)
  @shipment_unit_id = args[:shipment_unit_id] if args.key?(:shipment_unit_id)
  @state = args[:state] if args.key?(:state)
end