Item Details

August 21, 2026 ยท View on GitHub

The item details.

Structure

ItemDetails

Fields

NameTypeTagsDescriptionGetterSetter
ItemCodeStringOptionalAn item code that identifies a merchant's goods or service.

Constraints: Minimum Length: 1, Maximum Length: 1000, Pattern: ^[a-zA-Z0-9_'\-., ":;\!?]*$
String getItemCode()setItemCode(String itemCode)
ItemNameStringOptionalThe item name.

Constraints: Minimum Length: 1, Maximum Length: 200, Pattern: ^[a-zA-Z0-9_'\-., ":;\!?]*$
String getItemName()setItemName(String itemName)
ItemDescriptionStringOptionalThe item description.

Constraints: Minimum Length: 1, Maximum Length: 2000, Pattern: ^[a-zA-Z0-9_'\-., ":;\!?]*$
String getItemDescription()setItemDescription(String itemDescription)
ItemOptionsStringOptionalThe item options. Describes option choices on the purchase of the item in some detail.

Constraints: Minimum Length: 1, Maximum Length: 4000, Pattern: ^[a-zA-Z0-9_'\-., ":;\!?]*$
String getItemOptions()setItemOptions(String itemOptions)
ItemQuantityStringOptionalThe number of purchased units of goods or a service.

Constraints: Minimum Length: 1, Maximum Length: 4000, Pattern: ^[a-zA-Z0-9_'\-., ":;\!?]*$
String getItemQuantity()setItemQuantity(String itemQuantity)
ItemUnitPriceMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getItemUnitPrice()setItemUnitPrice(Money itemUnitPrice)
ItemAmountMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getItemAmount()setItemAmount(Money itemAmount)
DiscountAmountMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getDiscountAmount()setDiscountAmount(Money discountAmount)
AdjustmentAmountMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getAdjustmentAmount()setAdjustmentAmount(Money adjustmentAmount)
GiftWrapAmountMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getGiftWrapAmount()setGiftWrapAmount(Money giftWrapAmount)
TaxPercentageStringOptionalThe percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.

Constraints: Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
String getTaxPercentage()setTaxPercentage(String taxPercentage)
TaxAmountsList<TaxAmount>OptionalAn array of tax amounts levied by a government on the purchase of goods or services.

Constraints: Minimum Items: 1, Maximum Items: 32767
List getTaxAmounts()setTaxAmounts(List taxAmounts)
BasicShippingAmountMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getBasicShippingAmount()setBasicShippingAmount(Money basicShippingAmount)
ExtraShippingAmountMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getExtraShippingAmount()setExtraShippingAmount(Money extraShippingAmount)
HandlingAmountMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getHandlingAmount()setHandlingAmount(Money handlingAmount)
InsuranceAmountMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getInsuranceAmount()setInsuranceAmount(Money insuranceAmount)
TotalItemAmountMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getTotalItemAmount()setTotalItemAmount(Money totalItemAmount)
InvoiceNumberStringOptionalThe invoice number. An alphanumeric string that identifies a billing for a merchant.

Constraints: Minimum Length: 1, Maximum Length: 200, Pattern: ^[a-zA-Z0-9_'\-., ":;\!?]*$
String getInvoiceNumber()setInvoiceNumber(String invoiceNumber)
CheckoutOptionsList<CheckoutOption>OptionalAn array of checkout options. Each option has a name and value.

Constraints: Minimum Items: 1, Maximum Items: 32767
List getCheckoutOptions()setCheckoutOptions(List checkoutOptions)

Example

import com.paypal.sdk.models.ItemDetails;

ItemDetails itemDetails = new ItemDetails.Builder()
    .itemCode("item_code2")
    .itemName("item_name0")
    .itemDescription("item_description8")
    .itemOptions("item_options4")
    .itemQuantity("item_quantity4")
    .build();