com.google.api.services.content.model

Class OrdersRefundRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.content.model.OrdersRefundRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class OrdersRefundRequest
extends GenericJson

Model definition for OrdersRefundRequest.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Content API for Shopping. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
OrdersRefundRequest()

Method Summary

Modifier and Type	Method and Description
OrdersRefundRequest	clone()
Price	getAmount() Deprecated.
Price	getAmountPretax() The amount that is refunded.
Price	getAmountTax() Tax amount that corresponds to refund amount in amountPretax.
String	getOperationId() The ID of the operation.
String	getReason() The reason for the refund.
String	getReasonText() The explanation of the reason.
OrdersRefundRequest	set(String fieldName, Object value)
OrdersRefundRequest	setAmount(Price amount) Deprecated.
OrdersRefundRequest	setAmountPretax(Price amountPretax) The amount that is refunded.
OrdersRefundRequest	setAmountTax(Price amountTax) Tax amount that corresponds to refund amount in amountPretax.
OrdersRefundRequest	setOperationId(String operationId) The ID of the operation.
OrdersRefundRequest	setReason(String reason) The reason for the refund.
OrdersRefundRequest	setReasonText(String reasonText) The explanation of the reason.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

OrdersRefundRequest

public OrdersRefundRequest()

Method Detail

getAmount

public Price getAmount()

Deprecated. Please use amountPretax and amountTax instead.

Returns:

value or null for none

setAmount

public OrdersRefundRequest setAmount(Price amount)

Deprecated. Please use amountPretax and amountTax instead.

Parameters:

amount - amount or null for none

getAmountPretax

public Price getAmountPretax()

The amount that is refunded. Either amount or amountPretax should be filled.

Returns:

value or null for none

setAmountPretax

public OrdersRefundRequest setAmountPretax(Price amountPretax)

The amount that is refunded. Either amount or amountPretax should be filled.

Parameters:

amountPretax - amountPretax or null for none

getAmountTax

public Price getAmountTax()

Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, amountPretax must be set. Calculated automatically if not provided.

Returns:

value or null for none

setAmountTax

public OrdersRefundRequest setAmountTax(Price amountTax)

Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, amountPretax must be set. Calculated automatically if not provided.

Parameters:

amountTax - amountTax or null for none

getOperationId

public String getOperationId()

The ID of the operation. Unique across all operations for a given order.

Returns:

value or null for none

setOperationId

public OrdersRefundRequest setOperationId(String operationId)

The ID of the operation. Unique across all operations for a given order.

Parameters:

operationId - operationId or null for none

getReason

public String getReason()

The reason for the refund. Acceptable values are: - "`adjustment`" - "`courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`deliveredLateByCarrier`" - "`feeAdjustment`" - "`lateShipmentCredit`" - "`noInventory`" - "`other`" - "`priceError`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`shippingCostAdjustment`" - "`taxAdjustment`" - "`undeliverableShippingAddress`" - "`wrongProductShipped`"

Returns:

value or null for none

setReason

public OrdersRefundRequest setReason(String reason)

The reason for the refund. Acceptable values are: - "`adjustment`" - "`courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`deliveredLateByCarrier`" - "`feeAdjustment`" - "`lateShipmentCredit`" - "`noInventory`" - "`other`" - "`priceError`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`shippingCostAdjustment`" - "`taxAdjustment`" - "`undeliverableShippingAddress`" - "`wrongProductShipped`"

Parameters:

reason - reason or null for none

getReasonText

public String getReasonText()

The explanation of the reason.

Returns:

value or null for none

setReasonText

public OrdersRefundRequest setReasonText(String reasonText)

The explanation of the reason.

Parameters:

reasonText - reasonText or null for none

set

public OrdersRefundRequest set(String fieldName,
                               Object value)

Overrides:

set in class GenericJson

clone

public OrdersRefundRequest clone()

Overrides:

clone in class GenericJson