com.paypal.sdk.models

Class ShippingOptionsPurchaseUnit

java.lang.Object

com.paypal.sdk.models.ShippingOptionsPurchaseUnit

public class ShippingOptionsPurchaseUnit
extends Object

This is a model class for ShippingOptionsPurchaseUnit type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShippingOptionsPurchaseUnit.Builder Class to build instances of ShippingOptionsPurchaseUnit.

Constructor Summary

Constructors

Constructor and Description
ShippingOptionsPurchaseUnit() Default constructor.
ShippingOptionsPurchaseUnit(String referenceId, AmountWithBreakdown amount, List<ShippingOption> shippingOptions) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
AmountWithBreakdown	getAmount() Getter for Amount.
String	getReferenceId() Getter for ReferenceId.
List<ShippingOption>	getShippingOptions() Getter for ShippingOptions.
void	setAmount(AmountWithBreakdown amount) Setter for Amount.
void	setReferenceId(String referenceId) Setter for ReferenceId.
void	setShippingOptions(List<ShippingOption> shippingOptions) Setter for ShippingOptions.
ShippingOptionsPurchaseUnit.Builder	toBuilder() Builds a new ShippingOptionsPurchaseUnit.Builder object.
String	toString() Converts this ShippingOptionsPurchaseUnit into string format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ShippingOptionsPurchaseUnit

public ShippingOptionsPurchaseUnit()

Default constructor.

ShippingOptionsPurchaseUnit

public ShippingOptionsPurchaseUnit(String referenceId,
                                   AmountWithBreakdown amount,
                                   List<ShippingOption> shippingOptions)

Initialization constructor.

Parameters:

referenceId - String value for referenceId.

amount - AmountWithBreakdown value for amount.

shippingOptions - List of ShippingOption value for shippingOptions.

Method Detail

getReferenceId

public String getReferenceId()

Getter for ReferenceId. The API caller-provided external ID for the purchase unit. Required for multiple purchase units when you must update the order through `PATCH`. If you omit this value and the order contains only one purchase unit, PayPal sets this value to `default`. Note: If there are multiple purchase units, reference_id is required for each purchase unit.

Returns:

Returns the String

setReferenceId

public void setReferenceId(String referenceId)

Setter for ReferenceId. The API caller-provided external ID for the purchase unit. Required for multiple purchase units when you must update the order through `PATCH`. If you omit this value and the order contains only one purchase unit, PayPal sets this value to `default`. Note: If there are multiple purchase units, reference_id is required for each purchase unit.

Parameters:

referenceId - Value for String

getAmount

public AmountWithBreakdown getAmount()

Getter for Amount. The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any. If you specify `amount.breakdown`, the amount equals `item_total` plus `tax_total` plus `shipping` plus `handling` plus `insurance` minus `shipping_discount` minus discount. The amount must be a positive number. For listed of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.

Returns:

Returns the AmountWithBreakdown

setAmount

public void setAmount(AmountWithBreakdown amount)

Setter for Amount. The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any. If you specify `amount.breakdown`, the amount equals `item_total` plus `tax_total` plus `shipping` plus `handling` plus `insurance` minus `shipping_discount` minus discount. The amount must be a positive number. For listed of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.

Parameters:

amount - Value for AmountWithBreakdown

getShippingOptions

public List<ShippingOption> getShippingOptions()

Getter for ShippingOptions. An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.

Returns:

Returns the List of ShippingOption

setShippingOptions

public void setShippingOptions(List<ShippingOption> shippingOptions)

Setter for ShippingOptions. An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.

Parameters:

shippingOptions - Value for List of ShippingOption

toString

public String toString()

Converts this ShippingOptionsPurchaseUnit into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ShippingOptionsPurchaseUnit.Builder toBuilder()

Builds a new ShippingOptionsPurchaseUnit.Builder object. Creates the instance with the state of the current model.

Returns:

a new ShippingOptionsPurchaseUnit.Builder object